Interface PGlite

This interface is the subset of the PGlite instance that kysely needs.

We don't use the type from @electric-sql/pglite here to not have a dependency to it.

https://pglite.dev/docs/api

interface PGlite {
    closed: boolean;
    ready: boolean;
    waitReady: Promise<void>;
    close(): Promise<void>;
    query<T>(
        query: string,
        params?: any[],
        options?: PGliteQueryOptions,
    ): Promise<PGliteQueryResults<T>>;
    transaction<T>(callback: (tx: PGliteTransaction) => Promise<T>): Promise<T>;
}

Index

Properties

closed ready waitReady

Methods

close query transaction

Properties

closed

closed: boolean

ready

ready: boolean

waitReady

waitReady: Promise<void>

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in dialect/pglite/pglite-dialect-config.ts:40

query

query<T>(
    query: string,
    params?: any[],
    options?: PGliteQueryOptions,
): Promise<PGliteQueryResults<T>>
Type Parameters
- T
Parameters
- query: string
- Optionalparams: any[]
- Optionaloptions: PGliteQueryOptions
Returns Promise<PGliteQueryResults<T>>
- Defined in dialect/pglite/pglite-dialect-config.ts:42

transaction

transaction<T>(callback: (tx: PGliteTransaction) => Promise<T>): Promise<T>
Type Parameters
- T
Parameters
- callback: (tx: PGliteTransaction) => Promise<T>
Returns Promise<T>
- Defined in dialect/pglite/pglite-dialect-config.ts:48