entities

Not run in this build

entity.storage — an entity declared with ‘storage: dynamic’ is not created: this build has no dynamic schema-registry driver (planned, #41), so the entity gets no table, no Data API route and no records, and the apply drops it without refusing it

entity.realtime — no change is published over a realtime channel, because this build has none (planned, #38) — whatever an entity’s ‘realtime’ says, and its default is true, nothing is sent and nothing can subscribe

Refused at apply

entity.softDelete — Soft delete is not supported yet: a delete would remove the row outright and reads would not exclude it, which is irrecoverable data loss where the schema promises recoverability. Fix: Remove ‘softDelete’ or track the soft-delete implementation issue. A flag written as false is not a declaration and maps normally.

Guide: Entities and fields

The entities block spans these pages: entities · entities · fields · entities · computed & rollups · entities · rules · entities · hooks · entities · indexes.

entities

Entity definitions. Key = entity name (snake_case, plural recommended). Each entity auto-generates a CRUD API, validation, and a schema registry record. The name users is reserved (the built-in auth entity).

• Type: map of object
• Required: yes
• Names match ^[a-z][a-z0-9_]{0,62}$.
• Reserved name: users is not allowed.

Keys

entities.<name>.description

Human-readable description of the entity (surfaced to agents and in the admin UI).

• Type: string
• Required: no

entities.<name>.renamedFrom

Previous name of this entity: declares a rename so apply preserves data instead of drop+add. Safe to leave permanently; ignored once the old name no longer exists.

• Type: string
• Required: no
• Pattern: ^[a-z][a-z0-9_-]{0,62}$

entities.<name>.storage

physical = a real table (introspected/migrated); dynamic = the shared metadata-driven store (no DDL, instant apply). Everything above the registry treats both identically.

• Type: string
• Required: no
• Values: "physical", "dynamic"
• Default: "physical"

entities.<name>.tenancy

scoped = rows carry tenant_id and are isolated per tenant (default when tenancy.enabled); global = shared reference data (číselník) visible to all tenants.

• Type: string
• Required: no
• Values: "scoped", "global"

entities.<name>.softDelete

Framework-managed soft delete: a managed deleted_at column, DELETE becomes a soft delete, and reads/list/get/rollup auto-exclude soft-deleted rows. A restore operation is provided.

• Type: boolean
• Required: no
• Default: false

entities.<name>.audit

Inject framework-managed audit columns: created_at, created_by, updated_at, updated_by.

• Type: boolean
• Required: no
• Default: false

entities.<name>.realtime

Publish changes over the realtime channel (with subject-level authz).

• Type: boolean
• Required: no
• Default: true