Installing
$ npm install pg-promiseInitialization
Loading and initializing the library with Initialization Options:
const initOptions = {/* initialization options */};
const pgp = require('pg-promise')(initOptions);− or without Initialization Options:
const pgp = require('pg-promise')();Database
Create your Database object from the connection details:
const db = pgp(connection);The connection parameter is either a Configuration Object or a Connection String.
Object db represents the Database protocol with lazy connection, i.e. only the actual query methods acquire
and release the connection automatically. Therefore you should create only one global/shared db object per connection details.
It is best to initialize the library and create Database in its own module, see Where should I initialize pg-promise.
Usage
Learn by Example is the best quick-start tutorial. For everything else see the WiKi pages.
References
External Resources
- The library's Main Page
- TypeScript 2.x declarations for the library
- The library's WiKi Pages
- Popular questions on StackOverflow
Main Types
- Database - database-level methods and properties
- Task - extends Database with task-level methods and properties
Special Types
- QueryFile - type for working with external SQL files
- PreparedStatement - type for working with Prepared Statements
- ParameterizedQuery - type for working with Parameterized Queries
- TransactionMode - transaction configuration type
- PromiseAdapter - adapter for using non-standard promise libraries
Namespaces
- formatting - the library's query formatting engine
- helpers - for automatic query generation
- utils - simplifies the use of external SQL files
- errors - custom error types supported by the library
- txMode - types for configuring a transaction