ancestrytextrequiredThe path of the tenant's parents from the root, kept by the operation that moves a tenant, so that a subtree is one query
Becomes the column ancestry of tenant.
A boundary that separates one customer's data from another's, in a hierarchy of boundaries
Model arcaTenancy. Written in commons/data/models/arca-tenancy/tenancy.ts:70. Identified by tenantId.
ancestrytextrequiredThe path of the tenant's parents from the root, kept by the operation that moves a tenant, so that a subtree is one query
Becomes the column ancestry of tenant.
createdAtinstantrequiredWhen the tenant was made
Becomes the column created_at of tenant.
displayNametextrequiredThe name the tenant is shown by
Becomes the column display_name of tenant.
isolationcode of isolationrequiredHow much of the platform the tenant has to itself
Becomes the column isolation of tenant.
kindcode of tenantKindrequiredWhat the tenant is in the hierarchy
Becomes the column kind of tenant.
slugtextrequiredThe short name the tenant is addressed by, unique among tenants
Becomes the column slug of tenant.
statuscode of tenantStatusrequiredWhere the tenant is in its life
Becomes the column status of tenant.
tenantIdidentifierrequiredWhat identifies the tenant, made by the application when it is created
Becomes the column tenant_id of tenant.
organizationoptionalThe organization the tenant is for; a pool of consumers has none To organization. Written at commons/data/models/arca-tenancy/tenancy.ts:86
parentoptionalThe tenant this one is under; the root has none To tenant. Written at commons/data/models/arca-tenancy/tenancy.ts:90
Projects to the table tenant with the primary key tenant_id.
| Column | Type | Null | Role | From |
|---|---|---|---|---|
ancestry | text | false | attribute | tenant.ancestry |
created_at | timestamp | false | attribute | tenant.createdAt |
display_name | text | false | attribute | tenant.displayName |
isolation | text | false | attribute | tenant.isolation |
kind | text | false | attribute | tenant.kind |
organization_party_id | text | true | reference | tenant.organization |
parent_tenant_id | text | true | reference | tenant.parent |
slug | text | false | attribute | tenant.slug |
status | text | false | attribute | tenant.status |
tenant_id | text | false | attribute | tenant.tenantId |
CREATE TABLE IF NOT EXISTS "tenant" (
"tenant_id" VARCHAR NOT NULL PRIMARY KEY,
"kind" VARCHAR NOT NULL,
"slug" VARCHAR NOT NULL,
"display_name" VARCHAR NOT NULL,
"ancestry" VARCHAR NOT NULL,
"status" VARCHAR NOT NULL,
"isolation" VARCHAR NOT NULL,
"created_at" TIMESTAMPTZ NOT NULL,
"organization_party_id" VARCHAR,
"parent_tenant_id" VARCHAR,
CONSTRAINT "tenant_organization_party_id_fk" FOREIGN KEY ("organization_party_id") REFERENCES "organization" ("party_id"),
CONSTRAINT "tenant_parent_tenant_id_fk" FOREIGN KEY ("parent_tenant_id") REFERENCES "tenant" ("tenant_id"),
CONSTRAINT "tenant_slug_uq" UNIQUE ("slug"),
CONSTRAINT "tenant_kind_ck" CHECK ("kind" IN ('platform', 'reseller', 'business', 'consumer_pool')),
CONSTRAINT "tenant_status_ck" CHECK ("status" IN ('active', 'suspended', 'closed')),
CONSTRAINT "tenant_isolation_ck" CHECK ("isolation" IN ('shared', 'dedicated')),
CONSTRAINT "tenant_tenant_not_its_own_parent_ck" CHECK ("tenant_id" <> "parent_tenant_id")
);CREATE TABLE IF NOT EXISTS "tenant" (
"tenant_id" TEXT NOT NULL PRIMARY KEY,
"kind" TEXT NOT NULL,
"slug" TEXT NOT NULL,
"display_name" TEXT NOT NULL,
"ancestry" TEXT NOT NULL,
"status" TEXT NOT NULL,
"isolation" TEXT NOT NULL,
"created_at" TIMESTAMPTZ NOT NULL,
"organization_party_id" TEXT,
"parent_tenant_id" TEXT,
CONSTRAINT "tenant_organization_party_id_fk" FOREIGN KEY ("organization_party_id") REFERENCES "organization" ("party_id"),
CONSTRAINT "tenant_parent_tenant_id_fk" FOREIGN KEY ("parent_tenant_id") REFERENCES "tenant" ("tenant_id"),
CONSTRAINT "tenant_slug_uq" UNIQUE ("slug"),
CONSTRAINT "tenant_kind_ck" CHECK ("kind" IN ('platform', 'reseller', 'business', 'consumer_pool')),
CONSTRAINT "tenant_status_ck" CHECK ("status" IN ('active', 'suspended', 'closed')),
CONSTRAINT "tenant_isolation_ck" CHECK ("isolation" IN ('shared', 'dedicated')),
CONSTRAINT "tenant_tenant_not_its_own_parent_ck" CHECK ("tenant_id" <> "parent_tenant_id")
);CREATE TABLE IF NOT EXISTS "tenant" (
"tenant_id" TEXT NOT NULL PRIMARY KEY,
"kind" TEXT NOT NULL,
"slug" TEXT NOT NULL,
"display_name" TEXT NOT NULL,
"ancestry" TEXT NOT NULL,
"status" TEXT NOT NULL,
"isolation" TEXT NOT NULL,
"created_at" TEXT NOT NULL,
"organization_party_id" TEXT,
"parent_tenant_id" TEXT,
CONSTRAINT "tenant_organization_party_id_fk" FOREIGN KEY ("organization_party_id") REFERENCES "organization" ("party_id"),
CONSTRAINT "tenant_parent_tenant_id_fk" FOREIGN KEY ("parent_tenant_id") REFERENCES "tenant" ("tenant_id"),
CONSTRAINT "tenant_slug_uq" UNIQUE ("slug"),
CONSTRAINT "tenant_kind_ck" CHECK ("kind" IN ('platform', 'reseller', 'business', 'consumer_pool')),
CONSTRAINT "tenant_status_ck" CHECK ("status" IN ('active', 'suspended', 'closed')),
CONSTRAINT "tenant_isolation_ck" CHECK ("isolation" IN ('shared', 'dedicated')),
CONSTRAINT "tenant_tenant_not_its_own_parent_ck" CHECK ("tenant_id" <> "parent_tenant_id")
);Read and written from TypeScript with the types the model gives: import { tenant } from "@intellectual-frontiers/data/sql/typed/models". Generated in commons/data/sql/typed/models/arca-tenancy.auto.ts: do not edit.
import { from } from "@intellectual-frontiers/data/sql/typed";
import { tenant } from "@intellectual-frontiers/data/sql/typed/models";
const rows = await from(tenant).select((s) => ({ tenantId: s.tenant.tenantId, kind: s.tenant.kind })).run(runner);