Back to Drizzle Orm

Drizzle Node SQLite

src/content/docs/connect-node-sqlite.mdx

latest1.9 KB
Original Source

import Npm from "@mdx/Npm.astro"; import Callout from '@mdx/Callout.astro'; import AnchorCards from '@mdx/AnchorCards.astro'; import Steps from '@mdx/Steps.astro'; import WhatsNextPostgres from "@mdx/WhatsNextPostgres.astro"; import Prerequisites from "@mdx/Prerequisites.astro"; import CodeTabs from "@mdx/CodeTabs.astro";

Drizzle <> Node SQLite

<Prerequisites> - Database [connection basics](/docs/connect-overview) with Drizzle - Node - [website](https://nodejs.org/) - Node SQLite driver - [docs](https://nodejs.org/api/sqlite.html) </Prerequisites>

Drizzle ORM natively supports node:sqlite module

We embrace SQL dialects and dialect specific drivers and syntax and unlike any other ORM, for synchronous drivers like node:sqlite we have both async and sync APIs and we mirror most popular SQLite-like all, get, values and run query methods syntax.

Step 1 - Install packages

<Npm> drizzle-orm -D drizzle-kit </Npm>

Step 2 - Initialize the driver and make a query

typescript
import { drizzle } from 'drizzle-orm/node-sqlite';

const db = drizzle("sqlite.db");

const result = await db.select().from(...);

If you need to provide your existing driver:

typescript
import { drizzle } from 'drizzle-orm/node-sqlite';
import { DatabaseSync } from 'node:sqlite';

const sqlite = new DatabaseSync('sqlite.db');
const db = drizzle({ client: sqlite });

const result = await db.select().from(...);

If you want to use sync APIs:

typescript
import { drizzle } from 'drizzle-orm/node-sqlite';
import { DatabaseSync } from 'node:sqlite';

const sqlite = new Database('sqlite.db');
const db = drizzle({ client: sqlite });

const result = db.select().from(users).all();
const result = db.select().from(users).get();
const result = db.select().from(users).values();
const result = db.select().from(users).run();

What's next?

<WhatsNextPostgres/>