mirror of https://github.com/brianc/node-postgres.git synced 2025-12-08 20:16:25 +00:00

History

Sehrope Sarkuni b4bfd63f63

CI clean up to fix lint task and remove Windows / MacOS from matrix (#3122 )

* Remove unused travis CI config

* Bump eslint and friends

* Fix lint errors after eslint upgrade

* Remove windows and macos from CI workflow as they are actually running linux

Removes the windows and macos matrix from the CI workflow as they were never actually setting
the OS. Both were running against the "ubuntu-latest" OS. Trying to actually use them would
not work either as neither windows or macos is supported for service containers. A different
means will be needed to test on those platforms. Until that's done, this removes those from
the matrix as we were simply running the same thing 3x for the same node versions.

2024-03-05 14:08:44 -06:00

test

pg-connection-string: avoid clobbering port from queryparams (#2833 )

2023-07-21 11:57:02 -05:00

.coveralls.yml

Add 'packages/pg-connection-string/' from commit '5233b3e77e396a368130709e762fca836290a528'

2020-04-28 09:50:40 -05:00

.gitignore

Add 'packages/pg-connection-string/' from commit '5233b3e77e396a368130709e762fca836290a528'

2020-04-28 09:50:40 -05:00

index.d.ts

Support options connection parameter

2020-05-14 10:07:35 -04:00

index.js

fix: conflict between browser URL object and Node URL object (#3061 )

2023-09-15 16:22:18 -05:00

LICENSE

Add 'packages/pg-connection-string/' from commit '5233b3e77e396a368130709e762fca836290a528'

2020-04-28 09:50:40 -05:00

package.json

Publish

2023-07-31 22:36:33 -05:00

README.md

Document sslmode connection string parameter (#2421 )

2020-12-03 09:44:28 -06:00

README.md

pg-connection-string

Functions for dealing with a PostgresSQL connection string

Usage

var parse = require('pg-connection-string').parse;

var config = parse('postgres://someuser:somepassword@somehost:381/somedatabase')

The resulting config contains a subset of the following properties:

host - Postgres server hostname or, for UNIX domain sockets, the socket filename
port - port on which to connect
user - User with which to authenticate to the server
password - Corresponding password
database - Database name within the server
client_encoding - string encoding the client will use
ssl, either a boolean or an object with properties
- rejectUnauthorized
- cert
- key
- ca
any other query parameters (for example, application_name) are preserved intact.

Connection Strings

The short summary of acceptable URLs is:

socket:<path>?<query> - UNIX domain socket
postgres://<user>:<password>@<host>:<port>/<database>?<query> - TCP connection

But see below for more details.

UNIX Domain Sockets

When user and password are not given, the socket path follows socket:, as in socket:/var/run/pgsql. This form can be shortened to just a path: /var/run/pgsql.

When user and password are given, they are included in the typical URL positions, with an empty host, as in socket://user:pass@/var/run/pgsql.

Query parameters follow a ? character, including the following special query parameters:

db=<database> - sets the database name (urlencoded)
encoding=<encoding> - sets the client_encoding property

TCP Connections

TCP connections to the Postgres server are indicated with pg: or postgres: schemes (in fact, any scheme but socket: is accepted). If username and password are included, they should be urlencoded. The database name, however, should not be urlencoded.

Query parameters follow a ? character, including the following special query parameters:

host=<host> - sets host property, overriding the URL's host
encoding=<encoding> - sets the client_encoding property
ssl=1, ssl=true, ssl=0, ssl=false - sets ssl to true or false, accordingly
sslmode=<sslmode>
- sslmode=disable - sets ssl to false
- sslmode=no-verify - sets ssl to { rejectUnauthorized: false }
- sslmode=prefer, sslmode=require, sslmode=verify-ca, sslmode=verify-full - sets ssl to true
sslcert=<filename> - reads data from the given file and includes the result as ssl.cert
sslkey=<filename> - reads data from the given file and includes the result as ssl.key
sslrootcert=<filename> - reads data from the given file and includes the result as ssl.ca

A bare relative URL, such as salesdata, will indicate a database name while leaving other properties empty.