pg-env

pg-env

PostgreSQL environment configuration utilities for managing database connection settings.

Installation

npm install pg-env

Features

• Parse PostgreSQL environment variables (PGHOST, PGPORT, etc.)
• Convert configuration objects to environment variables
• Merge environment variables with configuration overrides
• Create spawn environments with PostgreSQL settings

Usage

Basic Configuration

import { PgConfig, getPgEnvOptions } from 'pg-env';

// Get PostgreSQL config from environment with defaults
const config = getPgEnvOptions();
console.log(config);
// { host: 'localhost', port: 5432, user: 'postgres', ... }

// Override specific values
const customConfig = getPgEnvOptions({
  database: 'myapp',
  port: 5433
});

Environment Variables

import { getPgEnvVars, toPgEnvVars } from 'pg-env';

// Read current PostgreSQL environment variables
const envVars = getPgEnvVars();
// Returns partial PgConfig from PGHOST, PGPORT, etc.

// Convert config to environment variables
const config: PgConfig = {
  host: 'db.example.com',
  port: 5432,
  user: 'appuser',
  password: 'secret',
  database: 'myapp'
};

const envVars = toPgEnvVars(config);
// { PGHOST: 'db.example.com', PGPORT: '5432', ... }

Spawning Processes

import { getSpawnEnvWithPg } from 'pg-env';
import { spawn } from 'child_process';

// Create environment for spawning processes
const env = getSpawnEnvWithPg({
  database: 'testdb',
  user: 'testuser'
});

// Use with child processes
const child = spawn('psql', [], { env });

API

Types

PgConfig

interface PgConfig {
  host: string;
  port: number;
  user: string;
  password: string;
  database: string;
}

Functions

• getPgEnvOptions(overrides?: Partial<PgConfig>): PgConfig - Get config from environment with overrides
• getPgEnvVars(): Partial<PgConfig> - Parse PostgreSQL environment variables
• toPgEnvVars(config: Partial<PgConfig>): Record<string, string> - Convert config to env vars
• getSpawnEnvWithPg(config: Partial<PgConfig>, baseEnv?: NodeJS.ProcessEnv): NodeJS.ProcessEnv - Create spawn environment

Constants

• defaultPgConfig: PgConfig - Default PostgreSQL configuration

Environment Variables

The package reads the following environment variables:

• PGHOST - Database host
• PGPORT - Database port (parsed as number)
• PGUSER - Database user
• PGPASSWORD - Database password
• PGDATABASE - Database name

Education and Tutorials

• 🚀 Quickstart: Getting Up and Running Get started with modular databases in minutes. Install prerequisites and deploy your first module.

• 📦 Modular PostgreSQL Development with Database Packages Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.

• ✏️ Authoring Database Changes Master the workflow for adding, organizing, and managing database changes with pgpm.

• 🧪 End-to-End PostgreSQL Testing with TypeScript Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.

• ⚡ Supabase Testing Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.

• 💧 Drizzle ORM Testing Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.

• 🔧 Troubleshooting Common issues and solutions for pgpm, PostgreSQL, and testing.

Related Constructive Tooling

📦 Package Management

• pgpm: 🖥️ PostgreSQL Package Manager for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.

🧪 Testing

• pgsql-test: 📊 Isolated testing environments with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
• pgsql-seed: 🌱 PostgreSQL seeding utilities for CSV, JSON, SQL data loading, and pgpm deployment.
• supabase-test: 🧪 Supabase-native test harness preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
• graphile-test: 🔐 Authentication mocking for Graphile-focused test helpers and emulating row-level security contexts.
• pg-query-context: 🔒 Session context injection to add session-local context (e.g., SET LOCAL) into queries—ideal for setting role, jwt.claims, and other session settings.

🧠 Parsing & AST

• pgsql-parser: 🔄 SQL conversion engine that interprets and converts PostgreSQL syntax.
• libpg-query-node: 🌉 Node.js bindings for libpg_query, converting SQL into parse trees.
• pg-proto-parser: 📦 Protobuf parser for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
• @pgsql/enums: 🏷️ TypeScript enums for PostgreSQL AST for safe and ergonomic parsing logic.
• @pgsql/types: 📝 Type definitions for PostgreSQL AST nodes in TypeScript.
• @pgsql/utils: 🛠️ AST utilities for constructing and transforming PostgreSQL syntax trees.

Credits

🛠 Built by the Constructive team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on GitHub.

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.