PostgreSQL Wrapper for database-js

1.1.3 · abandoned · verified Wed Apr 22

database-js-postgres is a wrapper library designed to integrate PostgreSQL databases with the database-js framework. It utilizes the widely adopted node-postgres package under the hood to handle core database interactions, exposing its functionality through a consistent promise-based API, even when used independently of database-js. The library reached its latest stable version, 1.1.3, in late 2017. Given the lack of updates or commits since then, its release cadence is effectively ceased, and the project is considered unmaintained. Its primary differentiation was to provide a standardized interface within the database-js ecosystem, enabling a uniform approach to various SQL databases. However, its dependency on outdated Node.js versions and its CommonJS-only structure limit its applicability in modern JavaScript environments.

Common errors

```
Error: connect ECONNREFUSED
```
cause The PostgreSQL server is not running, is not accessible from the application's host, or the specified port is incorrect.

fix Verify that your PostgreSQL server is running, listening on the specified host and port (default 5432), and that no firewall is blocking the connection.
```
Error: password authentication failed for user "my_secret_username"
```
cause Incorrect username or password, or the PostgreSQL server's `pg_hba.conf` configuration does not allow the specified authentication method for the user/database.

fix Double-check the username and password in your connection string. Consult your PostgreSQL server's `pg_hba.conf` file to ensure the client IP address and user are permitted to connect with password authentication (e.g., `md5`, `scram-sha-256`).
```
Cannot find module 'database-js-postgres'
```
cause The package is not installed or `npm install` was not run.

fix Run `npm install database-js-postgres` in your project directory to install the package.

Warnings

breaking The package `database-js-postgres` has been abandoned since late 2017. It no longer receives updates, bug fixes, or security patches. Using it in production is highly discouraged.
Fix: Migrate to a currently maintained PostgreSQL driver like `node-postgres` directly or a well-supported ORM/query builder.
gotcha The documentation specifies a prerequisite of 'NodeJS >= 6.0'. Modern Node.js versions are not guaranteed to be compatible, and using such an old Node.js version is a significant security risk.
Fix: Avoid using this package with modern Node.js versions. If forced to use, thorough testing is required, but migration is the recommended path.
gotcha This package is CommonJS-only and does not support ES Modules (ESM) syntax (`import/export`). Attempting to use ESM will result in errors.
Fix: Use CommonJS `require()` syntax for all imports. For projects requiring ESM, consider alternative, actively maintained libraries.
gotcha When used with `database-js`, the README explicitly imports from `database-js2`. Ensure the correct package (`database-js` or `database-js2`) is installed and matched to the example's usage, as this can be a source of confusion.
Fix: Verify your `package.json` dependencies and import paths to match the documented `require('database-js2').Connection;` if integrating with the parent framework.

Install

npm install database-js-postgres npm
yarn add database-js-postgres yarn
pnpm add database-js-postgres pnpm

Imports

postgres

wrong:

import postgres from 'database-js-postgres';

correct:

const postgres = require('database-js-postgres');

Package is CommonJS-only; direct ESM import is not supported.

Connection
wrong:
```
import { Connection } from 'database-js2';
```
correct:
```
const Database = require('database-js2').Connection;
```
When using with database-js, the Connection class is imported from 'database-js2' as shown in the original documentation. This is a CommonJS require.

Connection (standalone)

wrong:

import { open } from 'database-js-postgres';
const connection = open({ ... });

correct:

const postgres = require('database-js-postgres');
const connection = postgres.open({ ... });

The `open` method for standalone usage is accessed via the default export of the package, not a named export. Requires CommonJS.

Quickstart

Demonstrates connecting to a PostgreSQL database, executing a SELECT query with parameters, performing an INSERT operation, and properly closing the connection using the standalone promise-based API.

const postgres = require('database-js-postgres');

(async () => {
    let connection, rows;

    // Establish a connection to the PostgreSQL database
    connection = postgres.open({
        Hostname: 'localhost',
        Port: 5432,
        Username: 'my_secret_username',
        Password: 'my_secret_password',
        Database: 'my_top_secret_database'
    });
    
    try {
        // Execute a query and fetch results
        rows = await connection.query("SELECT id, name FROM users WHERE email = ?", ['example@email.com']);
        console.log('Query Results:', rows);

        // Example of an insert statement
        const insertResult = await connection.query("INSERT INTO logs (message) VALUES (?) RETURNING id", ['User logged in successfully']);
        console.log('Insert Result:', insertResult);

    } catch (error) {
        console.error('Database Operation Error:', error);
    } finally {
        // Always ensure the connection is closed
        await connection.close();
        console.log('Connection closed.');
    }
})();

view raw JSON →