PgBuddy

A no-nonsense, type-safe and tiny query builder wrapping postgres.js.

!PGBuddy banner

Features

- 🛡️ Type-safe queries with TypeScript
- 🔒 SQL injection prevention
- 🎯 Simple CRUD operation builders
- 🚀 NEW: Chainable query API
- 📦 Thin wrapper over postgres.js

Installation

``bash
npm install pgbuddy postgres
`

Quick Start

$3

`typescript
import postgres from "postgres";
import { PgBuddyClient } from "pgbuddy";

// Create postgres.js connection
const sql = postgres("postgres://username:password@localhost:5432/dbname");
const db = new PgBuddyClient(sql);

interface User {
id: number;
email: string;
name: string;
active: boolean;
}

// Define table
const users = db.table("users");

// Find users with chainable methods
const activeUsers = await users
.where({ active: true })
.orderBy([{ column: "id", direction: "DESC" }])
.take(10)
.findMany();

// Create a user
const newUser = await users.create({
email: "user@example.com",
name: "User",
active: true,
});

// Create multiple users
const newUsers = await users.createMany([
{ email: "user1@example.com", name: "User 1", active: true },
{ email: "user2@example.com", name: "User 2", active: true },
]);

// Update a user
const updatedUser = await users.where({ id: 1 }).update({ active: false });

// Delete a user
const deletedUser = await users.where({ id: 1 }).delete();
`

$3

`typescript
import postgres from "postgres";
import { PgBuddy } from "pgbuddy";

const sql = postgres("postgres://username:password@localhost:5432/dbname");
const pgBuddy = new PgBuddy(sql);

interface User {
id: number;
email: string;
}

const userTable = pgBuddy.table("users");

// Simple type-safe queries
await userTable.select({
where: { email: "user@example.com" },
});
`

}

const userTable = pgBuddy.table('users');

// Simple type-safe queries
await userTable.select({
where: { email: 'user@example.com' }
});

`

Documentation

PgBuddy provides two APIs for database operations:

$3

Contributions welcome! Please read our contributing guidelines first.
``