pg-query-template

library1.1.1jsnpmunverified

Query Templates for Postgres in Node.js. A lightweight library (v1.1.1, stable) for creating parameterized SQL query templates, reducing boilerplate and improving security by separating query structure from data. Active development with a MIT license; minimal dependencies but requires Node.js and a PostgreSQL client like 'pg'. Differentiates with simple template syntax and explicit query parameterization.

database

npm install pg-query-template

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PG-QUERY-TEMPLATE

pg-query-template

databasejavascriptv1.1.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import QueryTemplate from 'pg-query-template'

✗ const QueryTemplate = require('pg-query-template').default

Library is ESM with default export; CommonJS users can use const QueryTemplate = require('pg-query-template').default or enable ESM.

QueryTemplate

✓ import QueryTemplate from 'pg-query-template'

✗ import { QueryTemplate } from 'pg-query-template'

Default export only; named import will fail.

getConnection

✓ import { getConnection } from 'pg-query-template'

✗ import getConnection from 'pg-query-template'

Named export for obtaining a database connection.

Creates a QueryTemplate, connects to PostgreSQL using pg Pool, executes parameterized query, and logs results.

import QueryTemplate from 'pg-query-template'; import { Pool } from 'pg'; const pool = new Pool({ connectionString: process.env.DATABASE_URL }); const userQuery = new QueryTemplate('SELECT * FROM users WHERE id = $1'); async function run() { const client = await pool.connect(); try { const res = await userQuery.execute(client, [1]); console.log(res.rows); } finally { client.release(); } } run().catch(console.error);

Debug

Known issues

breakingLibrary uses ESM; CommonJS require() does not work without .default

fix

Use import or require('pg-query-template').default

affects: >=1.0

gotchaSQL injection risk if parameters are not passed properly

fix

Always use parameterized queries; never concatenate user input into template string.

affects: all

gotchaexecute() expects a pg client (not pool) directly

fix

Call pool.connect() to get a client, then pass client to execute()

affects: all

Errors

Common errors & fixes

TypeError: QueryTemplate is not a constructor

Using require without .default in CommonJS

fix

const QueryTemplate = require('pg-query-template').default;

Error: Client has already been released

Attempting to reuse a client after calling client.release()

fix

Get a new client from pool for each query execution.

ReferenceError: require is not defined

Using require in ESM context

fix

Use import syntax: import QueryTemplate from 'pg-query-template';

Upgrade

Version history

1.1.1latest on npm

Audit

Dependencies

pgrequiredPostgreSQL client required to execute queries

Agent activity

4 hits · last 30 days

node

Resources

githubgit://github.com/qooleot/node-pg-query-template ↗

packagepg-query-template ↗

homepagehttps://github.com/qooleot/node-pg-query-template#readme ↗