node-postgres

Non-blocking PostgreSQL client for Node.js. Pure JavaScript and optional native libpq bindings.

Monorepo

This repo is a monorepo which contains the core pg module as well as a handful of related modules.

• pg
• pg-pool
• pg-native
• pg-cursor
• pg-query-stream
• pg-connection-string
• pg-protocol

Documentation

Each package in this repo should have its own readme more focused on how to develop/contribute. For overall documentation on the project and the related modules managed by this repo please see:

:star: Documentation :star:

The source repo for the documentation is available for contribution here.

Extras

node-postgres is by design pretty light on abstractions. These are some handy modules we’ve been using over the years to complete the picture. The entire list can be found on our wiki.

Setting up for local development

1. Clone the repo
2. From your workspace root run yarn and then yarn lerna bootstrap
3. Ensure you have a PostgreSQL instance running with SSL enabled and an empty database for tests
4. Ensure you have the proper environment variables configured for connecting to the instance
5. Run yarn test to run all the tests

Troubleshooting and FAQ

The causes and solutions to common errors can be found among the Frequently Asked Questions (FAQ)