Merge branch 'master' into release

billwashere · web-flow · commit 19210ee949d5 · 2018-06-10T19:47:24.000+10:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,20 @@
+## 3.0.0
+
+Thanks to @billwashere, we upgraded to a more modern version of `pg` (4.5.1 ->
+7.4.1), which means that the way the database information is provided has
+changed. Previously, you could pass a URL to sharedb-postgres, like:
+
+```js
+const db = require('sharedb-postgres')('postgres://localhost/mydb');
+```
+
+This is no longer supported, and you must instead pass a config object:
+
+```js
+const db = require('sharedb-postgres')({host: 'localhost', database: 'mydb'});
+```
+
+See the [node-postgres](https://node-postgres.com/features/connecting)
+documentation for more details about what can be passed in the config object.
+Additionally, if no object is provided, `pg` will use the same environment
+variables as `libpq` (`PGUSER`, `PGHOST` and so on).
diff --git a/README.md b/README.md
@@ -51,16 +51,15 @@ PGUSER=dbuser  PGPASSWORD=secretpassword PGHOST=database.server.com PGDATABASE=m
 Example using an object
 
 ```js
-var db = require('sharedb-postgres')({
-  user: 'dbuser',
-  host: 'database.server.com',
-  database: 'mydb',
-  password: 'secretpassword',
-  port: 5433,
-});
+var db = require('sharedb-postgres')({host: 'localhost', database: 'mydb'});
 var backend = require('sharedb')({db: db})
 ```
 
 ## Error codes
 
 PostgreSQL errors are passed back directly.
+
+## Changelog
+
+Note that version 3.0.0 introduces breaking changes in how you specify
+connection parameters. See the [changelog](CHANGELOG.md) for more info.
diff --git a/index.js b/index.js
@@ -9,17 +9,15 @@ function PostgresDB(options) {
 
   this.closed = false;
 
-  this.pg_config = options;
-  this.pool = new pg.Pool(this.pg_config)
-
+  this.pool = new pg.Pool(options);
 };
 module.exports = PostgresDB;
 
 PostgresDB.prototype = Object.create(DB.prototype);
 
 PostgresDB.prototype.close = function(callback) {
   this.closed = true;
-  this.pool.end()
+  this.pool.end();
   
   if (callback) callback();
 };
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sharedb-postgres",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "PostgreSQL adapter for ShareDB",
   "main": "index.js",
   "scripts": {
@@ -14,4 +14,4 @@
     "pg": "^7.4.1",
     "sharedb": "^1.0.0-beta.7"
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "sharedb-postgres",`
`3`		`- "version": "2.0.0",`
	`3`	`+ "version": "3.0.0",`
`4`	`4`	`"description": "PostgreSQL adapter for ShareDB",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"scripts": {`
`@@ -14,4 +14,4 @@`
`14`	`14`	`"pg": "^7.4.1",`
`15`	`15`	`"sharedb": "^1.0.0-beta.7"`
`16`	`16`	`}`
`17`		`-}`
	`17`	`+}`