DomainTableInfo
Defined in: js-api/src/domains.ts:938
Registry metadata of one domain table (see grok.dapi.domains.registry).
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
audit | boolean | Whether writes leave an in-transaction audit trail. | js-api/src/domains.ts:959 |
businessKey | string[] | Natural-key columns; empty when the table declares none. | js-api/src/domains.ts:942 |
childTables | DomainChildTableRef[] | The tables whose foreign keys point at this one. | js-api/src/domains.ts:969 |
constraints | object[] | Declared table constraints (constraints in schema.json), in declaration order. | js-api/src/domains.ts:974 |
description | string | null | What the table holds, as declared in schema.json; null when undeclared. | js-api/src/domains.ts:967 |
friendlyName? | string | The DECLARED friendlyName (friendlyName in schema.json); undefined when the table declares none — unlike singularName/pluralName, nothing is derived here, so the caller can tell a chosen label apart from the capitalized table name. | js-api/src/domains.ts:951 |
hierarchy | boolean | The table declares a tree (hierarchy in schema.json): exactly one ref column targets the table itself, and DomainTableClient.pathTo / the under filter term walk it. | js-api/src/domains.ts:963 |
nameColumn | string | null | Primary display-name column; null when the table declares none. | js-api/src/domains.ts:940 |
parentColumn | string | null | The self-referencing column the tree is built on; null off a hierarchy table. | js-api/src/domains.ts:965 |
permissions | string[] | Custom permission names the table declares (permissions in schema.json). | js-api/src/domains.ts:979 |
pluralName | string | Effective plural display name (declared, else derived from the table name). | js-api/src/domains.ts:955 |
refFilters | object | Per ref column, the declared filter its candidates are narrowed by (a smart-filter string; $<column> binds a sibling value of the row being edited). | js-api/src/domains.ts:977 |
rowAddress | "id" | "businessKey" | How an app spells a row in a URL: 'businessKey' — the business-key values (a platform table); 'id' — the canonical row id as one opaque segment (an external table, whose key values may carry any delimiter). | js-api/src/domains.ts:946 |
searchableColumns | string[] | The columns DomainQuerySpec.search matches: those declared searchable: true, else the name column, else none. | js-api/src/domains.ts:972 |
securityMode | "table" | "row" | "master" | How rows are secured: by the table's own grants, a master row's, or each row's. | js-api/src/domains.ts:957 |
singularName | string | Effective singular display name (declared, else derived from the table name). | js-api/src/domains.ts:953 |