PostgreSQL

Installing driver

npm

npm install pg
npm install --save-dev @types/pg

pnpm

pnpm add pg
pnpm add --save-dev @types/pg

bun

bun add pg
bun add --dev @types/pg

yarn

yarn add pg
yarn add --dev @types/pg

Creating ZenStackClient

import { schema } from './zenstack/schema';
import { Pool } from 'pg';
import { ZenStackClient } from '@zenstackhq/orm';
import { PostgresDialect } from '@zenstackhq/orm/dialects/postgres';

const db = new ZenStackClient(schema, {
    dialect: new PostgresDialect({
        pool: new Pool({
            connectionString: process.env.DATABASE_URL,
        }),
    }),
});

Using PGlite

No Official Support

The PGlite dialect is not officially supported or tested by ZenStack, but you may evaluate it and report your findings and interest on the GitHub issue.

npm

npm install @electric-sql/pglite kysely

pnpm

pnpm add @electric-sql/pglite kysely

bun

bun add @electric-sql/pglite kysely

yarn

yarn add @electric-sql/pglite kysely

import { schema } from './zenstack/schema';
import { PGlite } from '@electric-sql/pglite';
import { ZenStackClient } from '@zenstackhq/orm';
import { PGliteDialect } from 'kysely';

const db = new ZenStackClient(schema, {
    dialect: new PGliteDialect({
        pglite: new PGlite(),
    }),
});