-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="preload" as="image" href="/favicon.svg"><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-40B96SPQX2"></script><link rel="dns-prefetch" href="https://www.googletagmanager.com/"><link href="https://www.googletagmanager.com/gtag/js?id=G-40B96SPQX2" rel="preload" as="script"><link rel="preload" as="font" href="/fonts/inter.woff2" type="font/woff2" crossorigin="anonymous"><link rel="preload" as="font" href="/fonts/inconsolata.woff2" type="font/woff2" crossorigin="anonymous"><title>API | TinyJoin</title><meta name="description" content="A tiny, worker-first relational database for browser apps."><meta property="og:type" content="website"><meta property="og:title" content="API | TinyJoin"><meta property="og:description" content="A tiny, worker-first relational database for browser apps."><meta property="og:url" content="https://tinyjoin.org/api/"><link rel="canonical" href="https://tinyjoin.org/api/"><link rel="icon" type="image/svg+xml" href="/favicon.svg"><link rel="stylesheet" href="/css/index.css"><script src="/js/site.js"></script></head><body><a class="skip" href="#content">Skip to content</a><header><a class="wordmark" href="/"><img src="/favicon.svg" alt="TinyJoin logo"><span>Tiny<em>Join</em></span></a><nav aria-label="Primary"><ul><li><a href="/guides/">Guides</a></li><li><a href="/demos/">Demos</a></li><li><a href="/api/" aria-current="page">API</a></li><li><a href="https://github.com/tinyplex/tinyjoin">GitHub</a></li></ul></nav><button id="dark" class="auto" type="button" aria-label="Color theme: automatic; activate for dark"></button></header><main><nav aria-label="Documentation"><ul><li id="root" class="parent open"><span></span><a href="/" aria-current="true">TinyJoin</a><ul><li id="G" class="parent"><span></span><a href="/guides/">Guides</a></li><li id="D" class="parent"><span></span><a href="/demos/">Demos</a></li><li id="api" class="current parent open"><span></span><a href="/api/" aria-current="page">API</a><ul><li id="e" class="parent"><span></span><a href="/api/the-essentials/">The Essentials</a></li><li id="t" class="parent"><span></span><a href="/api/tinyjoin/"><code>tinyjoin</code></a></li><li id="w2" class="parent"><span></span><a href="/api/worker/"><code>worker</code></a></li><li id="v" class="parent"><span></span><a href="/api/vite/"><code>vite</code></a></li></ul></li></ul></li></ul></nav><article id="content" tabindex="-1"><nav class="breadcrumbs" aria-label="Breadcrumbs"><ul><li><a href="/" aria-current="true">TinyJoin</a></li><li><a href="/api/" aria-current="page">API</a></li></ul></nav><section class="s1" id="/api/" data-id="api"><h1>API</h1><section class="s2" id="/api/the-essentials/" data-id="e"><h2>The Essentials</h2><ul><li><a href="/api/the-essentials/using-a-database/create/"><code>create</code></a></li><li><a href="/api/the-essentials/using-a-database/exec/"><code>exec</code></a></li><li><a href="/api/the-essentials/using-a-database/query/"><code>query</code></a></li><li><a href="/api/the-essentials/using-a-database/sql/"><code>sql</code></a></li><li><a href="/api/the-essentials/using-a-database/transaction/"><code>transaction</code></a></li></ul></section><section class="s2" id="/api/tinyjoin/" data-id="t"><h2><code>tinyjoin</code></h2><p>The <code>tinyjoin</code> module provides a small PostgreSQL-shaped relational database that runs in a dedicated browser Worker and stores data in memory or OPFS. <a href="/api/tinyjoin/">Read more</a>.</p><ul><li><a href="/api/tinyjoin/classes/">Classes</a></li><li><a href="/api/tinyjoin/interfaces/">Interfaces</a></li><li><a href="/api/tinyjoin/functions/">Functions</a></li><li><a href="/api/tinyjoin/type-aliases/">Type Aliases</a></li></ul></section><section class="s2" id="/api/worker/" data-id="w2"><h2><code>worker</code></h2><p>The <code>worker</code> module lets advanced applications start TinyJoin inside a Worker that they construct and bundle themselves. <a href="/api/worker/">Read more</a>.</p><ul><li><a href="/api/worker/functions/">Functions</a></li></ul></section><section class="s2" id="/api/vite/" data-id="v"><h2><code>vite</code></h2><p>The <code>vite</code> module provides optional production offline caching for Vite applications, including TinyJoin's lazily loaded Worker, OPFS, and WASM files. This Node-only build integration is separate from the browser runtime. <a href="/api/vite/">Read more</a>.</p><ul><li><a href="/api/vite/interfaces/">Interfaces</a></li><li><a href="/api/vite/functions/">Functions</a></li></ul></section></section></article><aside aria-hidden="true"></aside></main><footer><nav><a id="gh" href="https://github.com/tinyplex/tinyjoin" target="_blank" rel="noreferrer">GitHub</a></nav><nav><a href="/">TinyJoin</a> · MIT licensed</nav></footer><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-40B96SPQX2');</script></body></html>
0 commit comments