dbuddy

DBuddy

A TypeScript SQL library for PostgreSQL.

Installation

npm install dbuddy

# Or install the beta version
npm install dbuddy@beta

Development Setup

Prerequisites

• Node.js 18+
• Docker and Docker Compose

Installation

npm install

Environment Configuration

Copy the example environment file and configure your database settings:

cp .env.example .env

Edit .env with your database configuration:

# Standard PostgreSQL environment variables
PGHOST=localhost
PGPORT=15432
PGDATABASE=dbuddy_dev
PGUSER=postgres
PGPASSWORD=postgres

# Alternative: use DATABASE_URL
# DATABASE_URL=postgresql://postgres:postgres@localhost:15432/dbuddy_dev

Database Setup

Start the PostgreSQL database:

docker-compose up -d

The database will be available at localhost:15432 with:

• Database: dbuddy_dev
• User: postgres
• Password: postgres

Development

# Build the library
npm run build

# Watch mode for development
npm run dev

# Run tests
npm test

# Run tests once
npm run test:run

# Run tests with coverage
npm run test:coverage

# Lint code
npm run lint

# Fix linting issues
npm run lint:fix

# Type check
npm run typecheck

TypeScript Type Generation

Generate TypeScript interfaces and query builders from your database schema:

# Generate types for all tables
npx dbuddy

# Generate types for all tables in a specific directory
npx dbuddy ./my-types

# Generate types for specific tables only
npx dbuddy ./generated users posts comments

# Via npm scripts (alternative)
npm run generate
npm run generate:types

This will create TypeScript files with:

• Interface definitions for each table
• Typed query builder classes
• Factory functions for creating queries

Usage

import { Database, getDatabaseConfig } from 'dbuddy'

// Option 1: Use environment variables (reads from .env automatically)
const db = new Database()

// Option 2: Use explicit configuration
const db2 = new Database({
  host: 'localhost',
  port: 15432,
  database: 'dbuddy_dev',
  user: 'postgres',
  password: 'postgres'
})

// Option 3: Get config object from environment
const config = getDatabaseConfig()
const db3 = new Database(config)

// Execute query
const result = await db.query('SELECT * FROM users')
console.log(result.rows)

// Parameterized query
const user = await db.query('SELECT * FROM users WHERE id = $1', [1])

// Close connection
await db.close()

Using Generated Types

After generating types, you can use them for type-safe database queries:

import { Database } from 'dbuddy'
import { userQuery, User } from './generated'

const db = new Database()

// Type-safe queries with auto-completion
const users = await userQuery(db)
  .where(q => q.isActive.equals(true))
  .and(q => q.createdAt.greaterThan(new Date('2024-01-01')))
  .select()

// users is typed as User[]
console.log(users[0].firstName) // Type-safe property access

Database Migrations

DBuddy includes a comprehensive migration system for managing database schema changes:

# Initialize migration system
npx dbuddy migration init

# Create a new migration
npx dbuddy migration create add_users_table

# Apply pending migrations
npx dbuddy migration up

# Check migration status
npx dbuddy migration status

# Rollback migrations
npx dbuddy migration down

# Dry run (preview without executing)
npx dbuddy migration up --dry-run

See MIGRATION.md for complete migration documentation.

License

MIT