Models

A model is a plain TypeScript interface. Annotations in line comments above each field control column types, constraints, and relations. No separate schema file needed.

Basic model

src/models.ts

// src/models.ts

interface User {
  // @auto;primaryKey
  id: number;
  // @unique
  email: string;
  name: string;
  // @nullable
  bio: string;
  // @default:user
  role: string;
  // @json
  settings: Record<string, unknown>;
  // @softDelete
  deletedAt: string;
  createdAt: string;    // injected automatically
  updatedAt: string;    // injected automatically
}

Relations

src/models.ts

interface Post {
  // @auto;primaryKey
  id: number;
  title: string;
  // @length:5000
  body: string;
  // @default:false
  published: boolean;
  // @index
  userId: number;
  // @relation manytoone:User;foreignKey:userId
  user?: User;
  // @relation onetomany:Comment;foreignKey:postId
  comments?: Comment[];
}

Many-to-many

src/models.ts

interface Team {
  // @auto;primaryKey
  id: number;
  name: string;
  // @relation manytomany:User;through:team_members;foreignKey:teamId;relatedKey:userId
  members?: User[];
}

One-to-one

src/models.ts

interface Profile {
  // @auto;primaryKey
  id: number;
  // @unique
  userId: number;
  // @nullable
  avatarUrl: string;
  // @relationship onetoone:User;foreignKey:userId;onDelete:CASCADE
  user?: User;
}

Enum fields

src/models.ts

interface Todo {
  // @auto;primaryKey
  id: number;
  title: string;
  // @enum:(pending,in_progress,done)
  status: string;
  // @not null
  priority: number;
}

Field metadata reference

Annotations go in a // comment on the line directly above the field. Both @-prefixed and bare variants are supported by the migrator.

Annotation	Effect
`@auto`	AUTOINCREMENT / SERIAL primary key
`@primaryKey`	Marks field as primary key
`@unique`	Adds UNIQUE constraint
`@index`	Creates an index on this column
`@nullable`	Allows NULL values
`@not null`	Adds NOT NULL constraint (explicit)
`@length:N`	Sets VARCHAR(N) column length
`@json`	Stores value as JSON string (TEXT column)
`@softDelete`	Marks deletedAt as soft-delete column; queries auto-filter deleted rows
`@enum:(a,b,c)`	CHECK constraint (SQLite/Postgres) or ENUM type (MySQL)
`@default:value`	Sets column DEFAULT value
`@random:string:N`	Generates a random string of length N on insert
`@random:number:N`	Generates a random N-digit number on insert
`@random:string(N)`	Alternate syntax for @random:string:N
`@random:number(N)`	Alternate syntax for @random:number:N
`@comment:text`	Adds column comment (MySQL/Postgres)
`@relation ...`	Declares a relation. See Relations page.
`@relationship ...`	Alias for @relation
`@mask:preset`	Masks output on read with built-in presets (ssn, creditcard, email, phone) or directives (showFirst:N, showLast:N, showBoth:F,L, char:X, pattern:...)
`@omitdb`	Excludes field from INSERT/UPDATE SET clauses and all read results; no column value stored in DB
`@omitjson`	Stores in DB but strips from all read results unless explicitly .select()ed
`@omitmigrate`	No column created/altered/dropped by the migrator — manual DDL; field still usable in queries

Automatic columns

createdAt and updatedAt are injected into every table automatically.deletedAt is only added when a field is annotated with @softDelete. You don't need to declare these unless you want to customize their behavior.

PreviousConfiguration NextdefineModel