Skip to main content

Snapshot properties

Snapshots properties can be declared in .yml files in:

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.

snapshots/<filename>.yml
version: 2

snapshots:
- name: <snapshot name>
description: <markdown_string>
meta: {<dictionary>}
docs:
show: true | false
node_color: <color_id> # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32")
config:
<snapshot_config>: <config_value>
tests:
- <test>
- ...
columns:
- name: <column name>
description: <markdown_string>
meta: {<dictionary>}
quote: true | false
tags: [<string>]
tests:
- <test>
- ... # declare additional tests
- ... # declare properties of additional columns

- name: ... # declare properties of additional snapshots

0