This package provides a PGClient implementation directly connecting to
PostgreSQL servers, and not requiring a PGProxy Server to run.
This is useful (mostly? only?) when running tests with a PostgreSQL instance running on a developer's machine, or in CI environments.
Simply register the client by importing it, and ensure that the PGURL
environment variable is set to the psql url of the PostgreSQL server (or
specify the URL in the constructor):
import '@juit/pgproxy-client-psql'
import { PGClient } from '@juit/pgproxy-client'
const client = new PGClient('psql://username:password@locahost:5432/my-database')The PSQL client can be used directly by simply importing the PSQLClient
class:
import { PSQLClient } from '@juit/pgproxy-client-psql'
const client = new PSQLClient('psql://username:password@locahost:5432/my-database')The PSQLClient implementation does not require a connection URL, and all
connection parameters can be specified via libpq environment variables.
The special (empty) URL psql:/// can be used with PGClient in order to
trigger this behaviour or PSQLClient instances can be constructed without
an URL parameter.
For a description of the environment variables supported by libpq simply look
at the official documentation.