Skip to content

Data & Event Platform — data model

Generated from the architecture model

This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.

EnvelopeRegistryService

erDiagram
    TopicDefinition {
        string topic PK
        string context
        string area
        int version
        string eventName
        string producer
        list_string consumers
        string currentSchemaVersion
        enum_TopicState state
        datetime registeredAt
    }
    EnvelopeProfile {
        enum_MessagingProfile profile PK
        string envelopeSchemaVersion
        json transportProperties
        json outboxContract
        json inboxContract
        int dedupWindowHours
        bool active
    }
    SchemaVersion {
        string version

        string schemaRef

        enum_Compatibility compatibility

        datetime publishedAt

        datetime deprecatedAt

    }
    TopicDefinition ||--o{ SchemaVersion : contains
Hold "Alt" / "Option" to enable pan & zoom

SchemaVersion (entity)

One payload schema version with its JSON Schema reference and compatibility against the previous.

Field Type Required Description
version string yes
schemaRef string yes
compatibility enum:Compatibility yes
publishedAt datetime yes
deprecatedAt datetime no

Tables: dbo.Topics, dbo.SchemaVersions, dbo.TopicConsumers, dbo.EnvelopeProfiles — see the DDL appendix.

StoreProfileService

erDiagram
    StoreProfile {
        string profileId PK
        enum_StoreClass storeClass
        string topology
        string engine
        string adapterLibrary
        string migrationConvention
        int rpoMinutes
        int rtoMinutes
        string encryption
        bool authoritative
    }
    StoreBinding {
        string storeId PK
        string tenantId
        string ownerService
        string profileId
        string region
        string keyReference
        enum_BindingState state
        list_string schemas
    }
Hold "Alt" / "Option" to enable pan & zoom

Tables: dbo.StoreProfiles, dbo.StoreBindings — see the DDL appendix.

RetentionResidencyService

erDiagram
    RetentionRule {
        guid ruleId PK
        string tenantId
        string storeClass
        string classification
        int retentionDays
        string expiryAction
        bool legalHoldExempt
        bool active
    }
    ResidencyRule {
        string tenantId PK
        string region
        list_string allowedRegions
        json allowedEngines
        string modelDataResidency
        datetime changedAt
    }
    GovernanceOrder {
        guid orderId PK
        string tenantId
        enum_OrderKind kind
        json scope
        string issuedBy
        guid approvalId
        enum_OrderState state
        json tasks
        datetime dueAt
        datetime completedAt
        string exportRef
    }
Hold "Alt" / "Option" to enable pan & zoom

Tables: dbo.RetentionRules, dbo.ResidencyRules, dbo.GovernanceOrders, dbo.GovernanceOrderTasks — see the DDL appendix.