TTenantInfo Record
Snapshot of the catalog information of a tenant: identity, shard routing, status and application-defined metadata.
Syntax
Unit: Aurelius.Tenancy.Types
TTenantInfo = record;Fields
| Name | Description |
|---|---|
| DisplayName | Human-readable name of the tenant. |
| Metadata | Free-form, application-defined metadata (typically JSON). |
| ShardId | The id of the shard database that hosts the tenant's data. |
| Status | The lifecycle status of the tenant. |
| TenantId | The unique tenant identifier, used in routing, filters and claims. |
| Version | Version counter, incremented by the catalog on every change to the tenant record. Can be used as a cache token. |
Methods
| Name | Description |
|---|---|
| Empty | Returns an empty TTenantInfo record, used to represent an unknown tenant. |
| IsActive | Indicates whether the tenant status is Active. |
| IsEmpty | Indicates whether the record is empty (no tenant). |