🐘

driver-postgres

Official
driver

Official PostgreSQL driver for ObjectStack. Connect to Postgres databases with full SQL support and type safety.

ostack add driver-postgres

Documentation

PostgreSQL Driver for ObjectStack

The official PostgreSQL driver provides seamless integration with PostgreSQL databases.

Features

  • ✅ Full SQL support with type safety
  • ✅ Connection pooling
  • ✅ Transaction management
  • ✅ Query builder integration
  • ✅ Migration support

Installation

ostack add driver-postgres

Quick Start

import { PostgresDriver } from '@objectstack/driver-postgres';

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

await db.connect();
const users = await db.query('SELECT * FROM users');

Configuration

OptionTypeRequiredDescription
hoststringYesDatabase host
portnumberNoPort (default: 5432)
databasestringYesDatabase name
userstringYesUsername
passwordstringYesPassword

Advanced Usage

Connection Pooling

const db = new PostgresDriver({
  // ... connection options
  pool: {
    min: 2,
    max: 10
  }
});

Transactions

await db.transaction(async (tx) => {
  await tx.query('INSERT INTO users (name) VALUES ($1)', ['Alice']);
  await tx.query('INSERT INTO logs (action) VALUES ($1)', ['user_created']);
});

License

MIT © ObjectStack Team