dbt-labs / dbt-labs/docs.getdbt.com

snapshot properties doc is misleading

Open
#7,029 0 comments 0 reactions 1 assignee Claimed by @matthewshaver View on GitHub
content improvement references-project size: large
Dominant language
JavaScript
Stars
215
Forks
1.2k
Avg merge
1d 15h
Merged PRs (30d)
130

Description

### Contributions

- [x] I have read the contribution docs, and understand what's expected of me.

### Link to the page on docs.getdbt.com requiring updates

https://docs.getdbt.com/reference/snapshot-properties

### What part(s) of the page would you like to see updated?

> In dbt v1.9 and later, snapshots are defined and configured in YAML files within your snapshots/ directory (as defined by the [snapshot-paths config](https://docs.getdbt.com/reference/project-configs/snapshot-paths)). Snapshot properties are declared within these YAML files, allowing you to define both the snapshot configurations and properties in one place.
>
> We recommend that you put them in the snapshots/ directory. You can name these files whatever_you_want.yml, and nest them arbitrarily deeply in subfolders within the snapshots/ or models/ directory.

These two sentences contradict each other. With the [new snapshot yml spec](https://docs.getdbt.com/docs/dbt-versions/core-upgrade/upgrading-to-v1.9#snapshots-improvements), you can define snapshots in yml files anywhere in your project.

The example also does not include the `relation:` property, which is required when using the new snapshot yml spec. There is no doc reference page for the `relation:` property.

### Additional information

_No response_

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.