Overview
The Model Reference section provides detailed specifications for defining your Data Vault models using Stream2Vault's YAML-based configuration. Each page outlines the structure, properties, and usage for different Data Vault object types and related configurations.
Key Considerations for S2V YAML Models:
Before diving into specific Data Vault objects like Hubs or Links, it's highly recommended to familiarize yourself with the common YAML structures and properties that are shared across multiple entity types. These are detailed in the YAML Properties section, covering:
- Shared Properties: Common attributes like
name,entity_type, andenable_refresh. - Entity Sources Definition: The standard way to define data sources.
- Business Key & Lookup Mappings: How source columns are mapped to target business keys or used for lookups.
Understanding these foundational elements first will make the definitions for individual Data Vault objects much clearer.
General Principles:
- Structured Templates: Each Data Vault object type (e.g., Hub, Link, Satellite) has a specific YAML template. These templates are designed to be intuitive, generally guiding you from high-level object definition (like its name and type) down to specific source mappings (how data is acquired for the object).
- Defined Properties: Only properties specified in the documentation for each object type are permissible within its YAML definition. Stream2Vault validates your model files against these defined structures to ensure correctness.
- Building on Shared Concepts: The definitions for Hubs, Links, Satellites, and References will refer back to and utilize the shared properties and structures mentioned above.
Use this Model Reference section as your primary resource for understanding how to construct valid and effective S2V models. It will help you understand the expected YAML structure for: