Schema API Reference

Complete reference for all schema definition APIs.

Model

`s.model(fields)`

Create a new model:

const user = s.model({
  id: s.string().id(),
  name: s.string(),
});

Model Methods

Method	Description
`.map(name)`	Set table name
`.index(fields, options?)`	Add index
`.id(fields, options?)`	Compound primary key
`.unique(fields, options?)`	Compound unique constraint
`.extends(fields)`	Add fields

Field Types

String

s.string()
s.string(TYPES.PG.STRING.VARCHAR(255))

Method	Description
`.id()`	Mark as primary key
`.unique()`	Unique constraint
`.nullable()`	Allow NULL
`.array()`	Array type
`.default(value)`	Default value
`.validator(schema)`	Custom validation
`.map(name)`	Column name
`.uuid()`	Auto-generate UUID
`.ulid()`	Auto-generate ULID
`.nanoid()`	Auto-generate NanoID
`.cuid()`	Auto-generate CUID

Number Types

s.int()
s.float()
s.decimal()
s.bigInt()

Method	Description
`.id()`	Primary key
`.unique()`	Unique constraint
`.nullable()`	Allow NULL
`.array()`	Array type
`.default(value)`	Default value
`.increment()`	Auto-increment (int only)

Boolean

s.boolean()

Method	Description
`.nullable()`	Allow NULL
`.default(value)`	Default value

DateTime

s.dateTime()

Method	Description
`.nullable()`	Allow NULL
`.default(value)`	Default value
`.now()`	Default to current time
`.updatedAt()`	Auto-update on change

JSON

s.json()
s.json(zodSchema)

Method	Description
`.nullable()`	Allow NULL
`.default(value)`	Default value

Enum

s.enum(["VALUE1", "VALUE2"])

Method	Description
`.nullable()`	Allow NULL
`.default(value)`	Default value

Blob

s.blob()

Method	Description
`.nullable()`	Allow NULL

Vector

s.vector()

Method	Description
`.nullable()`	Allow NULL

Relations

VibORM uses a config-first, getter-last pattern for relations:

s.relation.config().type(() => targetModel)

One-to-One

s.relation.oneToOne(() => targetModel)

// With config
s.relation
  .fields("userId")
  .references("id")
  .optional()
  .oneToOne(() => targetModel)

One-to-Many

s.relation.oneToMany(() => targetModel)

No FK config needed — FK is on the many side.

Many-to-One

s.relation
  .fields("authorId")
  .references("id")
  .manyToOne(() => targetModel)

Many-to-Many

s.relation.manyToMany(() => targetModel)

// With junction table config
s.relation
  .through("post_tags")
  .A("post_id")
  .B("tag_id")
  .manyToMany(() => targetModel)

Relation Config Methods

Method	Description
`.fields(...names)`	FK fields on current model
`.references(...names)`	Referenced fields on target
`.optional()`	Nullable relation (to-one only)
`.onDelete(action)`	Delete behavior
`.onUpdate(action)`	Update behavior
`.through(tableName)`	Junction table (many-to-many)
`.A(columnName)`	Source FK column (many-to-many)
`.B(columnName)`	Target FK column (many-to-many)

Referential Actions

Action	Description
`"cascade"`	Delete/update related
`"setNull"`	Set FK to null
`"restrict"`	Prevent operation
`"noAction"`	Database default

Index Options

.index(fields, {
  name: "idx_name",
  type: "btree",
  unique: false,
  where: "condition",
})

Option	Values
`name`	Custom index name
`type`	`"btree"`, `"hash"`, `"gin"`, `"gist"`
`unique`	`true`, `false`
`where`	Partial index condition

Schema API Reference

On this page