kysely-pglite-dialect

Lightweight Kysely dialect for PGlite with zero dependencies.

Note, since PGlite is single user and only supports a single connection this library serializes multiple connections, i.e. acquiring a new connection will block till a previous connection is released. While this avoids multiple transactions from concurrently using (and messing up) the single PGlite connection, it can also lead to deadlocks that wouldn't occur on a normal Postgres instance. However, for the most common use-cases PGlite just works fine.

Setup

npm i kysely-pglite-dialect kysely @electric-sql/pglite

Usage

Init Kysely like:

import { Kysely } from "kysely"
import { PGlite } from "@electric-sql/pglite"
import { PGliteDialect } from "kysely-pglite-dialect"

const db = new Kysely<{
  pglite_test_table: { id: Generated<number>; data: string }
}>({
  dialect: new PGliteDialect(new PGlite()),
})

Changelog

• 1.3.1

  • Support PGlite 0.4
  • Call PGlite.close() when destroying the Kysely driver
  • Switch to pnpm
  • Add changelog

• 1.2.0

  • Implement *streamQuery

• 1.1.2

  • Support PGlite 0.3

• 1.1.1

  • Replace QueryResult.numUpdatedOrDeletedRows with `QueryResult.numAffectedRows

• 1.0.5

  • Support initialization with a PGliteWorker

• 1.0.0

  • Initial version

Development

This project used pnpm so init the project with

pnpm i

Credits

Thanks to kysely-neon which was used as a template for this repo.