IF Commons GitHub

sql/typed/models/arca-tenancy.auto

The typed tables of the arcaTenancy model, generated by IFC Data from the model. Do not edit: change the model and run bun tools/typed.ts --write.

The boundaries that separate one customer's data from another's, and their hierarchy

Source: commons/data/sql/typed/models/arca-tenancy.auto.ts

0 of 4 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

arcaTenancynamespace
namespace arcaTenancy
arcaTenancy.TenantRowinterfaceno test imports it
interface TenantRow

A boundary that separates one customer's data from another's, in a hierarchy of boundaries

MemberTypeWhat it is
tenantIdstringWhat identifies the tenant, made by the application when it is created
kind"business" | "consumer_pool" | "platform" | "reseller"What the tenant is in the hierarchy
slugstringThe short name the tenant is addressed by, unique among tenants
displayNamestringThe name the tenant is shown by
ancestrystringThe path of the tenant's parents from the root, kept by the operation that moves a tenant, so that a subtree is one query
status"active" | "closed" | "suspended"Where the tenant is in its life
isolation"dedicated" | "shared"How much of the platform the tenant has to itself
createdAtTimestampWhen the tenant was made
organizationPartyIdstring | nullThe organization the tenant is for; a pool of consumers has none
parentTenantIdstring | nullThe tenant this one is under; the root has none
arcaTenancy.TenantInsertinterfaceno test imports it
interface TenantInsert

What an insert into tenant takes: what the database fills may be left out.

MemberTypeWhat it is
tenantIdstring
kind"business" | "consumer_pool" | "platform" | "reseller"
slugstring
displayNamestring
ancestrystring
status"active" | "closed" | "suspended"
isolation"dedicated" | "shared"
createdAtTimestamp
organizationPartyId?string | null
parentTenantId?string | null
arcaTenancy.TenantKeytypeno test imports it
type TenantKey = { readonly tenantId: string };

The key of a row of tenant.

arcaTenancy.tenantconstno test imports it
const tenant: Table<TenantRow, TenantInsert, "tenant">

A boundary that separates one customer's data from another's, in a hierarchy of boundaries

Titles, headings, exports, tables, columns and requirements. Esc closes.