From befa7b52a03bdd47329bbef13efb03b3646af91a Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Thu, 21 Nov 2024 17:06:48 -0500 Subject: [PATCH 01/39] add callout for net new --- website/docs/reference/snapshot-configs.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index 7b3c0f8e5b1..22c5ebf86cc 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -13,11 +13,6 @@ import ConfigGeneral from '/snippets/_config-description-general.md'; * [Snapshots](/docs/build/snapshots) * The `dbt snapshot` [command](/reference/commands/snapshot) - ## Available configurations ### Snapshot-specific configurations @@ -125,7 +120,7 @@ snapshots: -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. +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. @@ -155,6 +150,17 @@ Configurations can be applied to snapshots using the [YAML syntax](/docs/build/s +:::tip + +Configuring snapshots in YAML is recommended for new snapshot configurations. 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) +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 + +The YAML configuration offers improved maintainability and consistency, but there's no pressure to migrate existing snapshots immediately — feel free to do so at your own pace while ensuring data quality is maintained. +::: + + + ```yaml snapshots: [](/reference/resource-configs/resource-path): @@ -256,7 +263,7 @@ snapshots: -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. +Configurations can be applied to snapshots using [YAML syntax](/docs/build/snapshots#configuring-snapshots), available in Versionless and dbt v1.9 and higher, in the `snapshot` directory file. From 0347fd3d174d81b5b738976b82a97e26e722bf66 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 25 Nov 2024 16:20:27 +0000 Subject: [PATCH 02/39] turn to snippet --- website/docs/reference/snapshot-configs.md | 6 ++++-- website/snippets/_snapshots-yaml-config.md | 2 ++ 2 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 website/snippets/_snapshots-yaml-config.md diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index 22c5ebf86cc..4a3541c2d51 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -7,6 +7,7 @@ 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 @@ -120,7 +121,8 @@ snapshots: -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. + + @@ -263,7 +265,7 @@ snapshots: -Configurations can be applied to snapshots using [YAML syntax](/docs/build/snapshots#configuring-snapshots), available in Versionless and dbt v1.9 and higher, in the `snapshot` directory file. + diff --git a/website/snippets/_snapshots-yaml-config.md b/website/snippets/_snapshots-yaml-config.md new file mode 100644 index 00000000000..68ccd7c0bc2 --- /dev/null +++ b/website/snippets/_snapshots-yaml-config.md @@ -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. + From 576af99f2d7654c733a884e415a3629e628ff4ae Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 25 Nov 2024 16:22:10 +0000 Subject: [PATCH 03/39] Update website/docs/reference/snapshot-configs.md Co-authored-by: Grace Goheen <53586774+graciegoheen@users.noreply.github.com> --- website/docs/reference/snapshot-configs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index 4a3541c2d51..5f5e88c9776 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -154,7 +154,7 @@ snapshots: :::tip -Configuring snapshots in YAML is recommended for new snapshot configurations. 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: +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) 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 From 2532cad5b35d9c6ebd0d3e8e964eb1d00ebdd34d Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 25 Nov 2024 16:24:41 +0000 Subject: [PATCH 04/39] update grace feedback --- website/docs/reference/snapshot-configs.md | 2 +- website/snippets/_snapshots-yaml-config.md | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index 4a3541c2d51..e9ba021403d 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -155,7 +155,7 @@ snapshots: :::tip Configuring snapshots in YAML is recommended for new snapshot configurations. 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) +1. Creating a backup copy of your snapshots. 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 diff --git a/website/snippets/_snapshots-yaml-config.md b/website/snippets/_snapshots-yaml-config.md index 68ccd7c0bc2..10eb8fed17c 100644 --- a/website/snippets/_snapshots-yaml-config.md +++ b/website/snippets/_snapshots-yaml-config.md @@ -1,2 +1 @@ -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. - +Define snapshots using the latest [YAML syntax](/docs/build/snapshots#configuring-snapshots), available in Versionless and dbt v1.9 and higher, in the `snapshot` directory file. From 7e68e914ffcd179b0b04ff28250fec5d42c61aaa Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 27 Nov 2024 11:20:11 +0000 Subject: [PATCH 05/39] update to snapshot configs --- website/docs/reference/snapshot-configs.md | 30 ++++++++++++------- website/snippets/_snapshots-yaml-config.md | 2 +- .../components/expandable/styles.module.css | 3 +- 3 files changed, 22 insertions(+), 13 deletions(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index a2e8365ae93..fbcdad93d56 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -18,6 +18,7 @@ import SnapshotsYamlConfig from '/snippets/_snapshots-yaml-config.md'; ## Available configurations ### Snapshot-specific configurations + @@ -74,8 +75,9 @@ snapshots: [+](/reference/resource-configs/plus-prefix)[strategy](/reference/resource-configs/strategy): timestamp | check [+](/reference/resource-configs/plus-prefix)[updated_at](/reference/resource-configs/updated_at): [+](/reference/resource-configs/plus-prefix)[check_cols](/reference/resource-configs/check_cols): [] | all + [+](/reference/resource-configs/plus-prefix)[invalidate_hard_deletes](/reference/resource-configs/invalidate_hard_deletes) : true | false [+](/reference/resource-configs/plus-prefix)[snapshot_meta_column_names](/reference/resource-configs/snapshot_meta_column_names): {} - [+](/reference/resource-configs/plus-prefix)[invalidate_hard_deletes](/reference/resource-configs/invalidate_hard_deletes) : true | false + [+](/reference/resource-configs/plus-prefix)[dbt_valid_to_current](/reference/resource-configs/dbt_valid_to_current): ``` @@ -108,8 +110,9 @@ snapshots: [strategy](/reference/resource-configs/strategy): timestamp | check [updated_at](/reference/resource-configs/updated_at): [check_cols](/reference/resource-configs/check_cols): [] | all - [snapshot_meta_column_names](/reference/resource-configs/snapshot_meta_column_names): {} [invalidate_hard_deletes](/reference/resource-configs/invalidate_hard_deletes) : true | false + [snapshot_meta_column_names](/reference/resource-configs/snapshot_meta_column_names): {} + [dbt_valid_to_current](/reference/resource-configs/dbt_valid_to_current): ``` @@ -147,20 +150,25 @@ snapshots: +### Snapshot configuration migration -### General configurations +The latest snapshot YAML configurations introduced in dbt v1.9 and higher (such as [`snapshot_meta_column_names`](/reference/resource-configs/snapshot_meta_column_names) and [`dbt_valid_to_current`](/reference/resource-configs/dbt_valid_to_current)) are best suited for new snapshots. For existing snapshots, we recommend the following to avoid any inconsistencies to your snapshots: - +#### For new snapshots +- Use the latest snapshot YAML configurations when creating new snapshots that didn't exist previously. + +#### For existing snapshots +- Migrate tables — Migrate the previous snapshot to the new table schema and values: + - Create a backup copy of your snapshots. + - Use `alter` statements as needed to ensure table consistency or use a script to apply the `alter` statements. +- New YAML config — Convert the YAML configurations one at a time, testing as you go. -:::tip +If you use one of the latest configs, such as `dbt_valid_to_current`, without migrating your data may result in mixed old and new data, leading to incorrect downstream result. -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. -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 -The YAML configuration offers improved maintainability and consistency, but there's no pressure to migrate existing snapshots immediately — feel free to do so at your own pace while ensuring data quality is maintained. -::: +### General configurations + + Date: Wed, 27 Nov 2024 15:52:47 +0000 Subject: [PATCH 06/39] Update website/docs/reference/snapshot-configs.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/reference/snapshot-configs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index fbcdad93d56..ad74ae9d423 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -163,7 +163,7 @@ The latest snapshot YAML configurations introduced in dbt v1.9 and higher (such - Use `alter` statements as needed to ensure table consistency or use a script to apply the `alter` statements. - New YAML config — Convert the YAML configurations one at a time, testing as you go. -If you use one of the latest configs, such as `dbt_valid_to_current`, without migrating your data may result in mixed old and new data, leading to incorrect downstream result. +If you use one of the latest configs, such as `dbt_valid_to_current`, without migrating your data, you may have mixed old and new data, leading to an incorrect downstream result. ### General configurations From bdf2850e5d4aae38d6d5c04a790952103803d6ce Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 27 Nov 2024 15:53:03 +0000 Subject: [PATCH 07/39] Update website/docs/reference/snapshot-configs.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/reference/snapshot-configs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index ad74ae9d423..a0edf569bf3 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -160,7 +160,7 @@ The latest snapshot YAML configurations introduced in dbt v1.9 and higher (such #### For existing snapshots - Migrate tables — Migrate the previous snapshot to the new table schema and values: - Create a backup copy of your snapshots. - - Use `alter` statements as needed to ensure table consistency or use a script to apply the `alter` statements. + - Use `alter` statements as needed (or a script to apply `alter` statements) to ensure table consistency. - New YAML config — Convert the YAML configurations one at a time, testing as you go. If you use one of the latest configs, such as `dbt_valid_to_current`, without migrating your data, you may have mixed old and new data, leading to an incorrect downstream result. From 6a84a7f955744ae9b52169acf2b9ec6a2dce532a Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 27 Nov 2024 15:53:11 +0000 Subject: [PATCH 08/39] Update website/docs/reference/snapshot-configs.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/reference/snapshot-configs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index a0edf569bf3..598a8a35aa4 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -152,7 +152,7 @@ snapshots: ### Snapshot configuration migration -The latest snapshot YAML configurations introduced in dbt v1.9 and higher (such as [`snapshot_meta_column_names`](/reference/resource-configs/snapshot_meta_column_names) and [`dbt_valid_to_current`](/reference/resource-configs/dbt_valid_to_current)) are best suited for new snapshots. For existing snapshots, we recommend the following to avoid any inconsistencies to your snapshots: +The latest snapshot YAML configurations introduced in dbt v1.9 (such as [`snapshot_meta_column_names`](/reference/resource-configs/snapshot_meta_column_names) and [`dbt_valid_to_current`](/reference/resource-configs/dbt_valid_to_current)) are best suited for new snapshots. For existing snapshots, we recommend the following to avoid any inconsistencies in your snapshots: #### For new snapshots - Use the latest snapshot YAML configurations when creating new snapshots that didn't exist previously. From 37efd7a83bf6ca39130ef66883495c5279dd2664 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 27 Nov 2024 15:53:27 +0000 Subject: [PATCH 09/39] Update website/snippets/_snapshots-yaml-config.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/snippets/_snapshots-yaml-config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/snippets/_snapshots-yaml-config.md b/website/snippets/_snapshots-yaml-config.md index cdfb7ceb07e..648b65752c0 100644 --- a/website/snippets/_snapshots-yaml-config.md +++ b/website/snippets/_snapshots-yaml-config.md @@ -1 +1 @@ -Define snapshots using the latest [YAML configurations](/docs/build/snapshots#configuring-snapshots), available in Versionless and dbt v1.9 and higher, in the `snapshot` directory file. +Define snapshots using the latest [YAML configurations](/docs/build/snapshots#configuring-snapshots), available in Versionless dbt Cloud and Core v1.9 and higher, in the `snapshot` directory file. From 5d3b48f6b12e90306403ca94d95fb9d0a991f318 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Thu, 28 Nov 2024 11:01:40 +0000 Subject: [PATCH 10/39] update --- website/docs/reference/snapshot-configs.md | 17 ++++++----------- website/snippets/_snapshots-yaml-config.md | 1 - 2 files changed, 6 insertions(+), 12 deletions(-) delete mode 100644 website/snippets/_snapshots-yaml-config.md diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index 598a8a35aa4..4d8d8e42d26 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -18,14 +18,11 @@ import SnapshotsYamlConfig from '/snippets/_snapshots-yaml-config.md'; ## Available configurations ### Snapshot-specific configurations - -import SnapshotYaml from '/snippets/_snapshot-yaml-spec.md'; - - +Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [snapshot-specific configurations](/docs/build/snapshots#snapshot-meta-fields). For new snapshots, we recommend using these latest configs. If applying them to existing snapshots, you'll need to migrate over. @@ -152,19 +149,17 @@ snapshots: ### Snapshot configuration migration -The latest snapshot YAML configurations introduced in dbt v1.9 (such as [`snapshot_meta_column_names`](/reference/resource-configs/snapshot_meta_column_names) and [`dbt_valid_to_current`](/reference/resource-configs/dbt_valid_to_current)) are best suited for new snapshots. For existing snapshots, we recommend the following to avoid any inconsistencies in your snapshots: - -#### For new snapshots -- Use the latest snapshot YAML configurations when creating new snapshots that didn't exist previously. +The latest snapshot configurations introduced in dbt v1.9 (such as [`snapshot_meta_column_names`](/reference/resource-configs/snapshot_meta_column_names), [`dbt_valid_to_current`](/reference/resource-configs/dbt_valid_to_current), and `hard_deletes`) are best suited for new snapshots. For existing snapshots, we recommend the following to avoid any inconsistencies in your snapshots: #### For existing snapshots - Migrate tables — Migrate the previous snapshot to the new table schema and values: - Create a backup copy of your snapshots. - Use `alter` statements as needed (or a script to apply `alter` statements) to ensure table consistency. -- New YAML config — Convert the YAML configurations one at a time, testing as you go. +- New configurations — Convert the configs one at a time, testing as you go. +:::warning If you use one of the latest configs, such as `dbt_valid_to_current`, without migrating your data, you may have mixed old and new data, leading to an incorrect downstream result. - +::: ### General configurations @@ -273,7 +268,7 @@ snapshots: - +Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [configurations](/docs/build/snapshots#configuring-snapshots). You can also continue using the legacy method for existing snapshots, but we recommend migrating over to the latest YAML format for better readability and maintainability. diff --git a/website/snippets/_snapshots-yaml-config.md b/website/snippets/_snapshots-yaml-config.md deleted file mode 100644 index 648b65752c0..00000000000 --- a/website/snippets/_snapshots-yaml-config.md +++ /dev/null @@ -1 +0,0 @@ -Define snapshots using the latest [YAML configurations](/docs/build/snapshots#configuring-snapshots), available in Versionless dbt Cloud and Core v1.9 and higher, in the `snapshot` directory file. From b84f4a5d97a09a428ce58bb94a5446d0fd6cbb28 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Thu, 28 Nov 2024 11:12:14 +0000 Subject: [PATCH 11/39] remove iimport --- website/docs/reference/snapshot-configs.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index 4d8d8e42d26..1867c6f12f0 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -7,8 +7,6 @@ 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) From 915e396b920e0d89ebe66fe08834f381da17078a Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 28 Nov 2024 11:41:55 +0000 Subject: [PATCH 12/39] Update snapshot-configs.md --- website/docs/reference/snapshot-configs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index 1867c6f12f0..dfc2bd087f1 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -406,7 +406,7 @@ The following examples demonstrate how to configure snapshots using the `dbt_pro - You can also define some common configs in a snapshot's `config` block. We don't recommend this for a snapshot's required configuration, however. + You can also define some common configs in a snapshot's `config` block. However, we don't recommend this for a snapshot's required configuration. From 61d3792815ad46094c30293475811145a3483b21 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 28 Nov 2024 12:03:50 +0000 Subject: [PATCH 13/39] Update snapshot-configs.md --- website/docs/reference/snapshot-configs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index dfc2bd087f1..4d9bcf8a049 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -119,7 +119,7 @@ snapshots: - +Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [snapshot-specific configurations](/docs/build/snapshots#snapshot-meta-fields). For new snapshots, we recommend using these latest configs. If applying them to existing snapshots, you'll need to migrate over. From b968ff595855fdd8350d2e996821a05be0dd761e Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Tue, 3 Dec 2024 09:50:05 +0000 Subject: [PATCH 14/39] add sl entry --- website/docs/docs/dbt-versions/release-notes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/website/docs/docs/dbt-versions/release-notes.md b/website/docs/docs/dbt-versions/release-notes.md index 55116db68ba..4e0f61e8fa6 100644 --- a/website/docs/docs/dbt-versions/release-notes.md +++ b/website/docs/docs/dbt-versions/release-notes.md @@ -19,6 +19,7 @@ Release notes are grouped by month for both multi-tenant and virtual private clo \* The official release date for this new format of release notes is May 15th, 2024. Historical release notes for prior dates may not reflect all available features released earlier this year or their tenancy availability. ## November 2024 +- **Bug**: Identified and fixed an error with Semantic Layer queries that take longer than 10 minutes to complete. - **Fix**: Job environment variable overrides in credentials are now respected for Exports. Previously, they were ignored. - **Behavior change**: If you use a custom microbatch macro, set a [`require_batched_execution_for_custom_microbatch_strategy` behavior flag](/reference/global-configs/behavior-changes#custom-microbatch-strategy) in your `dbt_project.yml` to enable batched execution. If you don't have a custom microbatch macro, you don't need to set this flag as dbt will handle microbatching automatically for any model using the [microbatch strategy](/docs/build/incremental-microbatch#how-microbatch-compares-to-other-incremental-strategies). - **Enhancement**: For users that have Advanced CI's [compare changes](/docs/deploy/advanced-ci#compare-changes) feature enabled, you can optimize performance when running comparisons by using custom dbt syntax to customize deferral usage, exclude specific large models (or groups of models with tags), and more. Refer to [Compare changes custom commands](/docs/deploy/job-commands#compare-changes-custom-commands) for examples of how to customize the comparison command. From c4918188decf94faa637bb578c275cc2099edb79 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Tue, 3 Dec 2024 16:48:29 +0000 Subject: [PATCH 15/39] add link --- .../docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.9.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.9.md b/website/docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.9.md index 31153188978..dedb9c0175f 100644 --- a/website/docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.9.md +++ b/website/docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.9.md @@ -68,6 +68,8 @@ Beginning in dbt Core 1.9, we've streamlined snapshot configuration and added a Read more about [Snapshots meta fields](/docs/build/snapshots#snapshot-meta-fields). +To learn how to safely migrate existing snapshots, refer to [Snapshot configuration migration](/reference/snapshot-configs#snapshot-configuration-migration) for more information. + ### `state:modified` improvements We’ve made improvements to `state:modified` behaviors to help reduce the risk of false positives and negatives. Read more about [the `state:modified` behavior flag](#managing-changes-to-legacy-behaviors) that unlocks this improvement: From 8382836851c67f11d3dfbd2b313b5c1404a03735 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 3 Dec 2024 17:04:57 +0000 Subject: [PATCH 16/39] Update website/docs/reference/snapshot-configs.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/reference/snapshot-configs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index c8709f8f157..2e1167f875e 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -20,7 +20,7 @@ import ConfigGeneral from '/snippets/_config-description-general.md'; -Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [snapshot-specific configurations](/docs/build/snapshots#snapshot-meta-fields). For new snapshots, we recommend using these latest configs. If applying them to existing snapshots, you'll need to migrate over. +Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [snapshot-specific configurations](/docs/build/snapshot-configs#snapshot-specific-configurations). For new snapshots, we recommend using these latest configs. If applying them to existing snapshots, you'll need to migrate over. From a9d4cc535a523388c4eb5ca3f05282e1b122349e Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 3 Dec 2024 17:38:39 +0000 Subject: [PATCH 17/39] Update website/docs/reference/snapshot-configs.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/reference/snapshot-configs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index 2e1167f875e..2fa9a81be51 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -119,7 +119,7 @@ snapshots: -Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [snapshot-specific configurations](/docs/build/snapshots#snapshot-meta-fields). For new snapshots, we recommend using these latest configs. If applying them to existing snapshots, you'll need to migrate over. +Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [snapshot-specific configurations](/docs/build/snapshot-configs#snapshot-specific-configurations). For new snapshots, we recommend using these latest configs. If applying them to existing snapshots, you'll need to migrate over. From f9aa8d4a4a68dc2374efd8622574557f7e491742 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 3 Dec 2024 18:06:09 +0000 Subject: [PATCH 18/39] Update release-notes.md add release note support for trust signal support for explorer ref: https://github.com/dbt-labs/docs-internal/issues/755 --- website/docs/docs/dbt-versions/release-notes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/website/docs/docs/dbt-versions/release-notes.md b/website/docs/docs/dbt-versions/release-notes.md index 55116db68ba..7536bafae71 100644 --- a/website/docs/docs/dbt-versions/release-notes.md +++ b/website/docs/docs/dbt-versions/release-notes.md @@ -19,6 +19,7 @@ Release notes are grouped by month for both multi-tenant and virtual private clo \* The official release date for this new format of release notes is May 15th, 2024. Historical release notes for prior dates may not reflect all available features released earlier this year or their tenancy availability. ## November 2024 +- **Enhancement**: Trust signal icons in dbt Explorer are now available for Exposures, providing a quick view of data health while browsing models. To access trust signals, go to dbt Explorer and click **Exposures** under the **Resource** tab. Refer to [Trust signal for resources](/docs/collaborate/explore-projects#trust-signals-for-resources) for more info. - **Fix**: Job environment variable overrides in credentials are now respected for Exports. Previously, they were ignored. - **Behavior change**: If you use a custom microbatch macro, set a [`require_batched_execution_for_custom_microbatch_strategy` behavior flag](/reference/global-configs/behavior-changes#custom-microbatch-strategy) in your `dbt_project.yml` to enable batched execution. If you don't have a custom microbatch macro, you don't need to set this flag as dbt will handle microbatching automatically for any model using the [microbatch strategy](/docs/build/incremental-microbatch#how-microbatch-compares-to-other-incremental-strategies). - **Enhancement**: For users that have Advanced CI's [compare changes](/docs/deploy/advanced-ci#compare-changes) feature enabled, you can optimize performance when running comparisons by using custom dbt syntax to customize deferral usage, exclude specific large models (or groups of models with tags), and more. Refer to [Compare changes custom commands](/docs/deploy/job-commands#compare-changes-custom-commands) for examples of how to customize the comparison command. From 823fbe62f08828f6364e1ed19cde563d65ec2fd7 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 3 Dec 2024 18:09:21 +0000 Subject: [PATCH 19/39] Update explore-projects.md add exposures --- website/docs/docs/collaborate/explore-projects.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/collaborate/explore-projects.md b/website/docs/docs/collaborate/explore-projects.md index a4388a8696e..bd2aabb51b5 100644 --- a/website/docs/docs/collaborate/explore-projects.md +++ b/website/docs/docs/collaborate/explore-projects.md @@ -164,12 +164,12 @@ Under the the **Models** option, you can filter on model properties (access or m -Trust signal icons offer a quick, at-a-glance view of data health when browsing your models in dbt Explorer. These icons keep you informed on the status of your model's health using the indicators **Healthy**, **Caution**, **Degraded**, and **Unknown**. For accurate health data, ensure the resource is up-to-date and has had a recent job run. +Trust signal icons offer a quick, at-a-glance view of data health when browsing your models in dbt Explorer. These icons keep you informed on the status of your resource's health using the indicators **Healthy**, **Caution**, **Degraded**, and **Unknown**. For accurate health data, ensure the resource is up-to-date and has had a recent job run. Supported resources are models, sources, and exposures. Each trust signal icon reflects key data health components, such as test success status, missing resource descriptions, absence of builds in 30-day windows, and more. To access trust signals: -- Use the search function or click on **Models** or **Sources** under the **Resource** tab. +- Use the search function or click on **Models**, **Sources** or **Exposures** under the **Resource** tab. - View the icons under the **Health** column. - Hover over or click the trust signal to see detailed information. - For sources, the trust signal also indicates the source freshness status. From 944fb50089537a1016a2ef78fa5d2836e7b68664 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Tue, 3 Dec 2024 18:26:39 +0000 Subject: [PATCH 20/39] doug's feedback --- website/docs/docs/build/snapshots.md | 2 ++ website/docs/reference/snapshot-configs.md | 24 +++++---------------- website/snippets/_legacy-snapshot-config.md | 4 ++++ 3 files changed, 11 insertions(+), 19 deletions(-) create mode 100644 website/snippets/_legacy-snapshot-config.md diff --git a/website/docs/docs/build/snapshots.md b/website/docs/docs/build/snapshots.md index 9a020c7c940..494255135d3 100644 --- a/website/docs/docs/build/snapshots.md +++ b/website/docs/docs/build/snapshots.md @@ -40,6 +40,7 @@ This order is now in the "shipped" state, but we've lost the information about w - To configure snapshots in versions 1.8 and earlier, refer to [Configure snapshots in versions 1.8 and earlier](#configure-snapshots-in-versions-18-and-earlier). These versions use an older syntax where snapshots are defined within a snapshot block in a `.sql` file, typically located in your `snapshots` directory. - Note that defining multiple resources in a single file can significantly slow down parsing and compilation. For faster and more efficient management, consider the updated snapshot YAML syntax, [available in Versionless](/docs/dbt-versions/versionless-cloud) or [dbt Core v1.9 and later](/docs/dbt-versions/core). + - For more information on how to migrate from the legacy snapshot configurations to the updated snapshot YAML syntax, refer to [Snapshot configuration migration](/reference/snapshot-configs#snapshot-configuration-migration). @@ -496,6 +497,7 @@ To configure snapshots in versions 1.9 and later, refer to [Configuring snapshot - In dbt versions 1.8 and earlier, snapshots are `select` statements, defined within a snapshot block in a `.sql` file (typically in your `snapshots` directory). You'll also need to configure your snapshot to tell dbt how to detect record changes. - The earlier dbt versions use an older syntax that allows for defining multiple resources in a single file. This syntax can significantly slow down parsing and compilation. - For faster and more efficient management, consider[ upgrading to Versionless](/docs/dbt-versions/versionless-cloud) or the [latest version of dbt Core](/docs/dbt-versions/core), which introduces an updated snapshot configuration syntax that optimizes performance. + - For more information on how to migrate from the legacy snapshot configurations to the updated snapshot YAML syntax, refer to [Snapshot configuration migration](/reference/snapshot-configs#snapshot-configuration-migration). The following example shows how to configure a snapshot: diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index 2e1167f875e..1e52eb66290 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -18,12 +18,6 @@ import ConfigGeneral from '/snippets/_config-description-general.md'; - - -Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [snapshot-specific configurations](/docs/build/snapshot-configs#snapshot-specific-configurations). For new snapshots, we recommend using these latest configs. If applying them to existing snapshots, you'll need to migrate over. - - - - - -Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [snapshot-specific configurations](/docs/build/snapshots#snapshot-meta-fields). For new snapshots, we recommend using these latest configs. If applying them to existing snapshots, you'll need to migrate over. +import LegacySnapshotConfig from '/snippets/_legacy-snapshot-config.md'; - - + @@ -264,11 +255,8 @@ snapshots: - + -Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [configurations](/docs/build/snapshots#configuring-snapshots). You can also continue using the legacy method for existing snapshots, but we recommend migrating over to the latest YAML format for better readability and maintainability. - - @@ -303,12 +291,10 @@ Snapshots can be configured in multiple ways: -1. Defined in YAML files using a `config` [resource property](/reference/model-properties), typically in your [snapshots directory](/reference/project-configs/snapshot-paths) (available in [Versionless](/docs/dbt-versions/versionless-cloud) or and dbt Core v1.9 and higher). -2. Using a `config` block within a snapshot defined in Jinja SQL +1. Defined in a YAML file using a `config` [resource property](/reference/model-properties), typically in your [snapshots directory](/reference/project-configs/snapshot-paths) (available in [Versionless](/docs/dbt-versions/versionless-cloud) or and dbt Core v1.9 and higher). The latest snapshot YAML syntax provides faster and more efficient management. +2. Using a `config` block within a snapshot defined in Jinja SQL. 3. From the `dbt_project.yml` file, under the `snapshots:` key. To apply a configuration to a snapshot, or directory of snapshots, define the resource path as nested dictionary keys. -Note that in Versionless and dbt v1.9 and later, snapshots are defined in an updated syntax using a YAML file within your `snapshots/` directory (as defined by the [`snapshot-paths` config](/reference/project-configs/snapshot-paths)). For faster and more efficient management, consider the updated snapshot YAML syntax, [available in Versionless](/docs/dbt-versions/versionless-cloud) or [dbt Core v1.9 and later](/docs/dbt-versions/core). - Snapshot configurations are applied hierarchically in the order above with higher taking precedence. diff --git a/website/snippets/_legacy-snapshot-config.md b/website/snippets/_legacy-snapshot-config.md new file mode 100644 index 00000000000..b44dc1c0ef8 --- /dev/null +++ b/website/snippets/_legacy-snapshot-config.md @@ -0,0 +1,4 @@ + +:::info +Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [snapshot-specific configurations](/docs/build/snapshots#configuring-snapshots). For new snapshots, we recommend using these latest configs. If applying them to existing snapshots, you'll need to [migrate](#snapshot-configuration-migration) over. +::: From 849cf224b1184ee354773edaeadac8177679d48c Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 3 Dec 2024 18:44:17 +0000 Subject: [PATCH 21/39] Update website/docs/docs/dbt-versions/release-notes.md --- website/docs/docs/dbt-versions/release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/dbt-versions/release-notes.md b/website/docs/docs/dbt-versions/release-notes.md index 7536bafae71..bc109869852 100644 --- a/website/docs/docs/dbt-versions/release-notes.md +++ b/website/docs/docs/dbt-versions/release-notes.md @@ -19,7 +19,7 @@ Release notes are grouped by month for both multi-tenant and virtual private clo \* The official release date for this new format of release notes is May 15th, 2024. Historical release notes for prior dates may not reflect all available features released earlier this year or their tenancy availability. ## November 2024 -- **Enhancement**: Trust signal icons in dbt Explorer are now available for Exposures, providing a quick view of data health while browsing models. To access trust signals, go to dbt Explorer and click **Exposures** under the **Resource** tab. Refer to [Trust signal for resources](/docs/collaborate/explore-projects#trust-signals-for-resources) for more info. +- **Enhancement**: Trust signal icons in dbt Explorer are now available for Exposures, providing a quick view of data health while browsing resources. To access trust signals, go to dbt Explorer and click **Exposures** under the **Resource** tab. Refer to [Trust signal for resources](/docs/collaborate/explore-projects#trust-signals-for-resources) for more info. - **Fix**: Job environment variable overrides in credentials are now respected for Exports. Previously, they were ignored. - **Behavior change**: If you use a custom microbatch macro, set a [`require_batched_execution_for_custom_microbatch_strategy` behavior flag](/reference/global-configs/behavior-changes#custom-microbatch-strategy) in your `dbt_project.yml` to enable batched execution. If you don't have a custom microbatch macro, you don't need to set this flag as dbt will handle microbatching automatically for any model using the [microbatch strategy](/docs/build/incremental-microbatch#how-microbatch-compares-to-other-incremental-strategies). - **Enhancement**: For users that have Advanced CI's [compare changes](/docs/deploy/advanced-ci#compare-changes) feature enabled, you can optimize performance when running comparisons by using custom dbt syntax to customize deferral usage, exclude specific large models (or groups of models with tags), and more. Refer to [Compare changes custom commands](/docs/deploy/job-commands#compare-changes-custom-commands) for examples of how to customize the comparison command. From 98f8eb681c63f2f0f26f7c182d74a7dfccb726c3 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 3 Dec 2024 18:44:33 +0000 Subject: [PATCH 22/39] Update website/docs/docs/collaborate/explore-projects.md --- website/docs/docs/collaborate/explore-projects.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/collaborate/explore-projects.md b/website/docs/docs/collaborate/explore-projects.md index bd2aabb51b5..3780d100932 100644 --- a/website/docs/docs/collaborate/explore-projects.md +++ b/website/docs/docs/collaborate/explore-projects.md @@ -164,7 +164,7 @@ Under the the **Models** option, you can filter on model properties (access or m -Trust signal icons offer a quick, at-a-glance view of data health when browsing your models in dbt Explorer. These icons keep you informed on the status of your resource's health using the indicators **Healthy**, **Caution**, **Degraded**, and **Unknown**. For accurate health data, ensure the resource is up-to-date and has had a recent job run. Supported resources are models, sources, and exposures. +Trust signal icons offer a quick, at-a-glance view of data health when browsing your resources in dbt Explorer. These icons keep you informed on the status of your resource's health using the indicators **Healthy**, **Caution**, **Degraded**, and **Unknown**. For accurate health data, ensure the resource is up-to-date and has had a recent job run. Supported resources are models, sources, and exposures. Each trust signal icon reflects key data health components, such as test success status, missing resource descriptions, absence of builds in 30-day windows, and more. From 60380219810b6a610e73d2af86ff4e45e6df54e8 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 3 Dec 2024 18:45:19 +0000 Subject: [PATCH 23/39] Update website/docs/docs/dbt-versions/release-notes.md --- website/docs/docs/dbt-versions/release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/dbt-versions/release-notes.md b/website/docs/docs/dbt-versions/release-notes.md index bc109869852..8744db64313 100644 --- a/website/docs/docs/dbt-versions/release-notes.md +++ b/website/docs/docs/dbt-versions/release-notes.md @@ -19,7 +19,7 @@ Release notes are grouped by month for both multi-tenant and virtual private clo \* The official release date for this new format of release notes is May 15th, 2024. Historical release notes for prior dates may not reflect all available features released earlier this year or their tenancy availability. ## November 2024 -- **Enhancement**: Trust signal icons in dbt Explorer are now available for Exposures, providing a quick view of data health while browsing resources. To access trust signals, go to dbt Explorer and click **Exposures** under the **Resource** tab. Refer to [Trust signal for resources](/docs/collaborate/explore-projects#trust-signals-for-resources) for more info. +- **Enhancement**: Trust signal icons in dbt Explorer are now available for Exposures, providing a quick view of data health while browsing resources. To view trust signal icons, go to dbt Explorer and click **Exposures** under the **Resource** tab. Refer to [Trust signal for resources](/docs/collaborate/explore-projects#trust-signals-for-resources) for more info. - **Fix**: Job environment variable overrides in credentials are now respected for Exports. Previously, they were ignored. - **Behavior change**: If you use a custom microbatch macro, set a [`require_batched_execution_for_custom_microbatch_strategy` behavior flag](/reference/global-configs/behavior-changes#custom-microbatch-strategy) in your `dbt_project.yml` to enable batched execution. If you don't have a custom microbatch macro, you don't need to set this flag as dbt will handle microbatching automatically for any model using the [microbatch strategy](/docs/build/incremental-microbatch#how-microbatch-compares-to-other-incremental-strategies). - **Enhancement**: For users that have Advanced CI's [compare changes](/docs/deploy/advanced-ci#compare-changes) feature enabled, you can optimize performance when running comparisons by using custom dbt syntax to customize deferral usage, exclude specific large models (or groups of models with tags), and more. Refer to [Compare changes custom commands](/docs/deploy/job-commands#compare-changes-custom-commands) for examples of how to customize the comparison command. From dd349bb8db3bf3fb1d6f331d5518387ee4515d8c Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Wed, 4 Dec 2024 00:34:32 -0500 Subject: [PATCH 24/39] Fixing sqlfluff link (#6560) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## What are you changing in this pull request and why? Fixing broken sqlfluff link and adding a few suggestions for exclusion ## Checklist - [ ] I have reviewed the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. - [ ] The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and/or [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content) guidelines. - [ ] I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch." - [ ] The content in this PR requires a dbt release note, so I added one to the [release notes page](https://docs.getdbt.com/docs/dbt-versions/dbt-cloud-release-notes). --- 🚀 Deployment available! Here are the direct links to the updated files: - https://docs-getdbt-com-git-linting-dbt-labs.vercel.app/best-practices/how-we-style/2-how-we-style-our-sql --------- Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> --- .../best-practices/how-we-style/2-how-we-style-our-sql.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/best-practices/how-we-style/2-how-we-style-our-sql.md b/website/docs/best-practices/how-we-style/2-how-we-style-our-sql.md index 8c61e63b888..35e025faf3f 100644 --- a/website/docs/best-practices/how-we-style/2-how-we-style-our-sql.md +++ b/website/docs/best-practices/how-we-style/2-how-we-style-our-sql.md @@ -8,8 +8,8 @@ id: 2-how-we-style-our-sql - ☁️ Use [SQLFluff](https://sqlfluff.com/) to maintain these style rules automatically. - Customize `.sqlfluff` configuration files to your needs. - Refer to our [SQLFluff config file](https://github.com/dbt-labs/jaffle-shop-template/blob/main/.sqlfluff) for the rules we use in our own projects. - - - Exclude files and directories by using a standard `.sqlfluffignore` file. Learn more about the syntax in the [.sqlfluffignore syntax docs](https://docs.sqlfluff.com/en/stable/configuration.html#id2). + - Exclude files and directories by using a standard `.sqlfluffignore` file. Learn more about the syntax in the [.sqlfluffignore syntax docs](https://docs.sqlfluff.com/en/stable/configuration/index.html). + - Excluding unnecessary folders and files (such as `target/`, `dbt_packages/`, and `macros/`) can speed up linting, improve run times, and help you avoid irrelevant logs. - 👻 Use Jinja comments (`{# #}`) for comments that should not be included in the compiled SQL. - ⏭️ Use trailing commas. - 4️⃣ Indents should be four spaces. From a475180c4fe9d3ac2ac51e1751fe2d3de6929205 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 4 Dec 2024 09:34:28 +0000 Subject: [PATCH 25/39] tweaks --- .../dbt-versions/core-upgrade/06-upgrading-to-v1.9.md | 2 ++ website/docs/reference/snapshot-configs.md | 11 +++++++++-- website/snippets/_legacy-snapshot-config.md | 2 +- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.9.md b/website/docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.9.md index dedb9c0175f..b8efd2661a9 100644 --- a/website/docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.9.md +++ b/website/docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.9.md @@ -51,9 +51,11 @@ Starting in Core 1.9, you can use the new [microbatch strategy](/docs/build/incr Currently microbatch is supported on these adapters with more to come: * postgres + * redshift * snowflake * bigquery * spark + * databricks ### Snapshots improvements diff --git a/website/docs/reference/snapshot-configs.md b/website/docs/reference/snapshot-configs.md index 1e52eb66290..9efab769018 100644 --- a/website/docs/reference/snapshot-configs.md +++ b/website/docs/reference/snapshot-configs.md @@ -138,7 +138,7 @@ import LegacySnapshotConfig from '/snippets/_legacy-snapshot-config.md'; ### Snapshot configuration migration -The latest snapshot configurations introduced in dbt v1.9 (such as [`snapshot_meta_column_names`](/reference/resource-configs/snapshot_meta_column_names), [`dbt_valid_to_current`](/reference/resource-configs/dbt_valid_to_current), and `hard_deletes`) are best suited for new snapshots. For existing snapshots, we recommend the following to avoid any inconsistencies in your snapshots: +The latest snapshot configurations introduced in dbt Core v1.9 (such as [`snapshot_meta_column_names`](/reference/resource-configs/snapshot_meta_column_names), [`dbt_valid_to_current`](/reference/resource-configs/dbt_valid_to_current), and `hard_deletes`) are best suited for new snapshots. For existing snapshots, we recommend the following to avoid any inconsistencies in your snapshots: #### For existing snapshots - Migrate tables — Migrate the previous snapshot to the new table schema and values: @@ -300,7 +300,14 @@ Snapshots can be configured in multiple ways: Snapshot configurations are applied hierarchically in the order above with higher taking precedence. ### Examples -The following examples demonstrate how to configure snapshots using the `dbt_project.yml` file, a `config` block within a snapshot, and a `.yml` file. + + +The following examples demonstrate how to configure snapshots using the `dbt_project.yml` file and a `.yml` file. + + + +The following examples demonstrate how to configure snapshots using the `dbt_project.yml` file, a `config` block within a snapshot (legacy method), and a `.yml` file. + - #### Apply configurations to all snapshots To apply a configuration to all snapshots, including those in any installed [packages](/docs/build/packages), nest the configuration directly under the `snapshots` key: diff --git a/website/snippets/_legacy-snapshot-config.md b/website/snippets/_legacy-snapshot-config.md index b44dc1c0ef8..a0091215b46 100644 --- a/website/snippets/_legacy-snapshot-config.md +++ b/website/snippets/_legacy-snapshot-config.md @@ -1,4 +1,4 @@ :::info -Starting from Versionless and Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [snapshot-specific configurations](/docs/build/snapshots#configuring-snapshots). For new snapshots, we recommend using these latest configs. If applying them to existing snapshots, you'll need to [migrate](#snapshot-configuration-migration) over. +Starting from Versionless and dbt Core v1.9, defining snapshots in a `.sql` file using a config block is a legacy method. You can define snapshots in YAML format using the latest [snapshot-specific configurations](/docs/build/snapshots#configuring-snapshots). For new snapshots, we recommend using these latest configs. If applying them to existing snapshots, you'll need to [migrate](#snapshot-configuration-migration) over. ::: From 4df5e2c3aa2c94f8ff4ea98e55872033428a0a0e Mon Sep 17 00:00:00 2001 From: Sean McIntyre Date: Wed, 4 Dec 2024 13:38:31 +0100 Subject: [PATCH 26/39] Add common Snowflake grants troubleshooting tip --- website/docs/guides/snowflake-qs.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index 1eae3a13fb0..16c8751950a 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -230,6 +230,23 @@ Now that you have a repository configured, you can initialize your project and s ``` - In the command line bar at the bottom, enter `dbt run` and click **Enter**. You should see a `dbt run succeeded` message. +:::warning +If you receive an insufficient privileges error on Snowflake at this point, it may be because your Snowflake role is not permitted to access the raw source data, to build target tables and views, or both. If this happens, you may consider troubleshooting by running the following commands in Snowflake using a role with sufficient privilieges (e.g., `ACCOUNTADMIN`): + +``` +grant all on database raw to role ; +grant all on database analytics to role ; + +grant all on schema raw.jaffle_shop to role ; +grant all on schema raw.stripe to role ; + +grant all on all tables in database raw to role ; +grant all on future tables in database raw to role ; +``` + +Note to replace `` with the role you intend to use. If you launched dbt Cloud with Partner Connect, then this role will be `pc_dbt_role`. +::: + ## Build your first model You have two options for working with files in the dbt Cloud IDE: From ca982d1501c6ccb156eaed50b41fba8f5734b4ed Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:06:13 +0000 Subject: [PATCH 27/39] Update website/docs/guides/snowflake-qs.md --- website/docs/guides/snowflake-qs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index 16c8751950a..375f50df2de 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -231,7 +231,7 @@ Now that you have a repository configured, you can initialize your project and s - In the command line bar at the bottom, enter `dbt run` and click **Enter**. You should see a `dbt run succeeded` message. :::warning -If you receive an insufficient privileges error on Snowflake at this point, it may be because your Snowflake role is not permitted to access the raw source data, to build target tables and views, or both. If this happens, you may consider troubleshooting by running the following commands in Snowflake using a role with sufficient privilieges (e.g., `ACCOUNTADMIN`): +If you receive an insufficient privileges error on Snowflake at this point, it may be because your Snowflake role doesn't have permission to access the raw source data, to build target tables and views, or both. To troubleshoot, use a role with sufficient privileges (like `ACCOUNTADMIN`) and run the following commands in Snowflake: ``` grant all on database raw to role ; From 7f83d01c40254c18074f1fb09ad7f525358ea341 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:11:12 +0000 Subject: [PATCH 28/39] Update website/docs/guides/snowflake-qs.md --- website/docs/guides/snowflake-qs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index 375f50df2de..22cccf756e8 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -234,7 +234,7 @@ Now that you have a repository configured, you can initialize your project and s If you receive an insufficient privileges error on Snowflake at this point, it may be because your Snowflake role doesn't have permission to access the raw source data, to build target tables and views, or both. To troubleshoot, use a role with sufficient privileges (like `ACCOUNTADMIN`) and run the following commands in Snowflake: ``` -grant all on database raw to role ; +grant all on database raw to role snowflake_role_name; grant all on database analytics to role ; grant all on schema raw.jaffle_shop to role ; From d3705d3165a6f9c4d6ef6323cca17214dfbad280 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:11:27 +0000 Subject: [PATCH 29/39] Update website/docs/guides/snowflake-qs.md --- website/docs/guides/snowflake-qs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index 22cccf756e8..c68bf74816a 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -235,7 +235,7 @@ If you receive an insufficient privileges error on Snowflake at this point, it m ``` grant all on database raw to role snowflake_role_name; -grant all on database analytics to role ; +grant all on database analytics to role snowflake_role_name; grant all on schema raw.jaffle_shop to role ; grant all on schema raw.stripe to role ; From da2bf456596d591ee733aa5081042785c7233ab8 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:11:33 +0000 Subject: [PATCH 30/39] Update website/docs/guides/snowflake-qs.md --- website/docs/guides/snowflake-qs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index c68bf74816a..b177832caab 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -237,7 +237,7 @@ If you receive an insufficient privileges error on Snowflake at this point, it m grant all on database raw to role snowflake_role_name; grant all on database analytics to role snowflake_role_name; -grant all on schema raw.jaffle_shop to role ; +grant all on schema raw.jaffle_shop to role snowflake_role_name; grant all on schema raw.stripe to role ; grant all on all tables in database raw to role ; From dc6dbb2a82d803b68ce1b492284a3df145a5b7e5 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:11:39 +0000 Subject: [PATCH 31/39] Update website/docs/guides/snowflake-qs.md --- website/docs/guides/snowflake-qs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index b177832caab..8f32ceaf64f 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -238,7 +238,7 @@ grant all on database raw to role snowflake_role_name; grant all on database analytics to role snowflake_role_name; grant all on schema raw.jaffle_shop to role snowflake_role_name; -grant all on schema raw.stripe to role ; +grant all on schema raw.stripe to role snowflake_role_name; grant all on all tables in database raw to role ; grant all on future tables in database raw to role ; From 29dab9d55c685fd8e590260168c81d4bc31db0ef Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:11:45 +0000 Subject: [PATCH 32/39] Update website/docs/guides/snowflake-qs.md --- website/docs/guides/snowflake-qs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index 8f32ceaf64f..8963efc738f 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -240,7 +240,7 @@ grant all on database analytics to role snowflake_role_name; grant all on schema raw.jaffle_shop to role snowflake_role_name; grant all on schema raw.stripe to role snowflake_role_name; -grant all on all tables in database raw to role ; +grant all on all tables in database raw to role snowflake_role_name; grant all on future tables in database raw to role ; ``` From 57cd42b61110f595c49e9c3cbb1642f153844f7d Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:11:51 +0000 Subject: [PATCH 33/39] Update website/docs/guides/snowflake-qs.md --- website/docs/guides/snowflake-qs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index 8963efc738f..10fbac1078e 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -241,7 +241,7 @@ grant all on schema raw.jaffle_shop to role snowflake_role_name; grant all on schema raw.stripe to role snowflake_role_name; grant all on all tables in database raw to role snowflake_role_name; -grant all on future tables in database raw to role ; +grant all on future tables in database raw to role snowflake_role_name; ``` Note to replace `` with the role you intend to use. If you launched dbt Cloud with Partner Connect, then this role will be `pc_dbt_role`. From 6f85a7e995e94ae7271057d966f04cc757624250 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:11:57 +0000 Subject: [PATCH 34/39] Update website/docs/guides/snowflake-qs.md --- website/docs/guides/snowflake-qs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index 10fbac1078e..68682651926 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -244,7 +244,7 @@ grant all on all tables in database raw to role snowflake_role_name; grant all on future tables in database raw to role snowflake_role_name; ``` -Note to replace `` with the role you intend to use. If you launched dbt Cloud with Partner Connect, then this role will be `pc_dbt_role`. +Note, replace `snowflake_role_name` with the role you intend to use. If you launched dbt Cloud with Snowflake Partner Connect, use `pc_dbt_role` as the role. ::: ## Build your first model From 50902117b4de46ee791c52286fc8544be83d6da1 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:13:52 +0000 Subject: [PATCH 35/39] Update website/docs/guides/snowflake-qs.md --- website/docs/guides/snowflake-qs.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index 68682651926..54f674fab9d 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -231,7 +231,11 @@ Now that you have a repository configured, you can initialize your project and s - In the command line bar at the bottom, enter `dbt run` and click **Enter**. You should see a `dbt run succeeded` message. :::warning -If you receive an insufficient privileges error on Snowflake at this point, it may be because your Snowflake role doesn't have permission to access the raw source data, to build target tables and views, or both. To troubleshoot, use a role with sufficient privileges (like `ACCOUNTADMIN`) and run the following commands in Snowflake: +If you receive an insufficient privileges error on Snowflake at this point, it may be because your Snowflake role doesn't have permission to access the raw source data, to build target tables and views, or both. + +To troubleshoot, use a role with sufficient privileges (like `ACCOUNTADMIN`) and run the following commands in Snowflake. + +**Note**: Replace `snowflake_role_name` with the role you intend to use. If you launched dbt Cloud with Snowflake Partner Connect, use `pc_dbt_role` as the role. ``` grant all on database raw to role snowflake_role_name; From 33a1e458757879df12c487023839d08b4b674b6d Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:14:16 +0000 Subject: [PATCH 36/39] Update website/docs/guides/snowflake-qs.md --- website/docs/guides/snowflake-qs.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index 54f674fab9d..4f2b9299c21 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -248,7 +248,6 @@ grant all on all tables in database raw to role snowflake_role_name; grant all on future tables in database raw to role snowflake_role_name; ``` -Note, replace `snowflake_role_name` with the role you intend to use. If you launched dbt Cloud with Snowflake Partner Connect, use `pc_dbt_role` as the role. ::: ## Build your first model From 48570d433f90ec4afcd3bdee253665f6c2d5ead2 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:29:40 +0000 Subject: [PATCH 37/39] Update website/docs/guides/snowflake-qs.md --- website/docs/guides/snowflake-qs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/snowflake-qs.md b/website/docs/guides/snowflake-qs.md index 4f2b9299c21..f1edd5ffc00 100644 --- a/website/docs/guides/snowflake-qs.md +++ b/website/docs/guides/snowflake-qs.md @@ -230,7 +230,7 @@ Now that you have a repository configured, you can initialize your project and s ``` - In the command line bar at the bottom, enter `dbt run` and click **Enter**. You should see a `dbt run succeeded` message. -:::warning +:::info If you receive an insufficient privileges error on Snowflake at this point, it may be because your Snowflake role doesn't have permission to access the raw source data, to build target tables and views, or both. To troubleshoot, use a role with sufficient privileges (like `ACCOUNTADMIN`) and run the following commands in Snowflake. From 3db3640c81964b4b5c6c77f84d779b9936036267 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:12:16 -0500 Subject: [PATCH 38/39] Adding status codes to run doc (#6586) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## What are you changing in this pull request and why? Adding the list_run API status codes to the `run` ref ## Checklist - [ ] I have reviewed the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. - [ ] The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and/or [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content) guidelines. - [ ] I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch." - [ ] The content in this PR requires a dbt release note, so I added one to the [release notes page](https://docs.getdbt.com/docs/dbt-versions/dbt-cloud-release-notes). --- 🚀 Deployment available! Here are the direct links to the updated files: - https://docs-getdbt-com-git-run-status-dbt-labs.vercel.app/reference/commands/run --- website/docs/reference/commands/run.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/website/docs/reference/commands/run.md b/website/docs/reference/commands/run.md index 26db40cb7e4..58a876f98ef 100644 --- a/website/docs/reference/commands/run.md +++ b/website/docs/reference/commands/run.md @@ -83,4 +83,15 @@ See [global configs](/reference/global-configs/print-output#print-color) The `run` command supports the `--empty` flag for building schema-only dry runs. The `--empty` flag limits the refs and sources to zero rows. dbt will still execute the model SQL against the target data warehouse but will avoid expensive reads of input data. This validates dependencies and ensures your models will build properly. - \ No newline at end of file + + +## Status codes + +When calling the [list_runs api](/dbt-cloud/api-v2#/operations/List%20Runs), you will get a status code for each run returned. The available run status codes are as follows: + +- Starting = 1 +- Running = 3 +- Success = 10 +- Error = 20 +- Canceled = 30 +- Skipped = 40 From 56d6e4554efa53b628ad1b83386c2a13e0ea5572 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:26:39 -0500 Subject: [PATCH 39/39] Snowflake permission note (#6573) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## What are you changing in this pull request and why? See internal chat for context: https://dbt-labs.slack.com/archives/C02NCQ9483C/p1732724200239919?thread_ts=1732650446.311849&cid=C02NCQ9483C ## Checklist - [ ] I have reviewed the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. - [ ] The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and/or [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content) guidelines. - [ ] I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch." - [ ] The content in this PR requires a dbt release note, so I added one to the [release notes page](https://docs.getdbt.com/docs/dbt-versions/dbt-cloud-release-notes). --- 🚀 Deployment available! Here are the direct links to the updated files: - https://docs-getdbt-com-git-snowflake-permissions-dbt-labs.vercel.app/docs/cloud/connect-data-platform/connect-snowflake - https://docs-getdbt-com-git-snowflake-permissions-dbt-labs.vercel.app/docs/collaborate/explore-projects - https://docs-getdbt-com-git-snowflake-permissions-dbt-labs.vercel.app/docs/dbt-versions/release-notes - https://docs-getdbt-com-git-snowflake-permissions-dbt-labs.vercel.app/guides/snowflake-qs --------- Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> --- .../cloud/connect-data-platform/connect-snowflake.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/cloud/connect-data-platform/connect-snowflake.md b/website/docs/docs/cloud/connect-data-platform/connect-snowflake.md index 7e4bc7a9288..6b749ced186 100644 --- a/website/docs/docs/cloud/connect-data-platform/connect-snowflake.md +++ b/website/docs/docs/cloud/connect-data-platform/connect-snowflake.md @@ -5,6 +5,14 @@ description: "Configure Snowflake connection." sidebar_label: "Connect Snowflake" --- +:::note + +dbt Cloud connections and credentials inherit the permissions of the accounts configured. You can customize roles and associated permissions in Snowflake to fit your company's requirements and fine-tune access to database objects in your account. See [Snowflake permissions](/reference/database-permissions/snowflake-permissions) for more information about customizing roles in Snowflake. + +Refer to [Snowflake permissions](/reference/database-permissions/snowflake-permissions) for more information about customizing roles in Snowflake. + +::: + The following fields are required when creating a Snowflake connection | Field | Description | Examples | @@ -14,9 +22,6 @@ The following fields are required when creating a Snowflake connection | Database | The logical database to connect to and run queries against. | `analytics` | | Warehouse | The virtual warehouse to use for running queries. | `transforming` | - -**Note:** A crucial part of working with dbt atop Snowflake is ensuring that users (in development environments) and/or service accounts (in deployment to production environments) have the correct permissions to take actions on Snowflake! Here is documentation of some [example permissions to configure Snowflake access](/reference/database-permissions/snowflake-permissions). - ## Authentication methods This section describes the different authentication methods for connecting dbt Cloud to Snowflake. Configure Deployment environment (Production, Staging, General) credentials globally in the [**Connections**](/docs/deploy/deploy-environments#deployment-connection) area of **Account settings**. Individual users configure their development credentials in the [**Credentials**](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud#get-started-with-the-cloud-ide) area of their user profile.