Database Metadata Registry
The database metadata registry is a self-documenting layer built into the platform. It stores human-readable descriptions, comments, and tags for the platform's data structures, giving administrators and developers a consistent place to document what each area of the platform contains and what its fields mean.
Purpose
As a platform grows, it becomes harder to keep track of what each part of the data model represents — especially when multiple teams or integrations need to understand the same structures. The metadata registry solves this by providing a central, curated catalogue of descriptions attached directly to platform entities.
Rather than relying on external spreadsheets or scattered notes, administrators can record the meaning and intent of each entity and its fields in one place. This information is then available across the platform to support documentation, data discovery, and operational understanding.
What the registry captures
Each entry in the registry describes a specific piece of the platform's data model. The following attributes can be recorded for each entry:
| Attribute | Purpose |
|---|---|
| Schema area | The high-level domain or module the entity belongs to |
| Entity name | The name of the entity being described |
| Entity type | The kind of entity (for example, a data collection or a view) |
| Field name | The specific field within the entity, if the entry is field-level |
| Description | A human-readable explanation of what the entity or field represents |
| Comment | Additional notes or context that supplement the description |
| Tags | A list of labels that can be used to group or filter entries |
Entity-level entries describe the overall purpose of a data structure. Field-level entries go further and explain what a particular attribute within that structure contains or represents. Both levels can coexist for the same entity, giving a layered picture from the whole down to the individual field.
Admin-only access
Managing metadata registry entries is an administrator-only capability. Only platform administrators can create, update, or remove entries. This access control ensures that descriptions remain accurate and authoritative — they reflect deliberate, reviewed documentation rather than ad-hoc notes added by any user.
End users and operators can benefit from the metadata that administrators have recorded, but they cannot modify it.
Supporting data discovery
The metadata registry makes the platform more legible to the people who work with it. When a team member needs to understand what a particular area of the platform tracks, they can consult the registry rather than tracing through configuration or asking colleagues.
Tags play a specific role here: by labelling related entries with consistent tags, administrators can group conceptually related entities even when they span different schema areas. This makes it straightforward to find all entries relevant to, for example, a particular integration or business domain.
The registry also supports documentation workflows. When producing reference material or onboarding guides, having accurate, centrally managed descriptions reduces the effort required to keep that material current.
Related topics
- Data Model Overview — the structure of the platform's data model that the metadata registry describes
- Labels — how tags and labels work across the platform more broadly
- Tenants and Multi-Tenancy — how the platform is organised into tenants, which provides the context for schema areas