Interface PGConnection
interface PGConnection {
cancelQuery(): Promise<void>;
close(): Promise<void>;
getBackendProcessId(): number | undefined;
getRefObject(): { ref(): void; unref(): void };
passthroughQuery(
queryPackets:
| Buffer<ArrayBufferLike>
| AsyncIterable<Buffer<ArrayBufferLike>, any, any>,
callback: PGPassthroughQueryCallback,
): void;
query(
sql: string,
params?: unknown[],
options?: PGQueryOptions,
): Promise<PGQueryResult<any>>;
}
cancelQuery(): Promise<void>;
close(): Promise<void>;
getBackendProcessId(): number | undefined;
getRefObject(): { ref(): void; unref(): void };
passthroughQuery(
queryPackets:
| Buffer<ArrayBufferLike>
| AsyncIterable<Buffer<ArrayBufferLike>, any, any>,
callback: PGPassthroughQueryCallback,
): void;
query(
sql: string,
params?: unknown[],
options?: PGQueryOptions,
): Promise<PGQueryResult<any>>;
}
Index
Methods
cancel Query
Returns Promise<void>
close
Returns Promise<void>
get Backend Process Id
Returns number | undefined
get Ref Object
Returns { ref(): void; unref(): void }
passthrough Query
- passthroughQuery(
queryPackets:
| Buffer<ArrayBufferLike>
| AsyncIterable<Buffer<ArrayBufferLike>, any, any>,
callback: PGPassthroughQueryCallback,
): voidParameters
- queryPackets: Buffer<ArrayBufferLike> | AsyncIterable<Buffer<ArrayBufferLike>, any, any>
- callback: PGPassthroughQueryCallback
Returns void
query
Parameters
- sql: string
Optionalparams: unknown[]Optionaloptions: PGQueryOptions
Returns Promise<PGQueryResult<any>>