Skip to main content

DomainTableInfo

Defined in: js-api/src/domains.ts:203

Registry metadata of one domain table (see grok.dapi.domains.registry).

Properties

PropertyTypeDescriptionDefined in
auditboolean-js-api/src/domains.ts:213
businessKeystring[]Natural-key columns; empty when the table declares none.js-api/src/domains.ts:207
childTablesDomainChildTableRef[]-js-api/src/domains.ts:216
descriptionstring | nullWhat the table holds, as declared in schema.json; null when undeclared.js-api/src/domains.ts:215
nameColumnstring | nullPrimary display-name column; null when the table declares none.js-api/src/domains.ts:205
pluralNamestringEffective plural display name (declared, else derived from the table name).js-api/src/domains.ts:211
securityMode"table" | "master" | "row"-js-api/src/domains.ts:212
singularNamestringEffective singular display name (declared, else derived from the table name).js-api/src/domains.ts:209