typeorm-pglite

PGlite support for TypeORM.

Installation

PGlite is a peerDependency of typeorm-pglite so ensure you have it installed in your project.

npm install @electric-sql/pglite
npm install typeorm-pglite

Usage

typeorm-pglite works with TypeORM's existing postgres dialect. Just provide the PGliteDriver to the driver datasource options and it works!

import { PGliteDriver, getPGliteInstance } from "typeorm-pglite";
import { DataSource } from "typeorm";

const PGliteDataSource = new DataSource({
  type: "postgres",
  driver: new PGliteDriver().driver,
});

// You can access the internal PGlite instance using getPGliteInstance function
const pgliteDb = await getPGliteInstance();

Example

import { PGliteDriver } from "typeorm-pglite";
import { Column, DataSource, Entity, PrimaryGeneratedColumn } from "typeorm";

@Entity()
export class Photo {
  @PrimaryGeneratedColumn()
  id: number;

  @Column({
    length: 100,
  })
  name: string;
}

const AppDataSource = new DataSource({
  type: "postgres",
  driver: new PGliteDriver().driver, // provide PGlite options in PGliteDriver constructor
  synchronize: true,
  logging: true,
  entities: [Photo],
  // remaining typeorm datasource options
});

async function run() {
  try {
    const db = await AppDataSource.initialize();

    const photo = new Photo();
    photo.name = "Example Photo";
    await db.manager.save(photo);

    const allPhotos = await db.manager.find(Photo);
    console.log({ allPhotos });
  } catch (error) {
    console.error("Error:", error);
  }
}

run();

Boolean parameters and serialization

To make the driver behave like PostgreSQL and avoid the error, a default boolean serializer is applied automatically when the driver is constructed. It converts any JS boolean (or common equivalents such as 1/0 or "true"/"false") into the SQL literals TRUE/FALSE.

Override the serializer: If you need the legacy 't'/'f' behaviour or want to have custom serializer, you can pass a custom serializers map to PGliteDriver – the default is merged with your options.

import { PGliteDriver } from "typeorm-pglite";
import { types } from "@electric-sql/pglite";

const driver = new PGliteDriver({
  serializers: {
    [types.BOOL]: (val) => {
      if (val === true) return "t";
      if (val === false) return "f";
      return val;
    },
    // 
    [types.NUMERIC]: (value) => value.toString(),
  },
}).driver;