Denorm

A lightweight ORM for PostgreSQL and SQLite in Deno, inspired by Drizzle ORM.

Features

• Support for PostgreSQL and SQLite databases
• Type-safe query building
• Schema definition with migrations
• Simple and intuitive API
• Zero dependencies beyond Deno standard library

Installation

import denorm from "https://raw.githubusercontent.com/yourusername/denorm/main/denorm.ts";

Quick Start

1. Define your database configuration:

// config.ts
import { DatabaseConfig } from "./denorm.ts";

const config: DatabaseConfig = {
  type: "sqlite", // or "postgres"
  connectionString: "./database.sqlite",
};

export default config;

2. Define your schema:

// schema.ts
import { 
  text, 
  integer, 
  timestamp,
  TableDefinition 
} from "./denorm.ts";

export const schema: Record<string, TableDefinition> = {
  users: {
    name: "users",
    columns: {
      id: integer({ primaryKey: true, autoIncrement: true }),
      username: text({ unique: true, nullable: false }),
      email: text({ unique: true, nullable: false }),
      created_at: timestamp({ defaultValue: "CURRENT_TIMESTAMP" })
    },
    indexes: {
      users_email_idx: {
        columns: ["email"],
        unique: true
      }
    }
  }
};

3. Initialize the database and create tables:

import denorm from "./denorm.ts";
import config from "./config.ts";
import { schema } from "./schema.ts";

const db = denorm(config);
await db.connect();

// Define tables from schema
for (const [_, table] of Object.entries(schema)) {
  db.defineTable(table);
}

// Create tables in database
await db.createTables();

// Now you can use the db
const users = await db.find("users");
console.log(users);

// Close connection when done
await db.disconnect();

Migration Workflow

Denorm includes a full-featured migration system:

1. Initialize migrations:

deno run -A migrate.ts init

2. Generate a migration from your schema:

deno run -A migrate.ts schema create_users_and_posts

3. Apply migrations:

deno run -A migrate.ts up

4. List migrations:

deno run -A migrate.ts list

5. Rollback the last migration:

deno run -A migrate.ts down

6. Rollback multiple migrations:

deno run -A migrate.ts down --step=3

7. Rollback to a specific migration:

deno run -A migrate.ts down --to=20230101120000_create_users

8. Push schema changes directly to the database:

deno run -A migrate.ts push

API Reference

Database Configuration

type DatabaseConfig = {
  type: 'postgres' | 'sqlite';
  connectionString: string;
};

Column Types

• text(options?)
• integer(options?)
• real(options?)
• boolean(options?)
• date(options?)
• timestamp(options?)
• json(options?)
• jsonb(options?) (PostgreSQL only)

Column Options

type ColumnDefinition = {
  type: ColumnType;
  primaryKey?: boolean;
  autoIncrement?: boolean;
  unique?: boolean;
  nullable?: boolean;
  defaultValue?: unknown;
  references?: {
    table: string;
    column: string;
  };
};

CRUD Operations

// Insert
const user = await db.insert("users", { 
  username: "johndoe", 
  email: "john@example.com" 
});

// Find all
const allUsers = await db.find("users");

// Find with condition
const john = await db.findOne("users", { username: "johndoe" });

// Update
await db.update(
  "users", 
  { email: "john.doe@example.com" }, 
  { id: user.id }
);

// Delete
await db.delete("users", { id: user.id });

Raw Queries

const result = await db.query(
  "SELECT * FROM users WHERE username LIKE ?", 
  ["%john%"]
);

License

MIT