pg - npm Package Compare versions
Comparing version 7.0.0 to 7.0.1
| { | ||
| "name": "pg", | ||
| "version": "7.0.0", | ||
| "version": "7.0.1", | ||
| "description": "PostgreSQL client - pure javascript & libpq with the same API", | ||
@@ -46,4 +46,4 @@ "keywords": [ | ||
| "engines": { | ||
| "node": ">= 4.0.0" | ||
| "node": ">= 4.5.0" | ||
| } | ||
| } |
228
README.md
@@ -16,190 +16,8 @@ # node-postgres | ||
| ## Intro & Examples | ||
| --- | ||
| ## :star: [Documentation](https://node-postgres.com) :star: | ||
| There are 3 ways of executing queries | ||
| 1. Passing the query to a pool | ||
| 2. Borrowing a client from a pool and executing the query with it | ||
| 3. Obtaining an exclusive client and executing the query with it | ||
| ### Features | ||
| It is recommended to pass the query to a pool as often as possible. If that isn't possible, because of long and complex transactions for example, borrow a client from a pool. Just remember to initialize the pool only once in your code so you maximize reusability of connections. | ||
| ### Why pooling? | ||
| If you're working on something like a web application which makes frequent queries you'll want to access the PostgreSQL server through a pool of clients. Why? For one thing, there is ~20-30 millisecond delay (YMMV) when connecting a new client to the PostgreSQL server because of the startup handshake. Furthermore, PostgreSQL can support only a limited number of clients...it depends on the amount of ram on your database server, but generally more than 100 clients at a time is a __very bad thing__. :tm: Additionally, PostgreSQL can only execute 1 query at a time per connected client, so pipelining all queries for all requests through a single, long-lived client will likely introduce a bottleneck into your application if you need high concurrency. | ||
| With that in mind we can imagine a situation where you have a web server which connects and disconnects a new client for every web request or every query (don't do this!). If you get only 1 request at a time everything will seem to work fine, though it will be a touch slower due to the connection overhead. Once you get >100 simultaneous requests your web server will attempt to open 100 connections to the PostgreSQL backend and :boom: you'll run out of memory on the PostgreSQL server, your database will become unresponsive, your app will seem to hang, and everything will break. Boooo! | ||
| __Good news__: node-postgres ships with built in client pooling. Client pooling allows your application to use a pool of already connected clients and reuse them for each request to your application. If your app needs to make more queries than there are available clients in the pool the queries will queue instead of overwhelming your database & causing a cascading failure. :thumbsup: | ||
| node-postgres uses [pg-pool](https://github.com/brianc/node-pg-pool.git) to manage pooling. It bundles it and exports it for convenience. If you want, you can `require('pg-pool')` and use it directly - it's the same as the constructor exported at `pg.Pool`. | ||
| It's __highly recommended__ you read the documentation for [pg-pool](https://github.com/brianc/node-pg-pool.git). | ||
| [Here is an up & running quickly example](https://github.com/brianc/node-postgres/wiki/Example) | ||
| For more information about `config.ssl` check [TLS (SSL) of nodejs](https://nodejs.org/dist/latest-v4.x/docs/api/tls.html) | ||
| ### Pooling example | ||
| Let's create a pool in `./lib/db.js` which will be reused across the whole project | ||
| ```javascript | ||
| const pg = require('pg'); | ||
| // create a config to configure both pooling behavior | ||
| // and client options | ||
| // note: all config is optional and the environment variables | ||
| // will be read if the config is not present | ||
| var config = { | ||
| user: 'foo', //env var: PGUSER | ||
| database: 'my_db', //env var: PGDATABASE | ||
| password: 'secret', //env var: PGPASSWORD | ||
| host: 'localhost', // Server hosting the postgres database | ||
| port: 5432, //env var: PGPORT | ||
| max: 10, // max number of clients in the pool | ||
| idleTimeoutMillis: 30000, // how long a client is allowed to remain idle before being closed | ||
| }; | ||
| //this initializes a connection pool | ||
| //it will keep idle connections open for 30 seconds | ||
| //and set a limit of maximum 10 idle clients | ||
| const pool = new pg.Pool(config); | ||
| pool.on('error', function (err, client) { | ||
| // if an error is encountered by a client while it sits idle in the pool | ||
| // the pool itself will emit an error event with both the error and | ||
| // the client which emitted the original error | ||
| // this is a rare occurrence but can happen if there is a network partition | ||
| // between your application and the database, the database restarts, etc. | ||
| // and so you might want to handle it and at least log it out | ||
| console.error('idle client error', err.message, err.stack); | ||
| }); | ||
| //export the query method for passing queries to the pool | ||
| module.exports.query = function (text, values, callback) { | ||
| console.log('query:', text, values); | ||
| return pool.query(text, values, callback); | ||
| }; | ||
| // the pool also supports checking out a client for | ||
| // multiple operations, such as a transaction | ||
| module.exports.connect = function (callback) { | ||
| return pool.connect(callback); | ||
| }; | ||
| ``` | ||
| Now if in `./foo.js` you want to pass a query to the pool | ||
| ```js | ||
| const pool = require('./lib/db'); | ||
| //to run a query we just pass it to the pool | ||
| //after we're done nothing has to be taken care of | ||
| //we don't have to return any client to the pool or close a connection | ||
| pool.query('SELECT $1::int AS number', ['2'], function(err, res) { | ||
| if(err) { | ||
| return console.error('error running query', err); | ||
| } | ||
| console.log('number:', res.rows[0].number); | ||
| }); | ||
| ``` | ||
| Or if in `./bar.js` you want borrow a client from the pool | ||
| ```js | ||
| const pool = require('./lib/db'); | ||
| //ask for a client from the pool | ||
| pool.connect(function(err, client, done) { | ||
| if(err) { | ||
| return console.error('error fetching client from pool', err); | ||
| } | ||
| //use the client for executing the query | ||
| client.query('SELECT $1::int AS number', ['1'], function(err, result) { | ||
| //call `done(err)` to release the client back to the pool (or destroy it if there is an error) | ||
| done(err); | ||
| if(err) { | ||
| return console.error('error running query', err); | ||
| } | ||
| console.log(result.rows[0].number); | ||
| //output: 1 | ||
| }); | ||
| }); | ||
| ``` | ||
| For more examples, including how to use a connection pool with promises and async/await see the [example](https://github.com/brianc/node-postgres/wiki/Example) page in the wiki. | ||
| ### Obtaining an exclusive client, example | ||
| ```js | ||
| var pg = require('pg'); | ||
| // instantiate a new client | ||
| // the client will read connection information from | ||
| // the same environment variables used by postgres cli tools | ||
| var client = new pg.Client(); | ||
| // connect to our database | ||
| client.connect(function (err) { | ||
| if (err) throw err; | ||
| // execute a query on our database | ||
| client.query('SELECT $1::text as name', ['brianc'], function (err, result) { | ||
| if (err) throw err; | ||
| // just print the result to the console | ||
| console.log(result.rows[0]); // outputs: { name: 'brianc' } | ||
| // disconnect the client | ||
| client.end(function (err) { | ||
| if (err) throw err; | ||
| }); | ||
| }); | ||
| }); | ||
| ``` | ||
| ## [More Documentation](https://github.com/brianc/node-postgres/wiki) | ||
| ## Native Bindings | ||
| To install the [native bindings](https://github.com/brianc/node-pg-native.git): | ||
| ```sh | ||
| $ npm install pg pg-native | ||
| ``` | ||
| node-postgres contains a pure JavaScript protocol implementation which is quite fast, but you can optionally use [native](https://github.com/brianc/node-pg-native) [bindings](https://github.com/brianc/node-libpq) for a 20-30% increase in parsing speed (YMMV). Both versions are adequate for production workloads. I personally use the pure JavaScript implementation because I like knowing what's going on all the way down to the binary on the socket, and it allows for some fancier [use](https://github.com/brianc/node-pg-cursor) [cases](https://github.com/brianc/node-pg-query-stream) which are difficult to do with libpq. :smile: | ||
| To use the native bindings, first install [pg-native](https://github.com/brianc/node-pg-native.git). Once pg-native is installed, simply replace `var pg = require('pg')` with `var pg = require('pg').native`. Make sure any exported constructors from `pg` are from the native instance. Example: | ||
| ```js | ||
| var pg = require('pg').native | ||
| var Pool = require('pg').Pool // bad! this is not bound to the native client | ||
| var Client = require('pg').Client // bad! this is the pure JavaScript client | ||
| var pg = require('pg').native | ||
| var Pool = pg.Pool // good! a pool bound to the native client | ||
| var Client = pg.Client // good! this client uses libpq bindings | ||
| ``` | ||
| #### API differences | ||
| node-postgres abstracts over the pg-native module to provide the same interface as the pure JavaScript version. Care has been taken to keep the number of api differences between the two modules to a minimum. | ||
| However, currently some differences remain, especially : | ||
| * the error object in pg-native is different : notably, the information about the postgres error code is not present in field `code` but in the field `sqlState` , and the name of a few other fields is different (see https://github.com/brianc/node-postgres/issues/938, https://github.com/brianc/node-postgres/issues/972). | ||
| So for example, if you rely on error.code in your application, your will have to adapt your code to work with native bindings. | ||
| * the notification object has a few less properties (see https://github.com/brianc/node-postgres/issues/1045) | ||
| * column objects have less properties (see https://github.com/brianc/node-postgres/issues/988) | ||
| * the modules https://github.com/brianc/node-pg-copy-streams and https://github.com/brianc/node-pg-query-stream do not work with native bindings (you will have to require 'pg' to use them). | ||
| Thus, it is recommended you use either the pure JavaScript or native bindings in both development and production and don't mix & match them in the same process - it can get confusing! | ||
| ## Features | ||
| * pure JavaScript client and native libpq bindings share _the same api_ | ||
@@ -214,3 +32,3 @@ * connection pooling | ||
| ## Extras | ||
| ### Extras | ||
@@ -220,2 +38,17 @@ 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. | ||
| ## Support | ||
| node-postgres is free software. If you encounter a bug with the library please open an issue on the [github repo](https://github.com/brianc/node-postgres). 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](https://twitter.com/briancarlson) if that's your thing. I try to always announce noteworthy changes & developments with node-postgres on twitter. | ||
| ### Professional Support | ||
| I offer professional support for node-postgres. I provide implementation, training, and many years of expertise on how to build applications with node, express, PostgreSQL, and react/redux. Please contact me at [brian.m.carlson@gmail.com](mailto:brian.m.carlson@gmail.com) to discuss how I can help your company be more successful! | ||
| ## Contributing | ||
@@ -225,4 +58,2 @@ | ||
| If you need help getting the tests running locally or have any questions about the code when working on a patch please feel free to email me or gchat me. | ||
| I will __happily__ accept your pull request if it: | ||
@@ -233,6 +64,2 @@ - __has tests__ | ||
| Information about the testing processes is in the [wiki](https://github.com/brianc/node-postgres/wiki/Testing). | ||
| Open source belongs to all of us, and we're all invited to participate! | ||
| ## Troubleshooting and FAQ | ||
@@ -242,19 +69,2 @@ | ||
| ## Support | ||
| If at all possible when you open an issue please provide | ||
| - version of node | ||
| - version of postgres | ||
| - smallest possible snippet of code to reproduce the problem | ||
| Usually I'll pop the code into the repo as a test. Hopefully the test fails. Then I make the test pass. Then everyone's happy! | ||
| If you need help or run into _any_ issues getting node-postgres to work on your system please report a bug or contact me directly. I am usually available via google-talk at my github account public email address. Remember this is a labor of love, and though I try to get back to everything sometimes life takes priority, and I might take a while. It helps if you use nice code formatting in your issue, search for existing answers before posting, and come back and close out the issue if you figure out a solution. The easier you can make it for me, the quicker I'll try and respond to you! | ||
| If you need deeper support, have application specific questions, would like to sponsor development, or want consulting around node & postgres please send me an email, I'm always happy to discuss! | ||
| I usually tweet about any important status updates or changes to node-postgres on twitter. | ||
| Follow me [@briancarlson](https://twitter.com/briancarlson) to keep up to date. | ||
| ## License | ||
@@ -261,0 +71,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Number of medium supply chain risk alerts
- decreased by-20%
4
Worsened metrics
- Total package byte prevSize
- decreased by-10.71%
82886
- Number of lines in readme file
- decreased by-69.09%
85
No dependency changes