Class PostgresDriver

Core interface for database drivers. All dialects must implement this.

Implements

DbDriver

Index

Constructors

Methods

beginTransaction commitTransaction connect disconnect prepare query rollbackTransaction stream

Constructors

constructor

new PostgresDriver(config: PostgresConfig): PostgresDriver
Parameters
- config: PostgresConfig
Returns PostgresDriver
- Defined in ts-core/src/database/postgres/postgres-driver.ts:9

Methods

beginTransaction

beginTransaction(): Promise<void>
Returns Promise<void>
Implementation of DbDriver.beginTransaction
- Defined in ts-core/src/database/postgres/postgres-driver.ts:82

commitTransaction

commitTransaction(): Promise<void>
Returns Promise<void>
Implementation of DbDriver.commitTransaction
- Defined in ts-core/src/database/postgres/postgres-driver.ts:85

connect

connect(): Promise<void>
Returns Promise<void>
Implementation of DbDriver.connect
- Defined in ts-core/src/database/postgres/postgres-driver.ts:11

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Implementation of DbDriver.disconnect
- Defined in ts-core/src/database/postgres/postgres-driver.ts:23

prepare

prepare(sql: string): Promise<DatabaseResult<PreparedDriverStatement>>
Parameters
- sql: string
Returns Promise<DatabaseResult<PreparedDriverStatement>>
Implementation of DbDriver.prepare
- Defined in ts-core/src/database/postgres/postgres-driver.ts:51

query

query<T = any>(
sql: string,
params?: QueryParams,
): Promise<DatabaseResult<QueryResponse<T>>>
Type Parameters
- T = any
Parameters
- sql: string
- Optionalparams: QueryParams
Returns Promise<DatabaseResult<QueryResponse<T>>>
Implementation of DbDriver.query
- Defined in ts-core/src/database/postgres/postgres-driver.ts:30

rollbackTransaction

rollbackTransaction(): Promise<void>
Returns Promise<void>
Implementation of DbDriver.rollbackTransaction
- Defined in ts-core/src/database/postgres/postgres-driver.ts:88

stream

stream<T>(
    sql: string,
    params: QueryParams,
    onRow: (row: T) => void,
): Promise<DatabaseResult<void>>
Type Parameters
- T
Parameters
- sql: string
- params: QueryParams
- onRow: (row: T) => void
Returns Promise<DatabaseResult<void>>
Implementation of DbDriver.stream
- Defined in ts-core/src/database/postgres/postgres-driver.ts:92