pg

pg

PostgreSQL client for node.js.

Showing:

Popularity

Downloads/wk

2.5M

GitHub Stars

9.9K

Maintenance

Last Commit

2mos ago

Contributors

291

Package

Dependencies

7

License

MIT

Type Definitions

Tree-Shakeable

No?

Reviews

Average Rating

4.5/528
Read All Reviews
s-r-aman
rajesh-tirupathi
jatin269
shrpande
CoryKleiser
Phara0h
riginoommen

Top Feedback

13Great Documentation
12Easy to Use
8Performant
8Highly Customizable
3Bleeding Edge

Readme

node-postgres

Build Status NPM version NPM downloads

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.

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 https://github.com/brianc/node-postgres-docs.

Features

  • Pure JavaScript client and native libpq bindings share the same API
  • Connection pooling
  • Extensible JS ↔ PostgreSQL data-type coercion
  • Supported PostgreSQL features
    • Parameterized queries
    • Named statements with query plan caching
    • Async notifications with LISTEN/NOTIFY
    • Bulk import & export with COPY TO/COPY FROM

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.

Support

node-postgres is free software. If you encounter a bug with the library please open an issue on the GitHub repo. If you have questions unanswered by the documentation please open an issue pointing out how the documentation was unclear & I will do my best to make it better!

When you open an issue please provide:

  • version of Node
  • version of Postgres
  • smallest possible snippet of code to reproduce the problem

You can also follow me @briancarlson if that's your thing. I try to always announce noteworthy changes & developments with node-postgres on Twitter.

Sponsorship 💕

node-postgres's continued development has been made possible in part by generous finanical support from the community and these featured sponsors:

If you or your company are benefiting from node-postgres and would like to help keep the project financially sustainable please consider supporting its development.

Contributing

❤️ contributions!

I will happily accept your pull request if it:

  • has tests
  • looks reasonable
  • does not break backwards compatibility

If your change involves breaking backwards compatibility please please point that out in the pull request & we can discuss & plan when and how to release it and what type of documentation or communication it will require.

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)

License

Copyright (c) 2010-2020 Brian Carlson (brian.m.carlson@gmail.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Rate & Review

Great Documentation13
Easy to Use12
Performant8
Highly Customizable8
Bleeding Edge3
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
SR AmanNew Delhi, India88 Ratings93 Reviews
Trying new things.
2 months ago
Great Documentation
Easy to Use

Pg is a very easy and beginner friendly tool. Its basic and its simple. I have used this package in a lot of projects in my early learning days, it was so easy to get started. It has a very good documentation, a decent community support and and Easy API's. So that you dont get confused. One of the things that I like about this library is the error message, they are very good at conveying the error and what went wrong, and how it can be fixed, very few library does this and I think a lot of other libraries should do this also, essentially it acts sort of like a documentation.


1
Yogi-Kmr
rajesh-tirupathiHyderabad, India73 Ratings95 Reviews
6 months ago
Great Documentation
Easy to Use
Bleeding Edge
Highly Customizable
Performant

I'm using this library in my current project to interact with PostgreSQL database. Its very simple to connect to your database with this. It supports for promise objects, async / await calls and all CRUD operations are easy to perform. You can also write prepared states , cursors etc. Now interacting with database made so simple. It has rich documentation and wide community support. It supports both TSL/SSL connections to connect PostgreSQL.


0
jatin26975 Ratings84 Reviews
9 months ago
Highly Customizable
Performant
Great Documentation

ORM we use has few issues related sometimes, of all ORMs I've used I have seen a bit of problem when I work with Postgres, finally, I fund this package this is very minimal and fast. The best thing about this package is that it has very good documentation, and the guides page in documentation is even better, which gives very good examples as to how to get started on this package. Would definitely suggest using this one instead of other ORMs.


0
shrpande45 Ratings39 Reviews
8 days ago
Great Documentation
Easy to Use
Performant

Pg is a great database connector for the node.js app. With the Pg client even simple queries can be executed performantly. However, when it comes to multiple joints and quering from multiple views, I've observed the timeouts from the pg client. To overcome this, we have to manually write the error-handling mechanisms with this module and it is a painful moment.


0
Cory KleiserMonument, CO33 Ratings23 Reviews
Full Stack Software Engineer
September 15, 2020
Great Documentation
Easy to Use
Performant
Highly Customizable
Bleeding Edge

Love this package. Very easy to use. Postgres is the way to go if you're wanting a relational database. I'm not a database guy by any stretch of that definition. But I will say that this package makes it very easy to interact with your postgres db.


0

Tutorials

No tutorials found
Add a tutorial