PgClient
Defined in: packages/store-postgres/src/client.ts:18
The little this package needs from a PostgreSQL driver. Use fromPg, fromPostgresJs or
fromPglite, or implement it for any other driver. The drivers are not dependencies.
Extends
Section titled “Extends”Methods
Section titled “Methods”execute()
Section titled “execute()”execute(
script):Promise<void>
Defined in: packages/store-postgres/src/client.ts:15
A script of several statements without parameters, such as a migration.
Parameters
Section titled “Parameters”script
Section titled “script”string
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”query()
Section titled “query()”query<
R>(text,params?):Promise<{rowCount:number;rows:R[]; }>
Defined in: packages/store-postgres/src/client.ts:10
One statement with $1, $2, … parameters. rowCount is the number of rows a SELECT returned
or an INSERT, UPDATE or DELETE changed, as node-postgres reports it.
Type Parameters
Section titled “Type Parameters”R = Record<string, unknown>
Parameters
Section titled “Parameters”string
params?
Section titled “params?”readonly unknown[]
Returns
Section titled “Returns”Promise<{ rowCount: number; rows: R[]; }>
Inherited from
Section titled “Inherited from”transaction()
Section titled “transaction()”transaction<
T>(fn):Promise<T>
Defined in: packages/store-postgres/src/client.ts:20
Runs fn on one connection between BEGIN and COMMIT; ROLLBACK when it throws.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”(tx) => Promise<T>
Returns
Section titled “Returns”Promise<T>