pg-opengauss

This is a fork of node-postgres adapted for openguass, and upgraded to the latest node-postgres based on openGauss-connector-nodejs

Monorepo

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

• pg-opengauss
• pg-opengauss-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:

⭐ Documentation ⭐

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

Setting up for local development

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