Data Dictionary Block
Document data entities with field definitions, types, constraints, and relationships. Create complete data dictionaries for databases and APIs.
The Data Dictionary block documents data entities with their fields, types, constraints, and relationships. Use it to create complete data dictionaries for database tables, API payloads, or domain models.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Entity Name | Yes | Technical name (e.g., customer_orders) |
| Logical Name | No | Business name (e.g., Customer Orders) |
| Description | No | Purpose and usage of the entity |
| Owner | No | Data steward or owning team |
| Classification | No | Data sensitivity: Public, Internal, Confidential, or Restricted |
| Source | No | Origin system for the data |
| Fields | Yes | Array of field definitions |
| Relationships | No | Links to other entities |
| Validation Rules | No | Business rules for data integrity |
Field Properties
| Property | Required | Description |
|---|---|---|
| Name | Yes | Field name |
| Data Type | Yes | String, Integer, Decimal, Boolean, Date, UUID, etc. |
| Length | No | Size constraint (e.g., 255 for varchar) |
| Nullable | No | Whether null values are allowed |
| Default Value | No | Default if not provided |
| Description | No | Field purpose |
| Constraints | No | Rules (e.g., UNIQUE, FK, CHECK) |
| Example | No | Sample value |
Data Classification
Example: User Entity
A core user entity with standard fields.
Example: Order Entity
A transactional entity with foreign keys.
Editing Data Dictionaries
| Action | How To |
|---|---|
| Set Classification | Select from the classification dropdown with visual indicators |
| Add Field | Click Add Field and fill in the field properties |
| Edit Field | Expand the field details to edit constraints and examples |
| Remove Field | Click the delete button on individual fields |
| Preview | View the entity with field table and relationship details |