Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add callout for net new snapshots #6521

Open
wants to merge 26 commits into
base: current
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
befa7b5
add callout for net new
mirnawong1 Nov 21, 2024
0697083
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 25, 2024
0ff5771
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 25, 2024
4127104
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 25, 2024
5a736c5
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 25, 2024
6746196
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 25, 2024
64d56e2
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 25, 2024
0347fd3
turn to snippet
mirnawong1 Nov 25, 2024
576af99
Update website/docs/reference/snapshot-configs.md
mirnawong1 Nov 25, 2024
2532cad
update grace feedback
mirnawong1 Nov 25, 2024
472d5c0
update'
mirnawong1 Nov 25, 2024
eee70d8
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 26, 2024
02fd890
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 26, 2024
1ca7c4e
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 26, 2024
43386c6
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 26, 2024
832ef12
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 26, 2024
91c3bb9
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 27, 2024
14690e0
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 27, 2024
7e68e91
update to snapshot configs
mirnawong1 Nov 27, 2024
6d2a38d
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 27, 2024
38762c1
Update website/docs/reference/snapshot-configs.md
mirnawong1 Nov 27, 2024
bdf2850
Update website/docs/reference/snapshot-configs.md
mirnawong1 Nov 27, 2024
6a84a7f
Update website/docs/reference/snapshot-configs.md
mirnawong1 Nov 27, 2024
37efd7a
Update website/snippets/_snapshots-yaml-config.md
mirnawong1 Nov 27, 2024
7eb3bf1
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 27, 2024
2fba6cc
Merge branch 'current' into net-new-snapshots
mirnawong1 Nov 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions website/docs/reference/snapshot-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,13 @@ meta:

import ConfigResource from '/snippets/_config-description-resource.md';
import ConfigGeneral from '/snippets/_config-description-general.md';
import SnapshotsYamlConfig from '/snippets/_snapshots-yaml-config.md';


## Related documentation
* [Snapshots](/docs/build/snapshots)
* The `dbt snapshot` [command](/reference/commands/snapshot)

<!--
Parts of a snapshot:
- name
- query
-->

## Available configurations
### Snapshot-specific configurations
Expand Down Expand Up @@ -125,7 +121,8 @@ snapshots:

<VersionBlock firstVersion="1.9">

Configurations can be applied to snapshots using the [YAML syntax](/docs/build/snapshots), available in Versionless and dbt v1.9 and higher, in the `snapshot` directory file.
<SnapshotsYamlConfig />


</VersionBlock>

Expand Down Expand Up @@ -155,6 +152,17 @@ Configurations can be applied to snapshots using the [YAML syntax](/docs/build/s

<ConfigGeneral />

:::tip
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

Configuring snapshots in YAML is recommended for new snapshots. If you have existing snapshots using the `.sql` config, they'll continue to work as expected. When you're ready to migrate to YAML, we recommend:
1. Creating a backup copy of your snapshots (or using version control)
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
2. Converting the configurations one at a time, testing as you go
3. Using `alter` statements as needed to ensure table consistency or using a script to apply the `alter` statements
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

The YAML configuration offers improved maintainability and consistency, but there's no pressure to migrate existing snapshots immediately &mdash; feel free to do so at your own pace while ensuring data quality is maintained.
:::


<Tabs
groupId="config-languages"
defaultValue="project-yaml"
Expand All @@ -170,6 +178,7 @@ Configurations can be applied to snapshots using the [YAML syntax](/docs/build/s

<VersionBlock firstVersion="1.9">


```yaml
snapshots:
[<resource-path>](/reference/resource-configs/resource-path):
Expand Down Expand Up @@ -256,7 +265,7 @@ snapshots:

<VersionBlock firstVersion="1.9">

Configurations can be applied to snapshots using [YAML syntax](/docs/build/snapshots), available in Versionless and dbt v1.9 and higher, in the `snapshot` directory file.
<SnapshotsYamlConfig />

</VersionBlock>

Expand Down
2 changes: 2 additions & 0 deletions website/snippets/_snapshots-yaml-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Configurations can be applied to snapshots using the [YAML syntax](/docs/build/snapshots#configuring-snapshots), available in Versionless and dbt v1.9 and higher, in the `snapshot` directory file.

Check warning on line 1 in website/snippets/_snapshots-yaml-config.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/snippets/_snapshots-yaml-config.md#L1

[custom.Typos] Oops there's a typo -- did you really mean 'v1.9'?
Raw output
{"message": "[custom.Typos] Oops there's a typo -- did you really mean 'v1.9'? ", "location": {"path": "website/snippets/_snapshots-yaml-config.md", "range": {"start": {"line": 1, "column": 147}}}, "severity": "WARNING"}

Loading