New snapshot configs #5817

matthewshaver · 2024-07-22T14:36:04Z

What are you changing in this pull request and why?

[First round of updates]
Adds notes to the target_schema and target_database that the configs are optional
Snapshot page examples and tables updated with new examples and table configs

Checklist

Review the Content style guide so my content adheres to these guidelines.
For docs versioning, review how to version a whole page and version a block of content.
Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

Adding or removing pages (delete if not applicable):

Add/remove page in website/sidebars.js
Provide a unique filename for new pages
Add an entry for deleted pages in website/vercel.json
Run link testing locally with npm run build to update the links that point to deleted pages

vercel · 2024-07-22T14:36:09Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
docs-getdbt-com	✅ Ready (Inspect)	Visit Preview	Jul 25, 2024 7:27pm

website/docs/docs/build/snapshots.md

matthewshaver · 2024-07-22T14:38:04Z

website/docs/docs/build/snapshots.md

+| ------ | ----------- | --------- | ------- |
+| Config | Description | Required? | Example |
+| ------ | ----------- | --------- | ------- |
+| [database] | The database that dbt should render the snapshot table into | No | analytics |


Since the target_database and target_schema pages no longer apply, is there anything specific we want to link to here?

probably:

https://docs.getdbt.com/reference/resource-configs/database

https://docs.getdbt.com/reference/resource-configs/schema

website/docs/docs/build/snapshots.md

graciegoheen · 2024-07-22T14:38:08Z

website/docs/docs/build/snapshots.md

