Id defaultCopy page

defaults has one field, id. It replaces a bare t.id(). A column that passes default is left alone. "none" is that column option. It is not a schema value.

The id is omitted from insert for a database default and for a client generator. "none" is required on insert and still omitted from update.

omitted

Omitted and {} store gen_random_uuid(). "uuidv4" stores the same function. It is built in from Postgres 13, so a bare t.id() works on every supported major. Random ids are fine for most tables. A large write-heavy table can pick uuidv7: the ids are time-ordered and the index stays local. That function needs Postgres 18.

import { schema, table, t } from "okmodel/pg";

const notes = table("notes", {
  id: t.id(), 
  title: t.text(),
});

export default schema({
  tables: [notes],
});

uuidv7

"uuidv7" stores uuidv7(). Keep the previous default with defaults: { id: "uuidv7" }.

import { schema, table, t } from "okmodel/pg";

const notes = table("notes", {
  id: t.id(),
  title: t.text(),
});

export default schema({
  tables: [notes],
  defaults: { id: "uuidv7" }, 
});

uuidv4

"uuidv4" stores gen_random_uuid(), the same expression a bare t.id() stores. That function is built in from Postgres 13.

import { schema, table, t } from "okmodel/pg";

const notes = table("notes", {
  id: t.id(),
  title: t.text(),
});

export default schema({
  tables: [notes],
  defaults: { id: "uuidv4" }, 
});

client

A generator from okmodel/ids runs on insert. The catalog stores no default. Changing an OKID prefix, length, or sortable flag does not change the catalog hash. The SQL type does: okid() is text, and uuidv4 or uuidv7 stay uuid.

uuid

uuidv4 and uuidv7 stay uuid. The client uuidv7 mints a time-ordered id, so a server older than Postgres 18 can still use one.

import { uuidv7 } from "okmodel/ids";
import { schema, table, t } from "okmodel/pg";

const sessions = table("sessions", {
  id: t.id(),
  name: t.text(),
});

export default schema({
  tables: [sessions],
  defaults: { id: uuidv7 }, 
});

okid

okid() is text with collation C. Calling it returns the generator. It does not mint the id here. Length, prefix, and sortable are on OKID.

import { okid } from "okmodel/ids";
import { schema, table, t } from "okmodel/pg";

const users = table("users", {
  id: t.id(),
  name: t.text(),
});

export default schema({
  tables: [users],
  defaults: { id: okid({ prefix: "usr_" }) }, 
});

column

A column option wins. A bare t.id() takes the schema default. t.id({ default: "uuidv4" }) stays gen_random_uuid() and stays uuid.

import { okid } from "okmodel/ids";
import { schema, table, t } from "okmodel/pg";

const users = table("users", {
  id: t.id(), 
  name: t.text(),
});

const sessions = table("sessions", {
  id: t.id({ default: "uuidv4" }), 
  name: t.text(),
});

export default schema({
  tables: [users, sessions],
  defaults: { id: okid({ prefix: "usr_" }) },
});