Interface PGliteDialectConfig

Config for the PGlite dialect.

interface PGliteDialectConfig {
    onCreateConnection?: (
        connection: DatabaseConnection,
        options?: AbortableOperationOptions,
    ) => Promise<void>;
    pglite:
        | PGlite
        | ((options?: AbortableOperationOptions) => PGlite | Promise<PGlite>);
}

Properties

onCreateConnection?: (
connection: DatabaseConnection,
options?: AbortableOperationOptions,
) => Promise<void>

Called once when the first query is executed.

This is a Kysely specific feature and does not come from the @electric-sql/pglite module.

pglite:
| PGlite
| ((options?: AbortableOperationOptions) => PGlite | Promise<PGlite>)

A PGlite instance or a function that returns one.

If a function is provided, it's called once when the first query is executed.