Skip to main content

DomainTableInfo

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

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

Properties

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