Skip to main content

Model Generator

Creates a Drizzle schema model in db/schema.ts.

Usage​

brizzle model <name> [fields...]

Examples​

Basic Model​

brizzle model user name:string email:string

Generates in db/schema.ts:

import { sqliteTable, text, integer } from "drizzle-orm/sqlite-core";

export const users = sqliteTable("users", {
  id: integer("id").primaryKey({ autoIncrement: true }),
  name: text("name").notNull(),
  email: text("email").notNull(),
  createdAt: integer("created_at", { mode: "timestamp" })
    .notNull()
    .$defaultFn(() => new Date()),
  updatedAt: integer("updated_at", { mode: "timestamp" })
    .notNull()
    .$defaultFn(() => new Date()),
});

With Unique Constraint​

brizzle model user name:string email:string:unique

With Nullable Fields​

brizzle model user name:string bio:text? nickname?

The ? modifier makes a field nullable.

With Enum​

brizzle model order total:decimal status:enum:pending,paid,shipped

With References​

brizzle model comment content:text authorId:references:user

Creates a foreign key reference to the users table.

With UUID Primary Key​

brizzle model session token:string --uuid

Uses UUID instead of auto-incrementing integer for the primary key.

Without Timestamps​

brizzle model setting key:string value:text --no-timestamps

Skips the createdAt and updatedAt fields.

Options​

OptionDescription
-f, --forceOverwrite if model exists
-n, --dry-runPreview without writing
-u, --uuidUse UUID for primary key
--no-timestampsSkip createdAt/updatedAt

Database Dialects​

The generated code adapts to your database dialect (detected from drizzle.config.ts):

SQLite​

  • Uses sqliteTable
  • Integers with mode for booleans/timestamps
  • Text for UUIDs

PostgreSQL​

  • Uses pgTable
  • Native boolean, timestamp, uuid types
  • pgEnum for enums

MySQL​

  • Uses mysqlTable
  • Native datetime, boolean types
  • mysqlEnum for enums