+{{
+    config(
+      unique_key='id',
+      schema='snapshots', // optional config. If not defined, the snapshot will use the `generate_schema_name` macro.


schema and database are the new configs that use the generate_schema_name / generate_database_name macros like other dbt resources

target_schema and target_database are the old configs

website/docs/docs/build/snapshots.md

graciegoheen · 2024-07-22T14:44:38Z

website/docs/reference/resource-configs/target_database.md

+
+:::warning Legacy configuration
+
+For environments on versionless dbt Cloud or dbt Core v1.9+, the `target_database` configuration is now optional. Best practices dictate that the `target_database` config should be removed from snapshots in the environment, in which case the snapshots will instead utilize the `generate_database_name` macro by default. Project snapshots configured with `target_schema` will continue to work as expected. 


I believe target_database has always been optional

website/docs/reference/resource-configs/target_database.md

graciegoheen · 2024-07-22T14:46:19Z

website/docs/faqs/Snapshots/snapshot-target-schema.md

+:::
+
+</VersionBlock>
+
 Snapshots build into the same `target_schema`, no matter who is running them.


Should we just remove this page all-together? This information is now out-dated

website/docs/reference/resource-configs/target_schema.md

graciegoheen · 2024-07-22T14:49:17Z

Could we also add snapshot config examples:

graciegoheen · 2024-07-22T14:52:44Z

Can we also make some updates to this page:

gshank · 2024-07-22T15:01:04Z

I think the doc changes are more work than the code changes were :). Looks like Grace has this pretty much handled.

dbeatty10 · 2024-07-22T15:02:34Z

I think the doc changes are more work than the code changes were :). Looks like Grace has this pretty much handled.

😂

graciegoheen · 2024-07-22T15:20:21Z

I think it may also be worth calling this out in a release note? Thoughts?

Co-authored-by: Grace Goheen <[email protected]>

website/docs/docs/build/snapshots.md

Co-authored-by: Grace Goheen <[email protected]>

website/docs/reference/resource-configs/target_schema.md

nghi-ly

looks good! left some minor nits

website/docs/docs/build/snapshots.md

website/docs/reference/resource-configs/database.md

website/docs/reference/resource-configs/schema.md

website/docs/reference/resource-configs/target_database.md

Co-authored-by: Ly Nguyen <[email protected]>

graciegoheen · 2024-07-24T18:28:00Z

website/docs/docs/build/snapshots.md

+
+</File>
+
+6. Run the `dbt snapshot` [command](/reference/commands/snapshot)  &mdash; for our example, a new table will be created at `analytics.snapshots.orders_snapshot`. The `schema` config will utilize the `generate_schema_name` macro.


Should we link to this page for the schema config mention https://docs.getdbt.com/reference/resource-configs/schema

website/docs/docs/build/snapshots.md

graciegoheen · 2024-07-24T18:39:30Z

website/docs/reference/resource-configs/clickhouse-configs.md

+</File>
+
+</VersionBlock>
+
 #### Snapshot Configuration

 | Option          | Description                                                                                                               | Required?                                                                            |


I don't think we need this table? It seems duplicative of the other table here -> https://docs.getdbt.com/docs/build/snapshots#snapshot-configurations

Sure, can remove and link to snapshots page instead!

graciegoheen · 2024-07-24T18:40:02Z

website/docs/reference/resource-configs/database.md

+
+<VersionBlock lastVersion="1.8">
+
+Available for versionless dbt Cloud or dbt Core v1.9+. Select v1.9 or newer from the version dropdown to view the configs.


Confirming are we calling this "versionless" or "Keep on latest version"? cc: @jtcohen6

Good question - we went back earlier this quarter and added "versionless" in front of every mention of "Keep on latest version" in the docs to tie the two ideas together but I'll defer to Jerco about how to handle the naming going forward

Oh if that's already added, then that works for me!

graciegoheen · 2024-07-24T18:41:08Z

website/docs/reference/resource-configs/target_database.md

@@ -4,6 +4,12 @@ description: "Target_database - Read this in-depth guide to learn about configur
 datatype: string
 ---

+:::note
+
+For [versionless](/docs/dbt-versions/core-upgrade/upgrading-to-v1.8#keep-on-latest-version) dbt Cloud accounts and dbt Core v1.9+, this functionality is no longer utilized. Use the [database](/reference/resource-configs/database) config as an alternative to define a custom database while still respecting the `generate_database_name` macro. 


same question on "versionless"

graciegoheen · 2024-07-24T18:41:12Z

website/docs/reference/resource-configs/schema.md

+
+<VersionBlock lastVersion="1.8">
+
+Available for versionless dbt Cloud or dbt Core v1.9+. Select v1.9 or newer from the version dropdown to view the configs.


same question on "versionless"

graciegoheen · 2024-07-24T18:41:37Z

website/docs/reference/resource-configs/target_schema.md

@@ -4,6 +4,12 @@ description: "Target_schema - Read this in-depth guide to learn about configurat
 datatype: string
 ---

+:::note
+
+For [versionless](/docs/dbt-versions/core-upgrade/upgrading-to-v1.8#keep-on-latest-version) dbt Cloud accounts and dbt Core v1.9+, this functionality is no longer required. Use the [schema](/reference/resource-configs/schema) config as an alternative to define a custom schema while still respecting the `generate_schema_name` macro. 


same question on "versionless"

graciegoheen · 2024-07-24T18:42:15Z

Can we also make some updates to this page:

^ @matthewshaver just want to make sure we get these updates in as well!

website/docs/docs/build/snapshots.md

Co-authored-by: Grace Goheen <[email protected]>

Updating based on feedback

website/docs/reference/resource-configs/clickhouse-configs.md

Replacing table with link

… into snapshots

graciegoheen

Thank you for all of the work on this!

New snapshot configs

96514f8

matthewshaver requested a review from a team as a code owner July 22, 2024 14:36

github-actions bot added the content Improvements or additions to content label Jul 22, 2024

matthewshaver requested review from gshank and graciegoheen July 22, 2024 14:36

github-actions bot added Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address labels Jul 22, 2024

matthewshaver commented Jul 22, 2024

View reviewed changes

website/docs/docs/build/snapshots.md Show resolved Hide resolved

matthewshaver commented Jul 22, 2024

View reviewed changes

website/docs/docs/build/snapshots.md Outdated Show resolved Hide resolved

vercel bot deployed to Preview July 22, 2024 14:40 View deployment

graciegoheen requested changes Jul 22, 2024

View reviewed changes

graciegoheen requested a review from dbeatty10 July 22, 2024 14:55

Apply suggestions from code review

93e8554

Co-authored-by: Grace Goheen <[email protected]>

matthewshaver commented Jul 22, 2024

View reviewed changes

website/docs/docs/build/snapshots.md Outdated Show resolved Hide resolved

matthewshaver and others added 2 commits July 22, 2024 16:22

Apply suggestions from code review

d976574

Co-authored-by: Grace Goheen <[email protected]>

Information changes

2e52ce5

vercel bot deployed to Preview July 22, 2024 20:35 View deployment

Updates based on feedback

e937549

vercel bot deployed to Preview July 22, 2024 22:49 View deployment

matthewshaver commented Jul 22, 2024

View reviewed changes

website/docs/reference/resource-configs/target_schema.md Outdated Show resolved Hide resolved

Apply suggestions from code review

2e08340

vercel bot deployed to Preview July 22, 2024 23:09 View deployment

More updates based on feedback

166dc1f

vercel bot deployed to Preview July 24, 2024 15:33 View deployment

nghi-ly reviewed Jul 24, 2024

View reviewed changes

Apply suggestions from code review

2d31bbc

Co-authored-by: Ly Nguyen <[email protected]>

vercel bot deployed to Preview July 24, 2024 16:17 View deployment

nghi-ly approved these changes Jul 24, 2024

View reviewed changes

Merge branch 'current' into snapshots

3b0e078

vercel bot deployed to Preview July 24, 2024 16:26 View deployment

Merge branch 'current' into snapshots

11ba9ae

vercel bot deployed to Preview July 24, 2024 18:26 View deployment

graciegoheen requested changes Jul 24, 2024

View reviewed changes

matthewshaver commented Jul 24, 2024

View reviewed changes

website/docs/docs/build/snapshots.md Outdated Show resolved Hide resolved

matthewshaver and others added 4 commits July 24, 2024 14:48

Apply suggestions from code review

cc8a8c4

Co-authored-by: Grace Goheen <[email protected]>

Apply suggestions from code review

9d71062

Co-authored-by: Grace Goheen <[email protected]>

Update website/docs/docs/build/snapshots.md

b9c357e

Update debug-schema-names.md

b181eaf

Updating based on feedback

matthewshaver commented Jul 24, 2024

View reviewed changes

website/docs/reference/resource-configs/clickhouse-configs.md Outdated Show resolved Hide resolved

Update website/docs/reference/resource-configs/clickhouse-configs.md

2fb7f0b

vercel bot deployed to Preview July 24, 2024 19:07 View deployment

Update clickhouse-configs.md

cfa5dbb

Replacing table with link

vercel bot deployed to Preview July 25, 2024 18:05 View deployment

matthewshaver added 2 commits July 25, 2024 14:56

Adding new examples to config page

65b7d88

Merge branch 'snapshots' of https://github.com/dbt-labs/docs.getdbt.com…

766251f

… into snapshots

vercel bot deployed to Preview July 25, 2024 19:03 View deployment

graciegoheen approved these changes Jul 25, 2024

View reviewed changes

matthewshaver enabled auto-merge (squash) July 25, 2024 19:20

Merge branch 'current' into snapshots

79c2185

vercel bot deployed to Preview July 25, 2024 19:27 View deployment

matthewshaver merged commit b08aff4 into current Jul 25, 2024
10 checks passed

matthewshaver deleted the snapshots branch July 25, 2024 19:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New snapshot configs #5817

New snapshot configs #5817

matthewshaver commented Jul 22, 2024

vercel bot commented Jul 22, 2024 •

edited

Loading

matthewshaver Jul 22, 2024

graciegoheen Jul 22, 2024

graciegoheen Jul 22, 2024

graciegoheen Jul 22, 2024

gshank Jul 22, 2024

graciegoheen Jul 22, 2024

graciegoheen commented Jul 22, 2024

graciegoheen commented Jul 22, 2024

gshank commented Jul 22, 2024

dbeatty10 commented Jul 22, 2024

graciegoheen commented Jul 22, 2024

nghi-ly left a comment

graciegoheen Jul 24, 2024

graciegoheen Jul 24, 2024

matthewshaver Jul 24, 2024

graciegoheen Jul 24, 2024

matthewshaver Jul 24, 2024

graciegoheen Jul 24, 2024

graciegoheen Jul 24, 2024

graciegoheen Jul 24, 2024

graciegoheen Jul 24, 2024

graciegoheen commented Jul 24, 2024 •

edited

Loading

graciegoheen left a comment


		:::warning Legacy configuration

		For environments on versionless dbt Cloud or dbt Core v1.9+, the `target_database` configuration is now optional. Best practices dictate that the `target_database` config should be removed from snapshots in the environment, in which case the snapshots will instead utilize the `generate_database_name` macro by default. Project snapshots configured with `target_schema` will continue to work as expected.


		</File>

		6. Run the `dbt snapshot` [command](/reference/commands/snapshot) — for our example, a new table will be created at `analytics.snapshots.orders_snapshot`. The `schema` config will utilize the `generate_schema_name` macro.


		<VersionBlock lastVersion="1.8">

		Available for versionless dbt Cloud or dbt Core v1.9+. Select v1.9 or newer from the version dropdown to view the configs.

New snapshot configs #5817

New snapshot configs #5817

Conversation

matthewshaver commented Jul 22, 2024

What are you changing in this pull request and why?

Checklist

vercel bot commented Jul 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

graciegoheen commented Jul 22, 2024

graciegoheen commented Jul 22, 2024

gshank commented Jul 22, 2024

dbeatty10 commented Jul 22, 2024

graciegoheen commented Jul 22, 2024

nghi-ly left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

graciegoheen commented Jul 24, 2024 • edited Loading

graciegoheen left a comment

Choose a reason for hiding this comment

vercel bot commented Jul 22, 2024 •

edited

Loading

graciegoheen commented Jul 24, 2024 •

edited

Loading