Skip to content

title: "Tables" description: "A table defines an entity type in the system." It represents a collection of rows where each row corresponds to one instance of that entity.


Tables

Definition

A table defines an entity type in the system.
It represents a collection of rows where each row corresponds to one instance of that entity.

A table is a schema-level configuration object that controls:

  • how information is stored
  • how records are created
  • how the entity appears in navigation
  • how it is exposed through integrations
  • how forms and lists are generated

When a table is created, history tracking (audit logging) is automatically enabled for that table. All changes to rows in the table are therefore recorded and can later be inspected through the audit system.

Configuration fields

Each table defines the following configuration properties.

Name

Human-readable labels used throughout the interface.

Field Description
Singular name Label used when referring to a single record
Plural name Label used when referring to multiple records

These names are used in forms, navigation, and record views.

API name

Identifiers used when interacting with the API.

Field Description
Singular API name Identifier used for a single entity
Plural API name Identifier used for collections

Constraints:

  • Must be unique across all tables
  • Allowed characters: a–z, 0–9, _
  • Must be lowercase
  • Cannot start with a number

Description

Optional text describing the purpose of the table.

Used as documentation for administrators.

Tags

Tags define labels used in the mobile navigation.

These labels group tables and allow filtering of entity types when browsing the mobile interface.

Behavior:

  • Tags appear as labels in the mobile navigation
  • Tables without tags are not visible in mobile table navigation

Options table

Marks the table as a static value table.

Behavior:

  • Editable only by administrators
  • Used as a dropdown source in other tables

Typical examples include values such as gender, country, or status types.

These tables normally contain a small and rarely changing set of rows.

Main entity table

Marks the table as a primary entity type.

Behavior:

  • Appears in the mobile Add menu
  • Allows users to create records of this type directly

Tables without this setting enabled cannot be created directly from the mobile interface.

System columns

Every table automatically includes the following system-managed columns.

Column Type Description
id serial4 Internal primary key
sys_ins timestamptz Creation timestamp
sys_up timestamptz Last update timestamp
sys_usr int4 User that performed the last modification
_id text Optional external identifier used for imports
sys_tbl int4 Internal table identifier

These columns are always present and cannot be removed.

_id column

The _id column is used for external identifiers during data import.

Behavior:

  • Nullable
  • Can only be set through file import
  • Not editable through normal system operations

Column and relation ordering

Each table defines an explicit order for its columns and relations.

This ordering affects:

  • automatically generated forms
  • list views

The order does not affect database structure or API responses.

Modification

Table configuration can be modified after creation.

The following properties may be changed:

  • names
  • API names
  • description
  • tags
  • options table setting
  • main entity table setting

Changes apply immediately to the system configuration.

Deletion

Tables can be deleted.

Deletion behavior:

  • no cascading delete
  • no soft delete
  • removal is immediate

Deleting a table permanently removes the table and its configuration.

Tables interact with several other system components.

Component Relationship
Columns Define the attributes stored in each row
Relations Connect records across tables
Classifications Evaluate conditions based on table data
Permissions Control access to table records
Interface Generates forms and lists from table structure
Integrations Exposes table data through APIs and imports

Understand the concept