Skip to content

Commit 5483bdc

Browse files
sdebruynclaude
andcommitted
Add dbt_artifacts package docs page
Documents the package, dispatch config, required +file_format: delta setting, dbt-utils dependency, and the on-run-end upload hook. Notes Lakehouse compatibility (integration-tested) and links to upstream PR brooklyn-data/dbt_artifacts#529 for Synapse/Fabric DW support. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent bf45c64 commit 5483bdc

3 files changed

Lines changed: 49 additions & 0 deletions

File tree

docs/packages/dbt-artifacts.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# dbt_artifacts
2+
3+
**Tested version:** 2.10.1 | **Integration tested:** Yes (Lakehouse only)
4+
5+
[dbt_artifacts](https://github.com/brooklyn-data/dbt_artifacts) persists dbt run metadata (model runs, test results, sources, exposures, seeds, snapshots) into tables in your warehouse so you can query and monitor your project's execution history.
6+
7+
## Compute engine support
8+
9+
| Compute engine | Status |
10+
|---|---|
11+
| Lakehouse (FabricSpark) | :white_check_mark: Tested |
12+
| Data Warehouse (Fabric) | :x: Not compatible — upstream PR [brooklyn-data/dbt_artifacts#529](https://github.com/brooklyn-data/dbt_artifacts/pull/529) adds Synapse and Fabric DW support |
13+
14+
## Dispatch configuration
15+
16+
```yaml
17+
dispatch:
18+
- macro_namespace: dbt_artifacts
19+
search_order: ['your_project_name', 'dbt', 'dbt_artifacts']
20+
- macro_namespace: dbt_utils
21+
search_order: ['your_project_name', 'dbt', 'dbt_utils']
22+
```
23+
24+
## Required project configuration
25+
26+
dbt_artifacts must use the `delta` file format on Lakehouse, otherwise the on-run-end hooks fail to insert rows.
27+
28+
```yaml
29+
models:
30+
dbt_artifacts:
31+
+file_format: delta
32+
```
33+
34+
## Macro compatibility
35+
36+
All dbt_artifacts macros work on Lakehouse without adapter-specific overrides. The package targets Spark SQL via dbt-spark's macro implementations, which this adapter inherits.
37+
38+
## Notes
39+
40+
- Depends on [dbt-utils](dbt-utils.md). Include the dbt-utils dispatch configuration alongside the dbt_artifacts one.
41+
- Enable the package's on-run-end upload hooks by adding them to your `dbt_project.yml`:
42+
43+
```yaml
44+
on-run-end:
45+
- "{{ dbt_artifacts.upload_results(results) }}"
46+
```
47+
- For microbatch incremental models that store artifacts over time, configure `partition_by` on the timestamp column (the integration tests partition by `transaction_ts`).

docs/packages/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ The `dbt` entry in the search order tells dbt to check the adapter's built-in ma
6161
| [dbt-audit-helper](dbt-audit-helper.md) | 0.13.0 | :white_check_mark: Tested | :white_check_mark: Tested |
6262
| [dbt-external-tables](dbt-external-tables.md) | 0.11.0 | :white_check_mark: Tested | :x: Not applicable |
6363
| [dbt-profiler](dbt-profiler.md) | 1.0.0 | :white_check_mark: Tested | :white_check_mark: Tested |
64+
| [dbt_artifacts](dbt-artifacts.md) | 2.10.1 | :x: Not compatible ([upstream PR](https://github.com/brooklyn-data/dbt_artifacts/pull/529)) | :white_check_mark: Tested |
6465

6566
"Tested" means the adapter runs automated integration tests for that package on the given compute engine. "Via dbt-spark" means the package works through inherited dbt-spark macros without adapter-specific overrides.
6667

zensical.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ nav = [
4343
] },
4444
{ "Package support" = [
4545
{ "Overview" = "packages/index.md" },
46+
{ "dbt_artifacts" = "packages/dbt-artifacts.md" },
4647
{ "dbt-audit-helper" = "packages/dbt-audit-helper.md" },
4748
{ "dbt-codegen" = "packages/dbt-codegen.md" },
4849
{ "dbt-date" = "packages/dbt-date.md" },

0 commit comments

Comments
 (0)