@esposter/db-schema

Drizzle ORM schemas, relations, and migrations for Esposter's PostgreSQL database. The source of truth for all relational data — usable in both browser and server environments.

Table of Contents

• 📖 Documentation
• ⚖️ License

📖 Documentation

We highly recommend you take a look at the documentation to level up.

Migration Workflow

After editing a schema file, generate and apply the migration:

# From packages/db-schema/
pnpm db:gen     # generate migration SQL from schema changes
pnpm db:up      # apply pending migrations to the database
pnpm db:studio  # open Drizzle Studio UI for visual inspection
Copy

Migrations are output to packages/app/server/db/migrations/.

Schema Domains

Conventions

• Use the pgTable wrapper (re-exported from this package), not raw drizzle pgTable — the wrapper adds standard metadata columns.
• Columns use camelCase property names matching TypeScript properties.
• All z.discriminatedUnion schemas must end with satisfies z.ZodType<UnionType>.
• Each model file holds exactly one interface/class and one schema.

Commands

Run from packages/db-schema/:

pnpm db:gen       # generate migration
pnpm db:up        # apply migrations
pnpm db:studio    # Drizzle Studio
pnpm build        # compile to dist/
pnpm test         # vitest watch mode
pnpm lint:fix     # auto-fix lint
pnpm typecheck    # type check
Copy

⚖️ License

This project is licensed under the Apache-2.0 license.