pgsql-client

PostgreSQL client utilities with query helpers, RLS context management, and database administration.

Overview

pgsql-client provides a set of utilities for working with PostgreSQL databases:

• DbAdmin: Database administration operations (create, drop, templates, extensions, grants)
• PgClient: Query helpers with RLS context management
• Role utilities: Role name mapping for anonymous, authenticated, and administrator roles
• Context utilities: Generate SQL for setting PostgreSQL session context variables
• Stream utilities: Stream SQL to psql process

Installation

npm install pgsql-client

Usage

DbAdmin

import { DbAdmin } from 'pgsql-client';

const admin = new DbAdmin({
  host: 'localhost',
  port: 5432,
  user: 'postgres',
  password: 'password',
  database: 'mydb'
});

// Create a database
admin.create('mydb');

// Install extensions
admin.installExtensions(['uuid-ossp', 'pgcrypto'], 'mydb');

// Drop a database
admin.drop('mydb');

PgClient

import { PgClient } from 'pgsql-client';

const client = new PgClient({
  host: 'localhost',
  port: 5432,
  user: 'app_user',
  password: 'password',
  database: 'mydb'
});

// Query helpers
const users = await client.any('SELECT * FROM users');
const user = await client.one('SELECT * FROM users WHERE id = $1', [userId]);
const maybeUser = await client.oneOrNone('SELECT * FROM users WHERE email = $1', [email]);

// Set RLS context
client.setContext({ role: 'authenticated', 'jwt.claims.user_id': userId });

// Or use the auth helper
client.auth({ role: 'authenticated', userId: userId });

// Close the connection
await client.close();

API

DbAdmin

• create(dbName?) - Create a database
• drop(dbName?) - Drop a database
• createFromTemplate(template, dbName?) - Create database from template
• installExtensions(extensions, dbName?) - Install PostgreSQL extensions
• connectionString(dbName?) - Generate connection string
• createTemplateFromBase(base, template) - Create template database
• cleanupTemplate(template) - Clean up template database
• grantRole(role, user, dbName?) - Grant role to user
• grantConnect(role, dbName?) - Grant connect privilege
• createUserRole(user, password, dbName) - Create user with roles
• loadSql(file, dbName) - Load SQL file
• streamSql(sql, dbName) - Stream SQL to database

PgClient

• query(sql, values?) - Execute query with context
• any(sql, values?) - Return all rows
• one(sql, values?) - Return exactly one row (throws if not exactly one)
• oneOrNone(sql, values?) - Return one row or null
• many(sql, values?) - Return many rows (throws if none)
• manyOrNone(sql, values?) - Return rows or empty array
• none(sql, values?) - Execute without returning rows
• result(sql, values?) - Return full QueryResult
• begin() - Begin transaction
• commit() - Commit transaction
• savepoint(name?) - Create savepoint
• rollback(name?) - Rollback to savepoint
• setContext(ctx) - Set session context variables
• auth(options?) - Set authentication context
• clearContext() - Clear context and reset to anonymous
• close() - Close connection

License

MIT

Education and Tutorials

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

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

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

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

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

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

7. 🔧 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.