Row typesCopy page

types is stored on the schema. Queries still infer a row from schema(). okm build writes .okm/types.d.ts for either value, and okm generate writes that same file. The header is Mode: emitted or Mode: inferred. The interfaces do not change with the mode.

A table named notes becomes Notes, NotesInsert, and NotesUpdate. The file then maps those names on Rows, Inserts, and Updates, in the order of the tables list. Two names that emit one interface are refused there.

t.jsonb<{ published?: boolean }>() keeps that argument in the file. The type parameter is erased at runtime, so the text is read from the schema source. A bare t.jsonb() is jsonb<unknown>. When either form appears, the file starts with export type jsonb<T> = T. t.json<T>() is the same, with json.

emitted

Omitted means "emitted". This is the mode a file imports when it should not re-check the schema.

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

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

export const app = schema({
  tables: [notes],
});

export const mode = app.types;

"emitted" stores the same value.

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

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

export const app = schema({
  tables: [notes],
  types: "emitted", 
});

export const mode = app.types;

inferred

"inferred" stores that mode. The client and Row, Insert, and Update still read the schema. Use this when the checker should see the schema, not the written interfaces.

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

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

export const app = schema({
  tables: [notes],
  types: "inferred", 
});

export const mode = app.types;

together

Two tables, a typed jsonb, and the default mode. okm build writes Notes and Comments, each with an insert and an update, then Rows, Inserts, and Updates.

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

const notes = table("notes", {
  id: t.identity(),
  title: t.text(),
  meta: t.jsonb<{ published?: boolean }>(), 
});

const comments = table("comments", {
  id: t.identity(),
  noteId: t.bigint().references("notes"),
  body: t.text(),
});

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