SQLite

Node.js

Installing driver

npm

npm install better-sqlite3
npm install --save-dev @types/better-sqlite3

pnpm

pnpm add better-sqlite3
pnpm add --save-dev @types/better-sqlite3

bun

bun add better-sqlite3
bun add --dev @types/better-sqlite3

yarn

yarn add better-sqlite3
yarn add --dev @types/better-sqlite3

Creating ZenStackClient

import { schema } from './zenstack/schema';
import SQLite from 'better-sqlite3';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from '@zenstackhq/orm/dialects/sqlite';

const db = new ZenStackClient(schema, {
    dialect: new SqliteDialect({ database: new SQLite('./dev.db') }),
});

Bun

Installing driver

Bun is not compatible with better-sqlite3. You can use its builtin bun:sqlite module with the kysely-bun-sqlite Kysely community dialect.

npm

npm install kysely-bun-sqlite

pnpm

pnpm add kysely-bun-sqlite

bun

bun add kysely-bun-sqlite

yarn

yarn add kysely-bun-sqlite

Creating ZenStackClient

import { schema } from './zenstack/schema';
import { Database } from 'bun:sqlite';
import { ZenStackClient } from '@zenstackhq/orm';
import { BunSqliteDialect } from 'kysely-bun-sqlite';

const db = new ZenStackClient(schema, {
    dialect: new BunSqliteDialect({ database: new Database('./dev.db') }),
});