Relations
Parent-child relations with cascade / restrict.
What it shows
Section titled “What it shows”- Relation declarations between entities
- Delete behaviour (cascade vs restrict)
Source
Section titled “Source”Feature entry point: src/feature.ts.
Needs the Postgres from the repo root’s docker-compose.yml (docker compose up -d); TEST_DATABASE_URL defaults to postgresql://kumiko:kumiko@localhost:15432/kumiko_test.
cd samples/recipes/relationsbun testSource code
Section titled “Source code”The feature entry point — embedded straight from the source file, so the code here is exactly what runs. Multi-file samples keep their remaining files next to it on GitHub (link below):
import { createEntity, createReferenceField, createTextField, defineFeature,} from "@cosmicdrift/kumiko-framework/engine";
export const teamEntity = createEntity({ name: "team", table: "read_sample_teams", fields: { name: createTextField({ personal: false, reason: "is_business_data", required: true }), },});
export const memberEntity = createEntity({ name: "member", table: "read_sample_members", fields: { name: createTextField({ personal: { of: "id" }, find: "none", required: true }), teamId: createReferenceField({ entity: "team", personal: false, reason: "is_system_identifier", required: true, }), role: createTextField({ personal: false, reason: "is_business_data" }), },});
export const taskEntity = createEntity({ name: "task", table: "read_sample_member_tasks", fields: { title: createTextField({ personal: false, reason: "is_business_data", required: true }), memberId: createReferenceField({ entity: "member", personal: "ref", required: true }), },});
const adminWrite = { access: { roles: ["Admin"] } } as const;const openRead = { access: { openToAll: { reason: "any signed-in user may read a task by id; writes are still gated by adminWrite", }, },} as const;const createOnly = { update: false, delete: false, restore: false, list: false, detail: false,} as const;
const createAndDelete = { ...createOnly, delete: true } as const;
export const relationsFeature = defineFeature("org", (r) => { const team = r.entity(teamEntity); const member = r.entity(memberEntity);
r.relation({ entity: team, name: "members", type: "hasMany", target: "member", foreignKey: "teamId", onDelete: "restrict", });
r.relation({ entity: member, name: "tasks", type: "hasMany", target: "task", foreignKey: "memberId", onDelete: "cascade", });
// onDelete runs automatically in the delete lifecycle: deleting a team is refused while // members exist, deleting a member removes its tasks. r.crud(teamEntity, { write: adminWrite, verbs: createAndDelete, registerEntity: false, }); r.crud(memberEntity, { write: adminWrite, verbs: createAndDelete, registerEntity: false, }); r.crud(taskEntity, { write: adminWrite, read: openRead, verbs: { ...createOnly, detail: true }, });});📄 On GitHub: samples/recipes/relations/src/feature.ts