# scalefreecom/datavault4dbt architecture

> Architecture diagram of the GitHub repository scalefreecom/datavault4dbt, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/scalefreecom/datavault4dbt
- Repository: https://github.com/scalefreecom/datavault4dbt

## Overview

datavault4dbt is a dbt macro package for building Data Vault 2.0 warehouses. A data engineer supplies flat, wide source data and configures dbt models; the macros support staging transformations and generate vault and business-vault structures in the target database. The README documents these capabilities, but no source excerpts were provided, so links show documented usage rather than implementation-level calls or a verified execution sequence.

Main entry points: [`macros/staging/stage.sql`](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/staging/stage.sql) (Staging Macros), [`macros/tables/hub.sql`](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/hub.sql) (Hubs), [`macros/tables/link.sql`](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/link.sql) (Links), [`macros/tables/sat_v0.sql`](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/sat_v0.sql) (Satellites)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_staging["Staging"]
  node_staging_macros["Staging Macros<br/>[stage.sql]"]
  node_staging_helpers["Staging Helpers"]
  node_metadata["Metadata Processing"]
end

subgraph group_core_vault["Core Vault"]
  node_hubs["Hubs<br/>[hub.sql]"]
  node_links["Links<br/>[link.sql]"]
  node_satellites["Satellites<br/>[sat_v0.sql]"]
  node_nonhistorized["Non-Historized Entities<br/>[nh_link.sql]"]
  node_multi_active["Multi-Active Satellites<br/>[ma_sat_v0.sql]"]
  node_effectivity_tracking["Effectivity &amp; Tracking<br/>[eff_sat_v0.sql]"]
end

subgraph group_reference["Reference Data"]
  node_reference_hub["Reference Hubs<br/>[ref_hub.sql]"]
  node_reference_sat["Reference Satellites<br/>[ref_sat_v0.sql]"]
  node_reference_tables["Reference Tables<br/>[ref_table.sql]"]
end

subgraph group_business["Business Vault"]
  node_pit["PIT Tables<br/>[pit.sql]"]
  node_snapshot_control["Snapshot Control"]
end

node_engineer(("Data Engineer"))
node_source_data[("Source Data")]
node_warehouse[("Target Database")]

node_engineer -->|"uses macros"| node_staging_macros
node_source_data -->|"provides inputs"| node_staging_macros
node_engineer -->|"uses macros"| node_hubs
node_engineer -->|"uses macros"| node_links
node_engineer -->|"uses macros"| node_satellites
node_engineer -->|"uses macros"| node_nonhistorized
node_engineer -->|"uses macros"| node_multi_active
node_engineer -->|"uses macros"| node_effectivity_tracking
node_engineer -->|"uses macros"| node_reference_hub
node_engineer -->|"uses macros"| node_reference_sat
node_engineer -->|"uses macros"| node_reference_tables
node_engineer -->|"uses macros"| node_pit
node_engineer -->|"uses macros"| node_snapshot_control
node_staging_macros -->|"builds staging"| node_warehouse
node_hubs -->|"creates entities"| node_warehouse
node_links -->|"creates entities"| node_warehouse
node_satellites -->|"creates entities"| node_warehouse
node_nonhistorized -->|"creates entities"| node_warehouse
node_multi_active -->|"creates entities"| node_warehouse
node_effectivity_tracking -->|"creates entities"| node_warehouse
node_reference_hub -->|"creates entities"| node_warehouse
node_reference_sat -->|"creates entities"| node_warehouse
node_reference_tables -->|"creates entities"| node_warehouse
node_pit -->|"creates tables"| node_warehouse
node_snapshot_control -->|"creates snapshots"| node_warehouse

