Embedding Schema Definitions

Data schemas often live in code or separate tools, invisible to anyone reading architecture documentation. Schema definition blocks embed your data models directly in documentation pages, making field definitions, types, and validation rules visible in context.

Why Embed Schemas

When schemas live only in code:

Creating Schema Definitions

NeoArc's Schema Editor lets you define data structures with:

Embedding a Schema

Schema Block Features

Embedded schema blocks display:

Example: Schemas with Data Lineage

The following schemas demonstrate data lineage tracking. Each field traces back to its source in either an ERD diagram or a graph database model:

ERD Lineage Example

This e-commerce Order schema has lineage entries pointing to tables and columns in a database ERD:

Graph Database Lineage Example

This healthcare Diagnosis schema has lineage entries pointing to nodes and properties in a graph domain model:

Example: Schema Inheritance

These schemas demonstrate inheritance, where a base entity schema is extended by domain schemas:

Example: Lineage Overrides

When schemas inherit from a base, they can override lineage for inherited fields. This path parameter schema extends a generic IdPathParam but overrides the Id field lineage to point to the healthcare graph:

Practical Patterns

Connecting to Data Lifecycle

Schema blocks pair well with data lifecycle blocks. The schema shows structure. The data lifecycle shows journey. Together they provide complete data documentation:

Schema Versioning

Because schemas live as files in your workspace:

Validation Rules

NeoArc schemas support validation rules that display in embedded blocks:

Throughout this documentation site, schemas are embedded alongside the content they relate to, keeping data models visible in context.

Next Steps