DbClientPg

DbClientPg is a thin wrapper above the native PostgreSQL client designed for using in doix Jobs.

Instances are created by DbPoolPg objects, part of Application. Application developers should never instantiate those objects directly.

Properties

Name	Description
uuid	The unique ID of this client, mainly for logging purposes
raw	The pg.Client instance used by this wrapper
model	a DbModel representing the database structure

Events

Name	Payload	Description
start	{sql, params}	emitted before executing any database query.
error	the error caught	emitted when an error occurs while executing a query
finish		emitted right after the query execution is terminated (one way or another)

Static functions

DbClientPg.normalizeSQL (sql)

Returns the sql string with all comments stripped off and ?s replaced with $1, $2 and so on.

? occurring right after ::jsonb are not replaced (to let use JSONB operators).

Methods

Name	Description
do	Execute an arbitrary statement
getScalar	Select a single field value
getObject	Select a single record as an Object
getArray	Select a limited sequence of records as an Array
getStream	Select an unlimited sequence of records as a Readable stream