click node_staging_macros "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/staging/stage.sql"
click node_staging_helpers "https://github.com/scalefreecom/datavault4dbt/tree/main/macros/staging"
click node_metadata "https://github.com/scalefreecom/datavault4dbt/tree/main/macros/internal/metadata_processing"
click node_hubs "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/hub.sql"
click node_links "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/link.sql"
click node_satellites "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/sat_v0.sql"
click node_nonhistorized "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/nh_link.sql"
click node_multi_active "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/ma_sat_v0.sql"
click node_effectivity_tracking "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/eff_sat_v0.sql"
click node_reference_hub "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/ref_hub.sql"
click node_reference_sat "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/ref_sat_v0.sql"
click node_reference_tables "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/ref_table.sql"
click node_pit "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/pit.sql"
click node_snapshot_control "https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/control_snap_v0.sql"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_staging_macros,node_staging_helpers,node_metadata toneBlue
class node_hubs,node_links,node_satellites,node_nonhistorized,node_multi_active,node_effectivity_tracking,node_source_data,node_warehouse toneAmber
class node_reference_hub,node_reference_sat,node_reference_tables toneMint
class node_pit,node_snapshot_control toneRose
class node_engineer toneIndigo
```

## Components

### Staging

- [Staging Macros](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/staging/stage.sql): `macros/staging/stage.sql`
- [Staging Helpers](https://github.com/scalefreecom/datavault4dbt/tree/main/macros/staging): `macros/staging`
- [Metadata Processing](https://github.com/scalefreecom/datavault4dbt/tree/main/macros/internal/metadata_processing): `macros/internal/metadata_processing`

### Core Vault

- [Hubs](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/hub.sql): `macros/tables/hub.sql`
- [Links](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/link.sql): `macros/tables/link.sql`
- [Satellites](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/sat_v0.sql): `macros/tables/sat_v0.sql`
- [Non-Historized Entities](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/nh_link.sql): `macros/tables/nh_link.sql`
- [Multi-Active Satellites](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/ma_sat_v0.sql): `macros/tables/ma_sat_v0.sql`
- [Effectivity & Tracking](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/eff_sat_v0.sql): `macros/tables/eff_sat_v0.sql`

### Reference Data

- [Reference Hubs](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/ref_hub.sql): `macros/tables/ref_hub.sql`
- [Reference Satellites](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/ref_sat_v0.sql): `macros/tables/ref_sat_v0.sql`
- [Reference Tables](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/ref_table.sql): `macros/tables/ref_table.sql`

### Business Vault

- [PIT Tables](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/pit.sql): `macros/tables/pit.sql`
- [Snapshot Control](https://github.com/scalefreecom/datavault4dbt/blob/main/macros/tables/control_snap_v0.sql): `macros/tables/control_snap_v0.sql`

### Other components

- **Data Engineer**
- **Source Data**
- **Target Database**

## Connections

- Data Engineer → Staging Macros: uses macros (evidence: `README.md`)
- Source Data → Staging Macros: provides inputs (evidence: `README.md`)
- Data Engineer → Hubs: uses macros (evidence: `README.md`)
- Data Engineer → Links: uses macros (evidence: `README.md`)
- Data Engineer → Satellites: uses macros (evidence: `README.md`)
- Data Engineer → Non-Historized Entities: uses macros (evidence: `README.md`)
- Data Engineer → Multi-Active Satellites: uses macros (evidence: `README.md`)
- Data Engineer → Effectivity & Tracking: uses macros (evidence: `README.md`)
- Data Engineer → Reference Hubs: uses macros (evidence: `README.md`)
- Data Engineer → Reference Satellites: uses macros (evidence: `README.md`)
- Data Engineer → Reference Tables: uses macros (evidence: `README.md`)
- Data Engineer → PIT Tables: uses macros (evidence: `README.md`)
- Data Engineer → Snapshot Control: uses macros (evidence: `README.md`)
- Staging Macros → Target Database: builds staging (evidence: `README.md`)
- Hubs → Target Database: creates entities (evidence: `README.md`)
- Links → Target Database: creates entities (evidence: `README.md`)
- Satellites → Target Database: creates entities (evidence: `README.md`)
- Non-Historized Entities → Target Database: creates entities (evidence: `README.md`)
- Multi-Active Satellites → Target Database: creates entities (evidence: `README.md`)
- Effectivity & Tracking → Target Database: creates entities (evidence: `README.md`)
- Reference Hubs → Target Database: creates entities (evidence: `README.md`)
- Reference Satellites → Target Database: creates entities (evidence: `README.md`)
- Reference Tables → Target Database: creates entities (evidence: `README.md`)
- PIT Tables → Target Database: creates tables (evidence: `README.md`)
- Snapshot Control → Target Database: creates snapshots (evidence: `README.md`)
