Entities
An entity represents a data table in your application. Each entity generates a database table, API endpoints (CRUD), and UI pages (list, form, view).
Entity properties
| Property | Description |
|---|---|
| name | Singular name used in code. Must be camelCase (e.g., blogPost). |
| namePlural | Plural name used in code (e.g., blogPosts). |
| label | Singular display label shown in the UI (e.g., "Blog post"). |
| labelPlural | Plural display label (e.g., "Blog posts"). |
| icon | Lucide icon name for navigation and headers. |
| sortOrder | Controls the order entities appear in navigation. |
| position | Visual {x, y} position on the modeling canvas. |
Entity settings
- Display field — the field used to represent this entity in dropdowns, links, and autocompletes. Typically the main name or title field.
- Archivable — when enabled, deleting a record archives it (soft-delete) instead of permanently removing it. Archived records can be restored.
- Show audit fields on list — when enabled,
createdAt,updatedAt,createdBy, andupdatedBycolumns appear in the list/table view.
Naming rules
- Entity names must be camelCase and singular (e.g.,
projectTask, notProjectTasks). - Plural names should follow standard English pluralization.
- Labels use sentence case (e.g., "Project task", not "Project Task").
Protected names
Certain names are reserved for internal use (e.g., user, organization, session, file, auth). The modeling tool validates entity names automatically and will show an error if you use a protected name.