The pg-connection-string package is a utility for parsing PostgreSQL connection strings. It can parse a connection string into an object with configuration details, which can then be used to establish a connection to a PostgreSQL database. This is particularly useful when working with environment variables or configuration files that store database connection information in a URI format.

What are pg-connection-string's main functionalities?

Parsing connection string

This feature allows you to parse a PostgreSQL connection string into a configuration object. The object includes properties such as user, password, host, port, and database, which can be used to establish a connection to a PostgreSQL database.

const { parse } = require('pg-connection-string');

const config = parse('postgres://user:password@localhost:5432/database');

console.log(config);

Other packages similar to pg-connection-string

Readme

Source

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.

Keywords

FAQs

What is pg-connection-string?

Is pg-connection-string popular?

Is pg-connection-string well maintained?

Last updated on 02 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install