What problem does it solve?
Drizzle ORM Schema Style Guide provides a standardized approach to define database schemas, migrations, and ORM models for PostgreSQL projects using Drizzle, ensuring consistency and maintainability across codebases.
Core Features & Use Cases
- Configuration: guidance on project layout with drizzle.config.ts, src/database/schemas/, and src/database/migrations/, plus dialect settings.
- Helper Functions: utilities like timestamptz, createdAt, updatedAt, accessedAt for consistent timestamp handling.
- Naming Conventions: rules for plural table names and snake_case columns.
- Column Definitions: patterns for primary keys, foreign keys, timestamps, and indexes.
- Type Inference: how to derive TypeScript types from defined schemas for insert and select operations.
- Example Pattern: illustrates typical table definitions and relationships with practical patterns (e.g., referencing users in tables, including timestamps).
Quick Start
Define your database schemas under src/database/schemas, create migrations, and generate ORM models for PostgreSQL with Drizzle.