Redirects all query formatting to the pg driver.

By default (false), the library uses its own advanced query-formatting engine. If you set this option to a truthy value, query formatting will be done entirely by the pg driver, which means you won't be able to use any of the feature-rich query formatting that this library implements, restricting yourself to the very basic $1, $2,... syntax.

This option is dynamic (can be set before or after initialization).

Use Native Bindings. Library pg-native must be included and installed independently, or else there will be an error thrown: Error = Failed to initialize Native Bindings.

This is a static option (can only be set prior to initialization).

Overrides the default (ES6 Promise) promise library for its internal use.

Example below sets to use Bluebird - the best and recommended promise library. It is the fastest one, and supports Long Stack Traces, essential for debugging promises.

const Promise = require('bluebird');
const initOptions = {
    promiseLib: Promise
};
const pgp = require('pg-promise')(initOptions);

All existing promise libraries are supported. The ones with recognizable signature are used automatically, while the rest can be configured via the Promise Adapter.

This is a static option (can only be set prior to initialization).

Prevents protocol locking.

By default, the library locks much of its protocol to read-only access, as a fool-proof mechanism. Specifically for the extend event this serves as a protection against overriding existing properties or trying to set them at the wrong time.

If this provision gets in the way of using a mock-up framework for your tests, you can force the library to deactivate most of the locks by setting noLocking = true within the options.

This option is dynamic (can be set before or after initialization). However, changing it after the library's initialization will not affect Database objects that have already been created.

Capitalizes any SQL generated by the library.

By default, all internal SQL within the library is generated using the low case. If, however, you want all SQL to be capitalized instead, set capSQL = true.

It is purely a cosmetic feature.

This option is dynamic (can be set before or after initialization).

Forces change of the default database schema(s) for every fresh connection, i.e. the library will execute SET search_path TO schema_1, schema_2, ... in the background whenever a fresh physical connection is allocated.

Normally, one changes the default schema(s) by changing the database or the role, but sometimes you may want to switch the default schema(s) without persisting the change, and then use this option.

It can be a string, an array of strings, or a callback function that takes dc (database context) as the only parameter (and as this), and returns schema(s) according to the database context. A callback function can also return nothing (undefined or null), if no schema change needed for the specified database context.

The order of schema names matters, so if a table name exists in more than one schema, its default access resolves to the table from the first such schema on the list.

This option is dynamic (can be set before or after initialization).

Disables all diagnostic warnings in the library (it is ill-advised).

This option is dynamic (can be set before or after initialization).

Global event connect handler.

This option is dynamic (can be set before or after initialization).

Global event disconnect handler.

This option is dynamic (can be set before or after initialization).

Global event query handler.

This option is dynamic (can be set before or after initialization).

Global event receive handler.

This option is dynamic (can be set before or after initialization).

Global event task handler.

This option is dynamic (can be set before or after initialization).

Global event transact handler.

This option is dynamic (can be set before or after initialization).

Global event error handler.

This option is dynamic (can be set before or after initialization).

Global event extend handler.

This option is dynamic (can be set before or after initialization).