Skip to content
Kumiko

kumiko schema

Terminal window
kumiko schema <subcommand>

Preferred path for new apps. Uses kumiko/schema.ts (ENTITY_METAS) and checked-in SQL under kumiko/migrations/. No drizzle-kit at runtime.

Legacy apps with drizzle.config.ts keep using kumiko migrate.

Subcommands

Section titled “Subcommands”
SubcommandWhat it does
generate <name>Diff ENTITY_METAS vs last snapshot → new NNNN_<name>.sql
applyApply pending SQL files (deploy step, idempotent)
statusList applied vs pending migrations

Typical flow

Section titled “Typical flow”
Terminal window
cd my-app
# kumiko/schema.ts exports ENTITY_METAS from composeFeatures(APP_FEATURES)
bun kumiko schema generate add-notes-pinned
git diff kumiko/migrations/    # review SQL — hand-edit OK
bun kumiko schema apply        # local / pre-deploy

Convention

Section titled “Convention”

kumiko/schema.ts must export:

export const ENTITY_METAS: readonly EntityTableMeta[] = …;

See kumiko-framework/samples/apps/use-all-bundled/kumiko/schema.ts.

See also

Section titled “See also”