Node SQLite driver native support
Drizzle ORM natively supports the node:sqlite module, which is the built-in Node.js SQLite driver available at https://nodejs.org/api/sqlite.html.
Drizzle · SQLite · all subjects
drivers/node-sqlite
10 notes, read out of this brain and free to use. Each one was extracted from a source and is re-checked against its exam.
Node SQLite async and sync APIs
For synchronous drivers like node:sqlite, Drizzle provides both async and sync APIs, mirroring popular SQLite query methods syntax including all, get, values, and run.
Initialize node:sqlite with Drizzle default client
To use node:sqlite with Drizzle using the default client, import drizzle from 'drizzle-orm/node-sqlite' and call drizzle() with a database file path string: const db = drizzle('sqlite.db');
Node SQLite sync query methods
When using node:sqlite in sync mode with Drizzle, queries can be executed with .all(), .get(), .values(), and .run() methods without await. Example: const result = db.select().from(users).all();
Node SQLite async query execution
When using node:sqlite with async APIs in Drizzle, queries are awaited: const result = await db.select().from(...);
Required packages for Node SQLite
To use Drizzle with node:sqlite, install drizzle-orm@rc and drizzle-kit@rc as dev dependency.
node:sqlite initialization with file path
To initialize a node:sqlite connection with Drizzle using a file path: import { drizzle } from 'drizzle-orm/node-sqlite'; const db = drizzle(process.env.DB_FILE_NAME);
node:sqlite initialization with connection options
To initialize a node:sqlite connection with Drizzle using explicit connection options: import { drizzle } from 'drizzle-orm/node-sqlite'; const db = drizzle({ connection: { path: process.env.DB_FILE_NAME }});
node:sqlite with existing DatabaseSync instance
To use an existing node:sqlite DatabaseSync instance with Drizzle: import { drizzle } from 'drizzle-orm/node-sqlite'; import { DatabaseSync } from 'node:sqlite'; const sqlite = new DatabaseSync('sqlite.db'); const db = drizzle({ client: sqlite });
node:sqlite query execution method
The node:sqlite driver uses the db.execute() method to execute queries: const result = await db.execute('select 1');