Documentation

Class: PostgresClient

arpen/services/postgres~ PostgresClient

Postgres client

new PostgresClient(service, client, done)

Create Postgres client
Parameters:
Name Type Description
service Postgres Postgres service instance
client object Connected PG client
done function Client termination function
Properties:
Name Type Default Description
client object PG client
maxTransactionRetries number 59 Max number of transaction retries on serialization failures
minTransactionDelay number 100 Minimum time to wait before retrying transaction
maxTransactionDelay number 1000 Maximum time to wait before retrying transaction

Methods

done()

Client termination

<async> query(sql [, params])

Run Postgres query
Date/Moment params are converted to strings in UTC timezone.
Parameters:
Name Type Argument Description
sql string SQL query string
params Array <optional>
 Query parameters
Returns:
Resolves to query result
Type
Promise

<async> transaction( [params], cb)

Run a transaction
Parameters:
Name Type Argument Description
params object <optional>
Properties
Name Type Argument Default Description
name string <optional>
 Transaction name for debugging
isolation string <optional>
 'serializable' Isolation level
cb PostgresTransaction The transaction
Returns:
Resolves to transaction result
Type
Promise