PgHelper | @ckpack/pg-helper

Hierarchy

PgHelper

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PgHelper(pooConfig: PoolConfig, options?: Options): PgHelper

- Defined in index.ts:69
Parameters
- pooConfig: PoolConfig
- Optional options: Options
Returns PgHelper

Properties

Private autoHump

autoHump: boolean

Private logger

logger: Logger

Private pooConfig

pooConfig: PoolConfig

Private pool

pool: Pool

Private returning

returning: boolean

Methods

delete

delete(params: SqlTempParams, options: DeleteOptions): Promise<QueryResult>

- Defined in index.ts:183
build delete sql

Parameters
- params: SqlTempParams
- options: DeleteOptions
Returns Promise<QueryResult>

getClient

getClient(): Promise<any>

- Defined in index.ts:96
get a poolClient

Returns Promise<any>

getTransaction

getTransaction(): Promise<any>

- Defined in index.ts:105
get a transaction poolClient

Returns Promise<any>

Private initPool

initPool(): void

- Defined in index.ts:81
Returns void

insert

insert(params: Insert, options: InsertOptions): Promise<QueryResult>

- Defined in index.ts:170
build insert sql

Parameters
- params: Insert
- options: InsertOptions
Returns Promise<QueryResult>

runSql

runSql(sqlTemp: string, sqlParams?: SqlTempParams, options?: SqlOptions): Promise<QueryResult>

- Defined in index.ts:121
Parameters
- sqlTemp: string
  
  the executed sql template
- Optional sqlParams: SqlTempParams
  
  template parameters, the key of Object needs to correspond to the value of {params} in the SQL template one-to-one
- Optional options: SqlOptions
Returns Promise<QueryResult>

runTSql

runTSql(sqlTemps: TSqlTempParams[], options?: SqlOptions): Promise<QueryResult[]>

- Defined in index.ts:142
will auto commit or rollback

Parameters
- sqlTemps: TSqlTempParams[]
- Optional options: SqlOptions
Returns Promise<QueryResult[]>

select

select(params: SqlTempParams, options: SelectOptions): Promise<QueryResult>

- Defined in index.ts:210
build select sql

Parameters
- params: SqlTempParams
- options: SelectOptions
Returns Promise<QueryResult>

update

update(params: SqlTempParams, options: UpdateOptions): Promise<QueryResult>

- Defined in index.ts:196
build update sql

Parameters
- params: SqlTempParams
- options: UpdateOptions
Returns Promise<QueryResult>

Generated using TypeDoc