ORM and Query Builder Support ​

The following ORMs and Query Builders are known to work properly with PGlite:

Drizzle ​

Drizzle is a TypeScript ORM with support for many databases, including PGlite. Features include:

  • A declarative relational query API
  • An SQL-like query builder API
  • Migrations

To use PGlite with Drizzle, wrap you PGlite instance with a drizzle() call:

sh
npm i drizzle-orm @electric-sql/pglite
npm i -D drizzle-kit
ts
import { PGlite } from '@electric-sql/pglite';
import { drizzle } from 'drizzle-orm/pglite';

const client = new PGlite();
const db = drizzle(client);

await db.select().from(...);

See the Drizzle documentation for more details.

Knex.js ​

Knex is a stable, reliable Query Builder for various database engines. Key features include:

  • Query builder
  • Schema builder
  • Raw queries
  • Database migration tool

To use Knex.js with PGlite, add knex and the third party knex-pglite library to your project:

bash
npm i @electric-sql/pglite knex knex-pglite

Then you can setup a regular Knex instance:

javascript
import { knex } from 'knex'
import ClientPgLite from 'knex-pglite'

export const db = knex({
  client: ClientPgLite,
  dialect: 'postgres',
  connection: { connectionString: 'idb://my-database' },
})

Now you can check Knex documentation and knex-pglite documentation for more details.