diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 90f4938d2cb..c9b25d3b71c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,7 +10,7 @@ To learn more about the writing conventions used in the dbt Labs docs, see the [ - [ ] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) and [About versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) so my content adheres to these guidelines. - [ ] Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch." diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index eaa090a00b6..204c5c854f4 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -229,7 +229,7 @@ When referring to different sections of the IDE, use the name of the section and People make use of titles in many places like table headers, section headings (such as an H2, H3, or H4), page titles, sidebars, and so much more. -When generating titles or updating them, use sentence case. It sets a more conversational tone to the docs—making the content more approachable and creating a friendly feel. +When generating titles or updating them, use sentence case. It sets a more conversational tone to the docs— making the content more approachable and creating a friendly feel. We've defined five content types you can use when contributing to the docs (as in, writing or authoring). Learn more about title guidelines for [each content type](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-types.md). @@ -239,7 +239,7 @@ Placeholder text is something that the user should replace with their own text. Use all capital letters([screaming snake case](https://fission.codes/blog/screaming-snake-case/)) to indicate text that changes in the user interface or that the user needs to supply in a command or code snippet. Avoid surrounding it in brackets or braces, which someone might copy and use, producing an error. -Identify what the user should replace the placeholder text with in the paragraph preceding the code snippet or command. +Identify what the user should replace the placeholder text within the paragraph preceding the code snippet or command. :white_check_mark: The following is an example of configuring a connection to a Redshift database. In your YAML file, you must replace `CLUSTER_ID` with the ID assigned to you during setup: @@ -276,7 +276,7 @@ Guidelines for making lists are: - There are at least two items. - All list items follow a consistent, grammatical structure (like each item starts with a verb, each item begins with a capitalized word, each item is a sentence fragment). - Lists items don't end in commas, semicolons, or conjunctions (like "and", "or"). However, you can use periods if they’re complete sentences. -- Introduce the list with a heading or, if it's within text, as a complete sentence or as a sentence fragment followed by a colon. +- Introduce the list with a heading or, if it's within the text, as a complete sentence or as a sentence fragment followed by a colon. If the list starts getting lengthy and dense, consider presenting the same content in a different format such as a table, as separate subsections, or a new guide. @@ -286,7 +286,7 @@ A bulleted list with introductory text: > A dbt project is a directory of `.sql` and .yml` files. The directory must contain at a minimum: > -> - Models: A model is a single `.sql` file. Each model contains a single `select` statement that either transforms raw data into a dataset that is ready for analytics, or, more often, is an intermediate step in such a transformation. +> - Models: A model is a single `.sql` file. Each model contains a single `select` statement that either transforms raw data into a dataset that is ready for analytics or, more often, is an intermediate step in such a transformation. > - A project file: A `dbt_project.yml` file, which configures and defines your dbt project. A bulleted list with sentence fragments: @@ -307,10 +307,10 @@ A numbered list following an H2 heading: ## Tables Tables provide a great way to present complex information and can help the content be more scannable for users, too. -There are many ways to construct a table, like row spanning and cell splitting. Make sure the content is clear, concise, and presents well on the web page (like avoid awkward word wrapping). +There are many ways to construct a table, such as row spanning and cell splitting. The content should be clear, concise, and presented well on the web page (for example, avoid awkward word wrapping). Guidelines for making tables are: -- Introduce the table with a heading or, if it's within text, as a complete sentence or as a sentence fragment followed by a colon. +- Introduce the table with a heading or, if it's within the text, as a complete sentence or as a sentence fragment followed by a colon. - Use a header row - Use sentence case for all content, including the header row - Content can be complete sentences, sentence fragments, or single words (like `Currency`) @@ -338,7 +338,7 @@ A table following an H3 heading: > | Name | Description | Values | > | -----| ----------- | ------ | > | `-help` | Displays information on how to use the command. | Doesn't take any values. | -> | `-readable` | Print output in human readable format. | | +> | `-readable` | Print output in human-readable format. | | > | `-file` | Print output to file instead of stdout. | Name of the file. | ## Cards @@ -349,7 +349,7 @@ You can configure a card in 2, 3, 4, or 5-column grids. To maintain a good user There won't be many instances where you need to display 4 or 5 cards on the docs site. While we recommend you use 2 or 3-column grids, you can use 4 or 5-column grids in the following scenarios: -- For cards that contain little text and limited to under 15 words. (This is to make sure the text isn't squished) +- For cards that contain little text and are limited to 15 words or less. This is to make sure the text isn't squished. - Always have the `hide_table_of_contents:` frontmatter set to `true` (This hides the right table of contents). Otherwise, the text will appear squished and provide users with a bad experience. @@ -371,16 +371,16 @@ To create cards in markdown, you need to: - Add the props within the card component, including `title`,`body`,`link`,`icon`. - Close out the div by using `` -Refer to the following prop list for detailed explanation and examples: +Refer to the following prop list for detailed explanations and examples: | Prop | Type | Info | Example | | ---- | ---- | ---- | ------- | | `title` | required | The title should be clear and explain an action the user should take or a product/feature. | `title: dbt Cloud IDE` | `body` | required | The body contains the actionable or informative text for the user. You can include `` | +| `icon` | optional but recommended | You can add an icon to the card component by using any icons found in the [icons](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/static/img/icons) directory.
* Icons are added in .svg format and you must add icons in two locations: website/static/img/icons and website/static/img/icons/white. This is so users can view the icons in dark or light mode on the docs.getdbt.com site. | ` icon="pencil-paper"/>` | -The following is an example of a 4 card column: +The following is an example of a 4-card column: ```
@@ -488,9 +488,16 @@ Avoid ending a sentence with a preposition unless the rewritten sentence would s Product names, trademarks, services, and tools should be written as proper nouns, unless otherwise specified by the company or trademark owner. +As of October 2023, avoid using "dbt CLI" or "CLI" terminology when referring to the dbt Cloud CLI or dbt Core. However, if referring to the command line as a tool, CLI is acceptable. + +dbt officially provides two command line tools for running dbt commands: + +- [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) — This tool allows you to develop locally and execute dbt commands against your dbt Cloud development environment from your local command line. +- [dbt Core](https://github.com/dbt-labs/dbt-core) — This open-source tool is designed for local installation, enabling you to use dbt Core on the command line and communicate with databases through adapters. + ### Terms to use or avoid -Use industry-specific terms and research new/improved terminology. Also refer to the Inclusive Language section of this style guide for inclusive and accessible language and style. +Use industry-specific terms and research new/improved terminology. Also, refer to the Inclusive Language section of this style guide for inclusive and accessible language and style. **DO NOT** use jargon or language familiar to a small subset of readers or assume that your readers understand ALL technical terms. @@ -507,11 +514,13 @@ sign in | log in, login sign up | signup terminal | shell username | login +dbt Cloud CLI | CLI, dbt CLI +dbt Core | CLI, dbt CLI
## Links -Links embedded in documentation are about trust. Users trust that we will lead them to sites or pages related to their reading content. In order to maintain that trust, it's important that links are transparent, up-to-date, and lead to legitimate resources. +Links embedded in the documentation are about trust. Users trust that we will lead them to sites or pages related to their reading content. In order to maintain that trust, it's important that links are transparent, up-to-date, and lead to legitimate resources. ### Internal links diff --git a/website/blog/2021-11-23-how-to-upgrade-dbt-versions.md b/website/blog/2021-11-23-how-to-upgrade-dbt-versions.md index 87b3ea7bd1e..69ca0b2522c 100644 --- a/website/blog/2021-11-23-how-to-upgrade-dbt-versions.md +++ b/website/blog/2021-11-23-how-to-upgrade-dbt-versions.md @@ -62,7 +62,7 @@ As noted above, the project is on 0.16.0 right now. 0.17.2 is the final patch re > > Practically, it also lets you lock in "checkpoints" of known-stable setups. If you need to pause your migration work to deal with an urgent request, you can safely deploy what you've finished so far instead of having a bunch of unrelated half-finished changes. -Review the migration guides to get an initial indication of what changes you might need to make. For example, in [the migration guide for 0.17.0](/guides/migration/versions), there are several significant changes to dbt's functionality, but it's unlikely that all of them will apply to your project. We'll cover this more later. +Review the migration guides to get an initial indication of what changes you might need to make. For example, in [the migration guide for 0.17.0](/docs/dbt-versions/core-upgrade), there are several significant changes to dbt's functionality, but it's unlikely that all of them will apply to your project. We'll cover this more later. ## Step 2: `Add require-dbt-version` to your `dbt_project.yml` file. @@ -126,9 +126,9 @@ In this case, our example project probably has dbt 0.3.0 installed. By reviewing ### Step 5b. Fix errors, then warnings -Obviously, errors that stop you from running your dbt project at all are the most important to deal with. Let's assume that our project used a too-broadly-scoped variable in a macro file, support for which was removed in v0.17. The [migration guide explains what to do instead](/guides/migration/versions), and it's a pretty straightforward fix. +Obviously, errors that stop you from running your dbt project at all are the most important to deal with. Let's assume that our project used a too-broadly-scoped variable in a macro file, support for which was removed in v0.17. The [migration guide explains what to do instead](/docs/dbt-versions/core-upgrade), and it's a pretty straightforward fix. -Once your errors are out of the way, have a look at warnings. For example, 0.17 introduced `config-version: 2` to `dbt_project.yml`. Although it's backwards compatible for now, we know that support for the old version will be removed in a future version of dbt so we might as well deal with it now. Again, the migration guide explains [what we need to do](/guides/migration/versions), and how to take full advantage of the new functionality in the future. +Once your errors are out of the way, have a look at warnings. For example, 0.17 introduced `config-version: 2` to `dbt_project.yml`. Although it's backwards compatible for now, we know that support for the old version will be removed in a future version of dbt so we might as well deal with it now. Again, the migration guide explains [what we need to do](/docs/dbt-versions/core-upgrade), and how to take full advantage of the new functionality in the future. ### Stay focused diff --git a/website/blog/2022-08-31-august-product-update.md b/website/blog/2022-08-31-august-product-update.md index cb4077f3a06..bd9d8ee0b28 100644 --- a/website/blog/2022-08-31-august-product-update.md +++ b/website/blog/2022-08-31-august-product-update.md @@ -22,7 +22,7 @@ You’ll hear more in [Tristan’s keynote](https://coalesce.getdbt.com/agenda/k ## **What's new** -- **dbt Core v1.3 beta:** Do you use Python for analytics? The first beta prerelease of dbt Core v1.3—including support for dbt models written in Python—is [ready to explore](https://docs.getdbt.com/guides/migration/versions/upgrading-to-v1.3)! Check it out, and read more about dbt supported Python models [in our docs](/docs/build/python-models). +- **dbt Core v1.3 beta:** Do you use Python for analytics? The first beta prerelease of dbt Core v1.3—including support for dbt models written in Python—is [ready to explore](https://docs.getdbt.com/docs/dbt-versions/core-upgrade/upgrading-to-v1.3)! Check it out, and read more about dbt supported Python models [in our docs](/docs/build/python-models). - **Technology Partner Program:** We just launched our new [Technology Partner Program](https://www.getdbt.com/blog/dbt-labs-technology-partner-program/) with 40+ friends in the Modern Data Stack to provide consistent support for seamless integrations joint-users can trust. Check our new [dbt Cloud integrations page](http://www.getdbt.com/product/integrations) for what’s available today! - **Single-tenant users:** dbt Cloud v1.1.60 is now available on dbt Cloud Enterprise. diff --git a/website/dbt-versions.js b/website/dbt-versions.js index 910c4a6ef4d..be55c893041 100644 --- a/website/dbt-versions.js +++ b/website/dbt-versions.js @@ -1,8 +1,7 @@ exports.versions = [ { version: "1.7", - EOLDate: "2024-07-31", - isPrerelease: "true" + EOLDate: "2024-10-30", }, { version: "1.6", diff --git a/website/docs/docs/build/project-variables.md b/website/docs/docs/build/project-variables.md index 1fe45b18ac0..59d6be49b17 100644 --- a/website/docs/docs/build/project-variables.md +++ b/website/docs/docs/build/project-variables.md @@ -28,7 +28,7 @@ Jinja is not supported within the `vars` config, and all values will be interpre :::info New in v0.17.0 The syntax for specifying vars in the `dbt_project.yml` file has changed in -dbt v0.17.0. See the [migration guide](/guides/migration/versions) +dbt v0.17.0. See the [migration guide](/docs/dbt-versions/core-upgrade) for more information on these changes. ::: diff --git a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md index caeb0203a5e..4fcabbb3585 100644 --- a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md +++ b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md @@ -25,3 +25,13 @@ dbt Cloud is [hosted](/docs/cloud/about-cloud/architecture) in multiple regions There are two ways to view your dbt Cloud IP addresses: - If no projects exist in the account, create a new project, and the IP addresses will be displayed during the **Configure your environment** steps. - If you have an existing project, navigate to **Account Settings** and ensure you are in the **Projects** pane. Click on a project name, and the **Project Settings** window will open. Locate the **Connection** field and click on the name. Scroll down to the **Settings**, and the first text block lists your IP addresses. + +### Static IP addresses + +dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructure for operations. While we can offer static URLs for access, we cannot provide a list of IP addresses to configure connections due to the nature of AWS cloud services. + +* Dynamic IP addresses — dbt Cloud infrastructure uses Amazon Web Services (AWS). dbt Cloud offers static URLs for streamlined access, but the dynamic nature of cloud services means the underlying IP addresses change occasionally. AWS manages the IP ranges and may change them according to their operational and security needs. + +* Using hostnames for consistent access — To ensure uninterrupted access, we recommend that you dbt Cloud services using hostnames. Hostnames provide a consistent reference point, regardless of any changes in underlying IP addresses. We are aligning with an industry-standard practice employed by organizations such as Snowflake. + +* Optimizing VPN connections &mdash: You should integrate a proxy alongside VPN for users who leverage VPN connections. This strategy enables steady IP addresses for your connections, facilitating smooth traffic flow through the VPN and onward to dbt Cloud. By employing a proxy and a VPN, you can direct traffic through the VPN and then to dbt Cloud. It's crucial to set up the proxy if you need to integrate with additional services. diff --git a/website/docs/docs/cloud/connect-data-platform/connect-databricks.md b/website/docs/docs/cloud/connect-data-platform/connect-databricks.md index b66f5890c61..032246ad16a 100644 --- a/website/docs/docs/cloud/connect-data-platform/connect-databricks.md +++ b/website/docs/docs/cloud/connect-data-platform/connect-databricks.md @@ -26,6 +26,8 @@ Unity Catalog allows Databricks users to centrally manage all data assets, simpl To learn how to optimize performance with data platform-specific configurations in dbt Cloud, refer to [Databricks-specific configuration](/reference/resource-configs/databricks-configs). +To grant users or roles database permissions (access rights and privileges), refer to the [example permissions](/reference/database-permissions/databricks-permissions) page. + To set up the Databricks connection, supply the following fields: diff --git a/website/docs/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb.md b/website/docs/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb.md index dae0ee1d178..ee5b09e83ef 100644 --- a/website/docs/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb.md +++ b/website/docs/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb.md @@ -64,3 +64,5 @@ The Bastion server should now be ready for dbt Cloud to use as a tunnel into the ## Configuration To learn how to optimize performance with data platform-specific configurations in dbt Cloud, refer to [Redshift-specific configuration](/reference/resource-configs/redshift-configs). + +To grant users or roles database permissions (access rights and privileges), refer to the [Redshift permissions](/reference/database-permissions/redshift-permissions) page or [Postgres permissions](/reference/database-permissions/postgres-permissions) page. 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 62a58f6e1c5..5f1c4cae725 100644 --- a/website/docs/docs/cloud/connect-data-platform/connect-snowflake.md +++ b/website/docs/docs/cloud/connect-data-platform/connect-snowflake.md @@ -15,7 +15,7 @@ The following fields are required when creating a Snowflake connection | 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/snowflake-permissions). +**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). ### Username / Password diff --git a/website/docs/docs/cloud/manage-access/set-up-sso-saml-2.0.md b/website/docs/docs/cloud/manage-access/set-up-sso-saml-2.0.md index 5ccb2600005..ba925fa2c24 100644 --- a/website/docs/docs/cloud/manage-access/set-up-sso-saml-2.0.md +++ b/website/docs/docs/cloud/manage-access/set-up-sso-saml-2.0.md @@ -89,7 +89,7 @@ them to complete setup in dbt Cloud. ### Finish setup -After creating the Okta application, follow the instructions in the [dbt Cloud Setup](#dbt-cloud-setup) +After creating the application, follow the instructions in the [dbt Cloud Setup](#dbt-cloud-setup) section to complete the integration. ## Okta integration diff --git a/website/docs/docs/core/connect-data-platform/teradata-setup.md b/website/docs/docs/core/connect-data-platform/teradata-setup.md index bcda41c8fe9..1ba8e506b88 100644 --- a/website/docs/docs/core/connect-data-platform/teradata-setup.md +++ b/website/docs/docs/core/connect-data-platform/teradata-setup.md @@ -56,11 +56,11 @@ pip is the easiest way to install the adapter: |1.5.x | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |1.6.x | ❌ | ❌ | ✅ | ✅ | ✅ | ✅ -

Python compatibility

+

dbt dependent packages version compatibility

-| dbt-teradta | dbt-core | dbt-teradata-util | dbt-util | -|-------------|------------|-------------------|----------------| -| 1.2.x | 1.2.x | 0.1.0 | 0.9.x or below | +| dbt-teradata | dbt-core | dbt-teradata-util | dbt-util | +|--------------|------------|-------------------|----------------| +| 1.2.x | 1.2.x | 0.1.0 | 0.9.x or below |

Configuring {frontMatter.meta.pypi_package}

@@ -244,4 +244,4 @@ The adapter was originally created by [Doug Beatty](https://github.com/dbeatty10 ## License -The adapter is published using Apache-2.0 License. Please see the link (ADD LINK HERE) for terms and conditions, such as creating derivative work and the support model. +The adapter is published using Apache-2.0 License. Refer to the [terms and conditions](https://github.com/dbt-labs/dbt-core/blob/main/License.md) to understand items such as creating derivative work and the support model. diff --git a/website/docs/docs/core/installation-overview.md b/website/docs/docs/core/installation-overview.md index 25628b76358..cb1df26b0f8 100644 --- a/website/docs/docs/core/installation-overview.md +++ b/website/docs/docs/core/installation-overview.md @@ -23,7 +23,7 @@ Most command-line tools, including dbt, have a `--help` flag that you can use to ## Upgrading dbt Core -dbt provides a number of resources for understanding [general best practices](/blog/upgrade-dbt-without-fear) while upgrading your dbt project as well as detailed [migration guides](/guides/migration/versions/upgrading-to-v1.4) highlighting the changes required for each minor and major release, and [core versions](/docs/dbt-versions/core) +dbt provides a number of resources for understanding [general best practices](/blog/upgrade-dbt-without-fear) while upgrading your dbt project as well as detailed [migration guides](/docs/dbt-versions/core-upgrade/upgrading-to-v1.4) highlighting the changes required for each minor and major release, and [core versions](/docs/dbt-versions/core) - [Upgrade Homebrew](/docs/core/homebrew-install#upgrading-dbt-and-your-adapter) - [Upgrade `pip`](/docs/core/pip-install#change-dbt-core-versions) diff --git a/website/docs/guides/migration/versions/00-upgrading-to-v1.7.md b/website/docs/docs/dbt-versions/core-upgrade/00-upgrading-to-v1.7.md similarity index 96% rename from website/docs/guides/migration/versions/00-upgrading-to-v1.7.md rename to website/docs/docs/dbt-versions/core-upgrade/00-upgrading-to-v1.7.md index f350e8955f7..9ebd3c64cf3 100644 --- a/website/docs/guides/migration/versions/00-upgrading-to-v1.7.md +++ b/website/docs/docs/dbt-versions/core-upgrade/00-upgrading-to-v1.7.md @@ -1,8 +1,14 @@ --- -title: "Upgrading to v1.7 (beta)" +title: "Upgrading to v1.7 (latest)" +id: upgrading-to-v1.7 description: New features and changes in dbt Core v1.7 +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + ## Resources - [Changelog](https://github.com/dbt-labs/dbt-core/blob/8aaed0e29f9560bc53d9d3e88325a9597318e375/CHANGELOG.md) diff --git a/website/docs/guides/migration/versions/01-upgrading-to-v1.6.md b/website/docs/docs/dbt-versions/core-upgrade/01-upgrading-to-v1.6.md similarity index 97% rename from website/docs/guides/migration/versions/01-upgrading-to-v1.6.md rename to website/docs/docs/dbt-versions/core-upgrade/01-upgrading-to-v1.6.md index 50b0ca8bc58..f62b6308ce6 100644 --- a/website/docs/guides/migration/versions/01-upgrading-to-v1.6.md +++ b/website/docs/docs/dbt-versions/core-upgrade/01-upgrading-to-v1.6.md @@ -1,8 +1,14 @@ --- -title: "Upgrading to v1.6 (latest)" +title: "Upgrading to v1.6" description: New features and changes in dbt Core v1.6 +id: "upgrading-to-v1.6" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + dbt Core v1.6 has three significant areas of focus: 1. Next milestone of [multi-project deployments](https://github.com/dbt-labs/dbt-core/discussions/6725): improvements to contracts, groups/access, versions; and building blocks for cross-project `ref` 1. Semantic layer re-launch: dbt Core and [MetricFlow](https://docs.getdbt.com/docs/build/about-metricflow) integration diff --git a/website/docs/guides/migration/versions/02-upgrading-to-v1.5.md b/website/docs/docs/dbt-versions/core-upgrade/02-upgrading-to-v1.5.md similarity index 98% rename from website/docs/guides/migration/versions/02-upgrading-to-v1.5.md rename to website/docs/docs/dbt-versions/core-upgrade/02-upgrading-to-v1.5.md index a6ac97246ab..dded8a690fe 100644 --- a/website/docs/guides/migration/versions/02-upgrading-to-v1.5.md +++ b/website/docs/docs/dbt-versions/core-upgrade/02-upgrading-to-v1.5.md @@ -1,8 +1,14 @@ --- title: "Upgrading to v1.5" description: New features and changes in dbt Core v1.5 +id: "upgrading-to-v1.5" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + dbt Core v1.5 is a feature release, with two significant additions: 1. [**Model governance**](/docs/collaborate/govern/about-model-governance) — access, contracts, versions — the first phase of [multi-project deployments](https://github.com/dbt-labs/dbt-core/discussions/6725) 2. A Python entry point for [**programmatic invocations**](/reference/programmatic-invocations), at parity with the CLI diff --git a/website/docs/guides/migration/versions/03-upgrading-to-dbt-utils-v1.0.md b/website/docs/docs/dbt-versions/core-upgrade/03-upgrading-to-dbt-utils-v1.0.md similarity index 99% rename from website/docs/guides/migration/versions/03-upgrading-to-dbt-utils-v1.0.md rename to website/docs/docs/dbt-versions/core-upgrade/03-upgrading-to-dbt-utils-v1.0.md index 72c6fc3c968..a7b302c9a58 100644 --- a/website/docs/guides/migration/versions/03-upgrading-to-dbt-utils-v1.0.md +++ b/website/docs/docs/dbt-versions/core-upgrade/03-upgrading-to-dbt-utils-v1.0.md @@ -3,6 +3,10 @@ title: "Upgrading to dbt utils v1.0" description: New features and breaking changes to consider as you upgrade to dbt utils v1.0. --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + # Upgrading to dbt utils v1.0 For the first time, [dbt utils](https://hub.getdbt.com/dbt-labs/dbt_utils/latest/) is crossing the major version boundary. From [last month’s blog post](https://www.getdbt.com/blog/announcing-dbt-v1.3-and-utils/): diff --git a/website/docs/guides/migration/versions/04-upgrading-to-v1.4.md b/website/docs/docs/dbt-versions/core-upgrade/04-upgrading-to-v1.4.md similarity index 97% rename from website/docs/guides/migration/versions/04-upgrading-to-v1.4.md rename to website/docs/docs/dbt-versions/core-upgrade/04-upgrading-to-v1.4.md index 3537eb1677a..6c6d96b2326 100644 --- a/website/docs/guides/migration/versions/04-upgrading-to-v1.4.md +++ b/website/docs/docs/dbt-versions/core-upgrade/04-upgrading-to-v1.4.md @@ -1,7 +1,14 @@ --- title: "Upgrading to v1.4" description: New features and changes in dbt Core v1.4 +id: "upgrading-to-v1.4" +displayed_sidebar: "docs" --- + +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + ### Resources - [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.4.latest/CHANGELOG.md) diff --git a/website/docs/guides/migration/versions/05-upgrading-to-v1.3.md b/website/docs/docs/dbt-versions/core-upgrade/05-upgrading-to-v1.3.md similarity index 97% rename from website/docs/guides/migration/versions/05-upgrading-to-v1.3.md rename to website/docs/docs/dbt-versions/core-upgrade/05-upgrading-to-v1.3.md index 5fdf559a267..f66d9bb9706 100644 --- a/website/docs/guides/migration/versions/05-upgrading-to-v1.3.md +++ b/website/docs/docs/dbt-versions/core-upgrade/05-upgrading-to-v1.3.md @@ -1,7 +1,14 @@ --- title: "Upgrading to v1.3" description: New features and changes in dbt Core v1.3 +id: "upgrading-to-v1.3" +displayed_sidebar: "docs" --- + +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + ### Resources - [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.3.latest/CHANGELOG.md) diff --git a/website/docs/guides/migration/versions/06-upgrading-to-v1.2.md b/website/docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.2.md similarity index 96% rename from website/docs/guides/migration/versions/06-upgrading-to-v1.2.md rename to website/docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.2.md index 91ffadf9093..16825ff4e2b 100644 --- a/website/docs/guides/migration/versions/06-upgrading-to-v1.2.md +++ b/website/docs/docs/dbt-versions/core-upgrade/06-upgrading-to-v1.2.md @@ -1,7 +1,14 @@ --- title: "Upgrading to v1.2" description: New features and changes in dbt Core v1.2 +id: "upgrading-to-v1.2" +displayed_sidebar: "docs" --- + +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + ### Resources - [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.2.latest/CHANGELOG.md) diff --git a/website/docs/guides/migration/versions/07-upgrading-to-v1.1.md b/website/docs/docs/dbt-versions/core-upgrade/07-upgrading-to-v1.1.md similarity index 97% rename from website/docs/guides/migration/versions/07-upgrading-to-v1.1.md rename to website/docs/docs/dbt-versions/core-upgrade/07-upgrading-to-v1.1.md index 131ecc97657..7819709558e 100644 --- a/website/docs/guides/migration/versions/07-upgrading-to-v1.1.md +++ b/website/docs/docs/dbt-versions/core-upgrade/07-upgrading-to-v1.1.md @@ -1,7 +1,14 @@ --- title: "Upgrading to v1.1" description: New features and changes in dbt Core v1.1 +id: "upgrading-to-v1.1" +displayed_sidebar: "docs" --- + +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + ### Resources - [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.1.latest/CHANGELOG.md) diff --git a/website/docs/guides/migration/versions/08-upgrading-to-v1.0.md b/website/docs/docs/dbt-versions/core-upgrade/08-upgrading-to-v1.0.md similarity index 98% rename from website/docs/guides/migration/versions/08-upgrading-to-v1.0.md rename to website/docs/docs/dbt-versions/core-upgrade/08-upgrading-to-v1.0.md index 9fc7991c087..7c67a1849a1 100644 --- a/website/docs/guides/migration/versions/08-upgrading-to-v1.0.md +++ b/website/docs/docs/dbt-versions/core-upgrade/08-upgrading-to-v1.0.md @@ -1,7 +1,14 @@ --- title: "Upgrading to v1.0" description: New features and changes in dbt Core v1.0 +id: "upgrading-to-v1.0" +displayed_sidebar: "docs" --- + +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + ### Resources - [Discourse](https://discourse.getdbt.com/t/3180) diff --git a/website/docs/guides/migration/versions/09-upgrading-to-v0.21.md b/website/docs/docs/dbt-versions/core-upgrade/09-upgrading-to-v0.21.md similarity index 97% rename from website/docs/guides/migration/versions/09-upgrading-to-v0.21.md rename to website/docs/docs/dbt-versions/core-upgrade/09-upgrading-to-v0.21.md index e5fbdf3fc7c..d5b429132cd 100644 --- a/website/docs/guides/migration/versions/09-upgrading-to-v0.21.md +++ b/website/docs/docs/dbt-versions/core-upgrade/09-upgrading-to-v0.21.md @@ -1,8 +1,15 @@ --- title: "Upgrading to v0.21" +id: "upgrading-to-v0.21" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + + :::caution Unsupported version dbt Core v0.21 has reached the end of critical support. No new patch versions will be released, and it will stop running in dbt Cloud on June 30, 2022. Read ["About dbt Core versions"](/docs/dbt-versions/core) for more details. ::: diff --git a/website/docs/guides/migration/versions/10-upgrading-to-v0.20.md b/website/docs/docs/dbt-versions/core-upgrade/10-upgrading-to-v0.20.md similarity index 96% rename from website/docs/guides/migration/versions/10-upgrading-to-v0.20.md rename to website/docs/docs/dbt-versions/core-upgrade/10-upgrading-to-v0.20.md index 8b33bfa3879..61a7120370a 100644 --- a/website/docs/guides/migration/versions/10-upgrading-to-v0.20.md +++ b/website/docs/docs/dbt-versions/core-upgrade/10-upgrading-to-v0.20.md @@ -1,8 +1,13 @@ --- title: "Upgrading to v0.20" - +id: "upgrading-to-v0.20" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + :::caution Unsupported version dbt Core v0.20 has reached the end of critical support. No new patch versions will be released, and it will stop running in dbt Cloud on June 30, 2022. Read ["About dbt Core versions"](/docs/dbt-versions/core) for more details. ::: diff --git a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-11-0.md b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-11-0.md similarity index 95% rename from website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-11-0.md rename to website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-11-0.md index e307c46fdf9..e91dde4c923 100644 --- a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-11-0.md +++ b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-11-0.md @@ -1,8 +1,13 @@ --- title: "Upgrading to 0.11.0" id: "upgrading-to-0-11-0" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + ## Schema.yml v2 syntax dbt v0.11.0 adds an auto-generated docs site to your dbt project. To make effective use of the documentation site, you'll need to use the new "version 2" schema.yml syntax. For a full explanation of the version 2 syntax, check out the [schema.yml Files](/reference/configs-and-properties) section of the documentation. diff --git a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-12-0.md b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-12-0.md similarity index 76% rename from website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-12-0.md rename to website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-12-0.md index 60900d3c1a4..b3d4e9d9bcb 100644 --- a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-12-0.md +++ b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-12-0.md @@ -1,8 +1,13 @@ --- title: "Upgrading to 0.12.0" id: "upgrading-to-0-12-0" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + ## End of support Support for the `repositories:` block in `dbt_project.yml` (deprecated in 0.10.0) was removed. diff --git a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-13-0.md b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-13-0.md similarity index 94% rename from website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-13-0.md rename to website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-13-0.md index 14a70e177e8..bb15d1a73b0 100644 --- a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-13-0.md +++ b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-13-0.md @@ -1,8 +1,13 @@ --- title: "Upgrading to 0.13.0" id: "upgrading-to-0-13-0" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + ## Breaking changes ### on-run-start and on-run-end diff --git a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-14-0.md b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-14-0.md similarity index 99% rename from website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-14-0.md rename to website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-14-0.md index 3b9c8560230..036a9a2aedf 100644 --- a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-14-0.md +++ b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-14-0.md @@ -1,8 +1,13 @@ --- title: "Upgrading to 0.14.0" id: "upgrading-to-0-14-0" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + This guide outlines migration instructions for: 1. [Upgrading archives to snapshots](#upgrading-to-snapshot-blocks) diff --git a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-14-1.md b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-14-1.md similarity index 98% rename from website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-14-1.md rename to website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-14-1.md index a81740d5a68..215385acf0f 100644 --- a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-14-1.md +++ b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-14-1.md @@ -1,8 +1,13 @@ --- title: "Upgrading to 0.14.1" id: "upgrading-to-0-14-1" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + The dbt v0.14.1 release _does not_ contain any breaking code changes for users upgrading from v0.14.0. If you are upgrading from a version less than 0.14.0, consult the [Upgrading to 0.14.0](upgrading-to-0-14-0) migration guide. The following section contains important information for users of the `check` strategy on Snowflake and BigQuery. Action may be required in your database. ## Changes to the Snapshot "check" algorithm diff --git a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-15-0.md b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-15-0.md similarity index 93% rename from website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-15-0.md rename to website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-15-0.md index 02ab297c07a..6dd2b6fb9eb 100644 --- a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-15-0.md +++ b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-15-0.md @@ -1,10 +1,16 @@ --- title: "Upgrading to 0.15.0" id: "upgrading-to-0-15-0" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + The dbt v0.15.0 release contains a handful of breaking code changes for users upgrading from v0.14.0. + ## Breaking changes ### Stricter YML compilation diff --git a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-16-0.md b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-16-0.md similarity index 98% rename from website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-16-0.md rename to website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-16-0.md index a34f23c4c89..076e6fc4e88 100644 --- a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-16-0.md +++ b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-16-0.md @@ -1,8 +1,13 @@ --- title: "Upgrading to 0.16.0" id: "upgrading-to-0-16-0" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + dbt v0.16.0 contains many new features, bug fixes, and improvements. This guide covers all of the important information to consider when upgrading from an earlier version of dbt to 0.16.0. diff --git a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-17-0.md b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-17-0.md similarity index 98% rename from website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-17-0.md rename to website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-17-0.md index 1f891ebc0f4..5b863777df9 100644 --- a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-17-0.md +++ b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-17-0.md @@ -1,9 +1,14 @@ --- title: "Upgrading to 0.17.0" id: "upgrading-to-0-17-0" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + dbt v0.17.0 makes compilation more consistent, improves performance, and fixes a number of bugs. ## Articles: diff --git a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-18-0.md b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-18-0.md similarity index 97% rename from website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-18-0.md rename to website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-18-0.md index 8092ad807b8..545bfd41ac6 100644 --- a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-18-0.md +++ b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-18-0.md @@ -1,8 +1,13 @@ --- title: "Upgrading to 0.18.0" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + ### Resources - [Changelog](https://github.com/dbt-labs/dbt-core/blob/dev/marian-anderson/CHANGELOG.md) diff --git a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-19-0.md b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-19-0.md similarity index 96% rename from website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-19-0.md rename to website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-19-0.md index 0dd428780e0..db825d8af9c 100644 --- a/website/docs/guides/migration/versions/11-Older versions/upgrading-to-0-19-0.md +++ b/website/docs/docs/dbt-versions/core-upgrade/11-Older versions/upgrading-to-0-19-0.md @@ -1,8 +1,13 @@ --- title: "Upgrading to 0.19.0" +displayed_sidebar: "docs" --- +import UpgradeMove from '/snippets/_upgrade-move.md'; + + + ### Resources - [Discourse](https://discourse.getdbt.com/t/1951) @@ -23,7 +28,7 @@ See the docs below for more details. We don't expect these to require action in #### Deprecations -Removed support for `config-version: 1` of dbt_project.yml, which was deprecated in v0.17.0. Use `config-version: 2` in all projects and installed packages. Otherwise, dbt will raise an error. See docs on [config-version](/reference/project-configs/config-version) and the [v0.17.0 Migration Guide](/guides/migration/versions) for details. +Removed support for `config-version: 1` of dbt_project.yml, which was deprecated in v0.17.0. Use `config-version: 2` in all projects and installed packages. Otherwise, dbt will raise an error. See docs on [config-version](/reference/project-configs/config-version) and the [v0.17.0 Migration Guide](/docs/dbt-versions/core-upgrade) for details. ### For dbt plugin maintainers diff --git a/website/docs/docs/dbt-versions/release-notes/04-Sept-2023/product-docs-summer-rn.md b/website/docs/docs/dbt-versions/release-notes/04-Sept-2023/product-docs-summer-rn.md index a647bb5f585..d8148542eef 100644 --- a/website/docs/docs/dbt-versions/release-notes/04-Sept-2023/product-docs-summer-rn.md +++ b/website/docs/docs/dbt-versions/release-notes/04-Sept-2023/product-docs-summer-rn.md @@ -35,7 +35,7 @@ You can provide feedback by opening a pull request or issue in [our repo](https: * Added a section to introduce a new beta feature [**Extended Attributes**](/docs/dbt-cloud-environments#extended-attributes-beta), which allows users to set a flexible `profiles.yml` snippet in their dbt Cloud Environment settings. ## 🎯 Core projects -* We released [dbt 1.6](/guides/migration/versions/upgrading-to-v1.6)! We added docs for the new commands `dbt retry` and `dbt clone` +* We released [dbt 1.6](/docs/dbt-versions/core-upgrade/upgrading-to-v1.6)! We added docs for the new commands `dbt retry` and `dbt clone` ## New 📚 Guides, ✏️ blog posts, and FAQs * Check out how these community members use the dbt community in the [Community spotlight](/community/spotlight). diff --git a/website/docs/docs/dbt-versions/release-notes/09-April-2023/product-docs.md b/website/docs/docs/dbt-versions/release-notes/09-April-2023/product-docs.md index d30bcf85b99..d78040ea7e4 100644 --- a/website/docs/docs/dbt-versions/release-notes/09-April-2023/product-docs.md +++ b/website/docs/docs/dbt-versions/release-notes/09-April-2023/product-docs.md @@ -26,7 +26,7 @@ Hello from the dbt Docs team: @mirnawong1, @matthewshaver, @nghi-ly, and @runleo ## 🎯 Core projects - Clearer descriptions in the [Jinja functions page](/reference/dbt-jinja-functions), that improve content for each card.  -- [1.5 Docs](/guides/migration/versions/upgrading-to-v1.5) have been released as an RC! +- [1.5 Docs](/docs/dbt-versions/core-upgrade/upgrading-to-v1.5) have been released as an RC! - See the beautiful [work captured in Core v 1.5](https://github.com/dbt-labs/docs.getdbt.com/issues?q=is%3Aissue+label%3A%22dbt-core+v1.5%22+is%3Aclosed). ## New 📚 Guides and ✏️ blog posts diff --git a/website/docs/docs/dbt-versions/release-notes/10-Mar-2023/1.0-deprecation.md b/website/docs/docs/dbt-versions/release-notes/10-Mar-2023/1.0-deprecation.md index b11bf702330..6b6f646e40e 100644 --- a/website/docs/docs/dbt-versions/release-notes/10-Mar-2023/1.0-deprecation.md +++ b/website/docs/docs/dbt-versions/release-notes/10-Mar-2023/1.0-deprecation.md @@ -17,5 +17,5 @@ Refer to some additional info and resources to help you upgrade your dbt version - [How to upgrade dbt without fear](https://docs.getdbt.com/blog/upgrade-dbt-without-fear) - [Upgrade Q&A on breaking changes](/docs/dbt-versions/upgrade-core-in-cloud#upgrading-legacy-versions-under-10) -- [Version migration guides](/guides/migration/versions) +- [Version migration guides](/docs/dbt-versions/core-upgrade) diff --git a/website/docs/docs/dbt-versions/release-notes/35-dbt-cloud-changelog-2019-2020.md b/website/docs/docs/dbt-versions/release-notes/35-dbt-cloud-changelog-2019-2020.md index b8e15b993de..a6b68cf9d51 100644 --- a/website/docs/docs/dbt-versions/release-notes/35-dbt-cloud-changelog-2019-2020.md +++ b/website/docs/docs/dbt-versions/release-notes/35-dbt-cloud-changelog-2019-2020.md @@ -197,7 +197,7 @@ initial support for a GitLab integration and self-service RBAC configuration. ## dbt Cloud v1.1.7 [September 3, 2020] This release adds a Release Candidate for [dbt -v0.18.0](/guides/migration/versions) and +v0.18.0](/docs/dbt-versions/core-upgrade) and includes bugfixes and improvements to the Cloud IDE and job scheduler. diff --git a/website/docs/docs/dbt-versions/upgrade-core-in-cloud.md b/website/docs/docs/dbt-versions/upgrade-core-in-cloud.md index d143aab5ef1..e46294029ec 100644 --- a/website/docs/docs/dbt-versions/upgrade-core-in-cloud.md +++ b/website/docs/docs/dbt-versions/upgrade-core-in-cloud.md @@ -47,7 +47,7 @@ For more on version support and future releases, see [Understanding dbt Core ver #### Need help upgrading? -If you want more advice on how to upgrade your dbt projects, check out our [migration guides](/guides/migration/versions/) and our [upgrading Q&A page](/docs/dbt-versions/upgrade-core-in-cloud#upgrading-legacy-versions-under-10). +If you want more advice on how to upgrade your dbt projects, check out our [migration guides](/docs/dbt-versions/core-upgrade/) and our [upgrading Q&A page](/docs/dbt-versions/upgrade-core-in-cloud#upgrading-legacy-versions-under-10). ## Upgrading legacy versions under 1.0 @@ -96,7 +96,7 @@ clean-targets: - Do you have custom scripts that parse dbt artifacts? - (BigQuery only) Do you use dbt's legacy capabilities around ingestion-time-partitioned tables? -If you believe your project might be affected, read more details in the migration guide [here](/guides/migration/versions/upgrading-to-v1.0). +If you believe your project might be affected, read more details in the migration guide [here](/docs/dbt-versions/core-upgrade/upgrading-to-v1.0). @@ -109,7 +109,7 @@ If you believe your project might be affected, read more details in the migratio - Do you have custom scripts that parse dbt JSON artifacts? - (Snowflake only) Do you have custom macros or materializations that depend on using transactions, such as statement blocks with `auto_begin=True`? -If you believe your project might be affected, read more details in the migration guide [here](/guides/migration/versions). +If you believe your project might be affected, read more details in the migration guide [here](/docs/dbt-versions/core-upgrade). @@ -123,7 +123,7 @@ If you believe your project might be affected, read more details in the migratio - Does your project use `adapter.dispatch` or the `spark_utils` package? - Do you have custom scripts that parse dbt JSON artifacts? -If you believe your project might be affected, read more details in the migration guide [here](/guides/migration/versions). +If you believe your project might be affected, read more details in the migration guide [here](/docs/dbt-versions/core-upgrade). @@ -146,7 +146,7 @@ See **Upgrading to v0.17.latest from v0.16** below for more details. - Do you have custom scripts that parse dbt JSON artifacts? - Do you have any custom materializations? -If you believe your project might be affected, read more details in the migration guide [here](/guides/migration/versions). +If you believe your project might be affected, read more details in the migration guide [here](/docs/dbt-versions/core-upgrade). @@ -157,7 +157,7 @@ If you believe your project might be affected, read more details in the migratio - Do you directly call `adapter_macro`? -If you believe your project might be affected, read more details in the migration guide [here](/guides/migration/versions). +If you believe your project might be affected, read more details in the migration guide [here](/docs/dbt-versions/core-upgrade). @@ -235,7 +235,7 @@ models: ``` -If you believe your project might be affected, read more details in the migration guide [here](/guides/migration/versions). +If you believe your project might be affected, read more details in the migration guide [here](/docs/dbt-versions/core-upgrade). @@ -247,7 +247,7 @@ If you believe your project might be affected, read more details in the migratio - Do you use the custom `generate_schema_name` macro? - Do you use `partition_by` config for BigQuery models? -If you believe your project might be affected, read more details in the migration guide [here](/guides/migration/versions). +If you believe your project might be affected, read more details in the migration guide [here](/docs/dbt-versions/core-upgrade). @@ -259,7 +259,7 @@ If you believe your project might be affected, read more details in the migratio - Do you have a custom materialization? - Do you have a macro that accesses `Relations` directly? -If you believe your project might be affected, read more details in the migration guide [here](/guides/migration/versions). +If you believe your project might be affected, read more details in the migration guide [here](/docs/dbt-versions/core-upgrade).
@@ -270,7 +270,7 @@ If you believe your project might be affected, read more details in the migratio - Do you use the custom `generate_schema_name` macro? - Do you use the `—non-destructive` flag? -If you believe your project might be affected, read more details in the migration guide [here](/guides/migration/versions). +If you believe your project might be affected, read more details in the migration guide [here](/docs/dbt-versions/core-upgrade).
diff --git a/website/docs/docs/use-dbt-semantic-layer/sl-architecture.md b/website/docs/docs/use-dbt-semantic-layer/sl-architecture.md index dc75016eb91..152821b7e59 100644 --- a/website/docs/docs/use-dbt-semantic-layer/sl-architecture.md +++ b/website/docs/docs/use-dbt-semantic-layer/sl-architecture.md @@ -19,12 +19,12 @@ The dbt Semantic Layer allows you to define metrics and use various interfaces t The dbt Semantic Layer includes the following components: -| Components | Information | Developer plans | Team plans | Enterprise plans | License | +| Components | Information | dbt Core users | Developer plans | Team plans | Enterprise plans | License | | --- | --- | :---: | :---: | :---: | --- | -| **[MetricFlow](/docs/build/about-metricflow)** | MetricFlow in dbt allows users to centrally define their semantic models and metrics with YAML specifications. | ✅ | ✅ | ✅ | BSL package (code is source available) | -| **MetricFlow Server**| A proprietary server that takes metric requests and generates optimized SQL for the specific data platform. | ❌ | ✅ | ✅ | Proprietary, Cloud (Team & Enterprise)| -| **Semantic Layer Gateway** | A service that passes queries to MetricFlow server and executes the SQL generated by MetricFlow against the data platform|

❌| ✅ | ✅ | Proprietary, Cloud (Team & Enterprise) | -| **Semantic Layer APIs** | The interfaces that allow users to submit metric queries using the GraphQL and JDBC APIs. They also serve as the foundation for building first-class integrations with various tools. | ❌ | ✅ | ✅ | Proprietary, Cloud (Team & Enterprise)| +| **[MetricFlow](/docs/build/about-metricflow)** | MetricFlow in dbt allows users to centrally define their semantic models and metrics with YAML specifications. | ✅ | ✅ | ✅ | ✅ | BSL package (code is source available) | +| **MetricFlow Server**| A proprietary server that takes metric requests and generates optimized SQL for the specific data platform. | ❌ | ❌ | ✅ | ✅ | Proprietary, Cloud (Team & Enterprise)| +| **Semantic Layer Gateway** | A service that passes queries to the MetricFlow server and executes the SQL generated by MetricFlow against the data platform|

❌ | ❌ |✅ | ✅ | Proprietary, Cloud (Team & Enterprise) | +| **Semantic Layer APIs** | The interfaces allow users to submit metric queries using GraphQL and JDBC APIs. They also serve as the foundation for building first-class integrations with various tools. | ❌ | ❌ | ✅ | ✅ | Proprietary, Cloud (Team & Enterprise)| ## Related questions diff --git a/website/docs/docs/use-dbt-semantic-layer/tableau.md b/website/docs/docs/use-dbt-semantic-layer/tableau.md index ae1e4ae3bc5..c93643354aa 100644 --- a/website/docs/docs/use-dbt-semantic-layer/tableau.md +++ b/website/docs/docs/use-dbt-semantic-layer/tableau.md @@ -17,6 +17,7 @@ This integration provides a live connection to the dbt Semantic Layer through Ta ## Prerequisites 1. You must have [Tableau Desktop](https://www.tableau.com/en-gb/products/desktop) installed with version 2021.1 or greater + - Note that Tableau Online does not currently support custom connectors natively. 2. Log in to Tableau Desktop using either your license or the login details you use for Tableau Server or Tableau Online. 3. You need your dbt Cloud host, [Environment ID](/docs/use-dbt-semantic-layer/setup-sl#set-up-dbt-semantic-layer) and [service token](/docs/dbt-cloud-apis/service-tokens) to log in. This account should be set up with the dbt Semantic Layer. 4. You must have a dbt Cloud Team or Enterprise [account](https://www.getdbt.com/pricing) and multi-tenant [deployment](/docs/cloud/about-cloud/regions-ip-addresses). (Single-Tenant coming soon) @@ -24,7 +25,7 @@ This integration provides a live connection to the dbt Semantic Layer through Ta ## Installing -1. Download our [connector file](https://github.com/dbt-labs/semantic-layer-tableau-connector/releases/download/v1.0.0/dbt_semantic_layer.taco) locally and add it to your default folder: +1. Download the GitHub [connector file](https://github.com/dbt-labs/semantic-layer-tableau-connector/releases/download/v1.0.2/dbt_semantic_layer.taco) locally and add it to your default folder: - Windows: `C:\Users\\[Windows User]\Documents\My Tableau Repository\Connectors` - Mac: `/Users/[user]/Documents/My Tableau Repository/Connectors` - Linux: `/opt/tableau/connectors` diff --git a/website/docs/faqs/Warehouse/database-privileges.md b/website/docs/faqs/Warehouse/database-privileges.md index 73e0549f130..3761b81fe67 100644 --- a/website/docs/faqs/Warehouse/database-privileges.md +++ b/website/docs/faqs/Warehouse/database-privileges.md @@ -12,8 +12,8 @@ schema¹ * read system views to generate documentation (i.e. views in `information_schema`) -On Postgres, Redshift, and Snowflake, use a series of `grants` to ensure that -your user has the correct privileges. +On Postgres, Redshift, Databricks, and Snowflake, use a series of `grants` to ensure that +your user has the correct privileges. Check out [example permissions](/reference/database-permissions/about-database-permissions) for these warehouses. On BigQuery, use the "BigQuery User" role to assign these privileges. diff --git a/website/docs/guides/best-practices/how-we-mesh/mesh-3-implementation.md b/website/docs/guides/best-practices/how-we-mesh/mesh-3-implementation.md index cfbbc7a1f28..65ed5d7935b 100644 --- a/website/docs/guides/best-practices/how-we-mesh/mesh-3-implementation.md +++ b/website/docs/guides/best-practices/how-we-mesh/mesh-3-implementation.md @@ -26,7 +26,7 @@ Once you have a sense of some initial groupings, you can first implement **group groups: - name: marketing owner: - - name: Ben Jaffleck + name: Ben Jaffleck email: ben.jaffleck@jaffleshop.com ``` diff --git a/website/docs/guides/best-practices/materializations/materializations-guide-4-incremental-models.md b/website/docs/guides/best-practices/materializations/materializations-guide-4-incremental-models.md index 603cbc8cda1..cd4264bafd3 100644 --- a/website/docs/guides/best-practices/materializations/materializations-guide-4-incremental-models.md +++ b/website/docs/guides/best-practices/materializations/materializations-guide-4-incremental-models.md @@ -29,7 +29,7 @@ We did our last `dbt build` job on `2022-01-31`, so any new orders since that ru - 🏔️ build the table from the **beginning of time again — a _table materialization_** - Simple and solid, if we can afford to do it (in terms of time, compute, and money — which are all directly correlated in a cloud warehouse). It’s the easiest and most accurate option. - 🤏 find a way to run **just new and updated rows since our previous run — _an_ _incremental materialization_** - - If we _can’t_ realistically afford to run the whole table — due to complex transformations or big source data, it takes too long — then we want to build incrementally. We want to just transform and add the row with id 567 below, _not_ the previous two with ids 123 and 456 that are already in the table. + - If we _can’t_ realistically afford to run the whole table — due to complex transformations or big source data, it takes too long — then we want to build incrementally. We want to just transform and add the row with id 567 below, _not_ the previous two with ids 123 and 234 that are already in the table. | order_id | order_status | customer_id | order_item_id | ordered_at | updated_at | | -------- | ------------ | ----------- | ------------- | ---------- | ---------- | diff --git a/website/docs/guides/dbt-ecosystem/dbt-python-snowpark/6-foundational-structure.md b/website/docs/guides/dbt-ecosystem/dbt-python-snowpark/6-foundational-structure.md index e387b208dd1..8a938e10c34 100644 --- a/website/docs/guides/dbt-ecosystem/dbt-python-snowpark/6-foundational-structure.md +++ b/website/docs/guides/dbt-ecosystem/dbt-python-snowpark/6-foundational-structure.md @@ -71,7 +71,7 @@ In this step, we’ll need to create a development branch and set up project lev - `materialized` — Tells dbt how to materialize models when compiling the code before it pushes it down to Snowflake. All models in the `marts` folder will be built as tables. - `tags` — Applies tags at a directory level to all models. All models in the `aggregates` folder will be tagged as `bi` (abbreviation for business intelligence). - `docs` — Specifies the `node_color` either by the plain color name or a hex value. -5. [Materializations](/docs/build/materializations) are strategies for persisting dbt models in a warehouse, with `tables` and `views` being the most commonly utilized types. By default, all dbt models are materialized as views and other materialization types can be configured in the `dbt_project.yml` file or in a model itself. It’s very important to note *Python models can only be materialized as tables or incremental models.* Since all our Python models exist under `marts`, the following portion of our `dbt_project.yml` ensures no errors will occur when we run our Python models. Starting with [dbt version 1.4](/guides/migration/versions/upgrading-to-v1.4#updates-to-python-models), Python files will automatically get materialized as tables even if not explicitly specified. +5. [Materializations](/docs/build/materializations) are strategies for persisting dbt models in a warehouse, with `tables` and `views` being the most commonly utilized types. By default, all dbt models are materialized as views and other materialization types can be configured in the `dbt_project.yml` file or in a model itself. It’s very important to note *Python models can only be materialized as tables or incremental models.* Since all our Python models exist under `marts`, the following portion of our `dbt_project.yml` ensures no errors will occur when we run our Python models. Starting with [dbt version 1.4](/docs/dbt-versions/core-upgrade/upgrading-to-v1.4#updates-to-python-models), Python files will automatically get materialized as tables even if not explicitly specified. ```yaml marts:     diff --git a/website/docs/guides/migration/tools/migrating-from-spark-to-databricks.md b/website/docs/guides/migration/tools/migrating-from-spark-to-databricks.md index f5549c58416..cd0577c2d96 100644 --- a/website/docs/guides/migration/tools/migrating-from-spark-to-databricks.md +++ b/website/docs/guides/migration/tools/migrating-from-spark-to-databricks.md @@ -35,7 +35,7 @@ In both dbt Core and dbt Cloud, you can migrate your projects to the Databricks- ### Prerequisites -- Your project must be compatible with dbt 1.0 or greater. Refer to [Upgrading to v1.0](/guides/migration/versions/upgrading-to-v1.0) for details. For the latest version of dbt, refer to [Upgrading to v1.3](/guides/migration/versions/upgrading-to-v1.3). +- Your project must be compatible with dbt 1.0 or greater. Refer to [Upgrading to v1.0](/docs/dbt-versions/core-upgrade/upgrading-to-v1.0) for details. For the latest version of dbt, refer to [Upgrading to v1.3](/docs/dbt-versions/core-upgrade/upgrading-to-v1.3). - For dbt Cloud, you need administrative (admin) privileges to migrate dbt projects. diff --git a/website/docs/reference/commands/clone.md b/website/docs/reference/commands/clone.md index ea3e570447d..9852ce84c17 100644 --- a/website/docs/reference/commands/clone.md +++ b/website/docs/reference/commands/clone.md @@ -37,3 +37,5 @@ Unlike deferral, `dbt clone` requires some compute and creation of additional ob For example, by creating actual data warehouse objects, `dbt clone` allows you to test out your code changes on downstream dependencies _outside of dbt_ (such as a BI tool). As another example, you could `clone` your modified incremental models as the first step of your dbt Cloud CI job to prevent costly `full-refresh` builds for warehouses that support zero-copy cloning. + +Check out [this Developer blog post](https://docs.getdbt.com/blog/to-defer-or-to-clone) for more details on best practices when to use `dbt clone` vs. deferral. diff --git a/website/docs/reference/database-permissions/about-database-permissions.md b/website/docs/reference/database-permissions/about-database-permissions.md new file mode 100644 index 00000000000..76fff517646 --- /dev/null +++ b/website/docs/reference/database-permissions/about-database-permissions.md @@ -0,0 +1,36 @@ +--- +title: "Database permissions" +id: about-database-permissions +description: "Database permissions are access rights and privileges granted to users or roles within a database management system." +sidebar_label: "About database permissions" +pagination_next: "reference/database-permissions/databricks-permissions" +pagination_prev: null +--- + +Database permissions are access rights and privileges granted to users or roles within a database or data platform. They help you specify what actions users or roles can perform on various database objects, like tables, views, schemas, or even the entire database. + + +### Why are they useful + +- Database permissions are essential for security and data access control. +- They ensure that only authorized users can perform specific actions. +- They help maintain data integrity, prevent unauthorized changes, and limit exposure to sensitive data. +- Permissions also support compliance with data privacy regulations and auditing. + +### How to use them + +- Users and administrators can grant and manage permissions at various levels (such as table, schema, and so on) using SQL statements or through the database system's interface. +- Assign permissions to individual users or roles (groups of users) based on their responsibilities. + - Typical permissions include "SELECT" (read), "INSERT" (add data), "UPDATE" (modify data), "DELETE" (remove data), and administrative rights like "CREATE" and "DROP." +- Users should be assigned permissions that ensure they have the necessary access to perform their tasks without overextending privileges. + +Something to note is that each data platform provider might have different approaches and names for privileges. Refer to their documentation for more details. + +### Examples + +Refer to the following database permission pages for more info on examples and how to set up database permissions: + +- [Databricks](/reference/database-permissions/databricks-permissions) +- [Postgres](/reference/database-permissions/postgres-permissions) +- [Redshift](/reference/database-permissions/redshift-permissions) +- [Snowflake](/reference/database-permissions/snowflake-permissions) diff --git a/website/docs/reference/database-permissions/databricks-permissions.md b/website/docs/reference/database-permissions/databricks-permissions.md new file mode 100644 index 00000000000..12e24652ae3 --- /dev/null +++ b/website/docs/reference/database-permissions/databricks-permissions.md @@ -0,0 +1,20 @@ +--- +title: "Databricks permissions" +--- + +In Databricks, permissions are used to control who can perform certain actions on different database objects. Use SQL statements to manage permissions in a Databricks database. + +## Example Databricks permissions + +The following example provides you with the SQL statements you can use to manage permissions. + +**Note** that you can grant permissions on `securable_objects` to `principals` (This can be user, service principal, or group). For example, `grant privilege_type` on `securable_object` to `principal`. + +``` + +grant all privileges on schema schema_name to principal; +grant create table on schema schema_name to principal; +grant create view on schema schema_name to principal; +``` + +Check out the [official documentation](https://docs.databricks.com/en/data-governance/unity-catalog/manage-privileges/privileges.html#privilege-types-by-securable-object-in-unity-catalog) for more information. diff --git a/website/docs/reference/database-permissions/postgres-permissions.md b/website/docs/reference/database-permissions/postgres-permissions.md new file mode 100644 index 00000000000..da56e9b45f2 --- /dev/null +++ b/website/docs/reference/database-permissions/postgres-permissions.md @@ -0,0 +1,25 @@ +--- +title: "Postgres Permissions" +--- + + +In Postgres, permissions are used to control who can perform certain actions on different database objects. Use SQL statements to manage permissions in a Postgres database. + +## Example Postgres permissions + +The following example provides you with the SQL statements you can use to manage permissions. These examples allow you to run dbt smoothly without encountering permission issues, such as creating schemas, reading existing data, and accessing the information schema. + +**Note** that `database_name`, `database.schema_name`, and `user_name` are placeholders and you can replace them as needed for your organization's naming convention. + +``` +grant usage on database database_name to user_name; +grant create schema on database database_name to user_name; +grant usage on schema database.schema_name to user_name; +grant create table on schema database.schema_name to user_name; +grant create view on schema database.schema_name to user_name; +grant usage on all schemas in database database_name to user_name; +grant select on all tables in database database_name to user_name; +grant select on all views in database database_name to user_name; +``` + +Check out the [official documentation](https://www.postgresql.org/docs/current/sql-grant.html) for more information. diff --git a/website/docs/reference/database-permissions/redshift-permissions.md b/website/docs/reference/database-permissions/redshift-permissions.md new file mode 100644 index 00000000000..5f0949a3528 --- /dev/null +++ b/website/docs/reference/database-permissions/redshift-permissions.md @@ -0,0 +1,25 @@ +--- +title: "Redshift permissions" +--- + +In Redshift, permissions are used to control who can perform certain actions on different database objects. Use SQL statements to manage permissions in a Redshift database. + +## Example Redshift permissions + +The following example provides you with the SQL statements you can use to manage permissions. + +**Note** that `database_name`, `database.schema_name`, and `user_name` are placeholders and you can replace them as needed for your organization's naming convention. + + +``` +grant usage on database database_name to user_name; +grant create schema on database database_name to user_name; +grant usage on schema database.schema_name to user_name; +grant create table on schema database.schema_name to user_name; +grant create view on schema database.schema_name to user_name; +grant usage on all schemas in database database_name to user_name; +grant select on all tables in database database_name to user_name; +grant select on all views in database database_name to user_name; +``` + +Check out the [official documentation](https://docs.aws.amazon.com/redshift/latest/dg/r_GRANT.html) for more information. diff --git a/website/docs/reference/database-permissions/snowflake-permissions.md b/website/docs/reference/database-permissions/snowflake-permissions.md new file mode 100644 index 00000000000..3f474242834 --- /dev/null +++ b/website/docs/reference/database-permissions/snowflake-permissions.md @@ -0,0 +1,154 @@ +--- +title: "Snowflake permissions" +--- + +In Snowflake, permissions are used to control who can perform certain actions on different database objects. Use SQL statements to manage permissions in a Snowflake database. + +## Set up Snowflake account + +This section explains how to set up permissions and roles within Snowflake. In Snowflake, you would perform these actions using SQL commands and set up your data warehouse and access control within Snowflake's ecosystem. + +1. Set up databases +``` +use role sysadmin; +create database raw; +create database analytics; +``` +2. Set up warehouses +``` +create warehouse loading + warehouse_size = xsmall + auto_suspend = 3600 + auto_resume = false + initially_suspended = true; + +create warehouse transforming + warehouse_size = xsmall + auto_suspend = 60 + auto_resume = true + initially_suspended = true; + +create warehouse reporting + warehouse_size = xsmall + auto_suspend = 60 + auto_resume = true + initially_suspended = true; +``` + +3. Set up roles and warehouse permissions +``` +use role securityadmin; + +create role loader; +grant all on warehouse loading to role loader; + +create role transformer; +grant all on warehouse transforming to role transformer; + +create role reporter; +grant all on warehouse reporting to role reporter; +``` + +4. Create users, assigning them to their roles + +Every person and application gets a separate user and is assigned to the correct role. + +``` +create user stitch_user -- or fivetran_user + password = '_generate_this_' + default_warehouse = loading + default_role = loader; + +create user claire -- or amy, jeremy, etc. + password = '_generate_this_' + default_warehouse = transforming + default_role = transformer + must_change_password = true; + +create user dbt_cloud_user + password = '_generate_this_' + default_warehouse = transforming + default_role = transformer; + +create user looker_user -- or mode_user etc. + password = '_generate_this_' + default_warehouse = reporting + default_role = reporter; + +-- then grant these roles to each user +grant role loader to user stitch_user; -- or fivetran_user +grant role transformer to user dbt_cloud_user; +grant role transformer to user claire; -- or amy, jeremy +grant role reporter to user looker_user; -- or mode_user, periscope_user +``` + +5. Let loader load data +Give the role unilateral permission to operate on the raw database +``` +use role sysadmin; +grant all on database raw to role loader; +``` + +6. Let transformer transform data +The transformer role needs to be able to read raw data. + +If you do this before you have any data loaded, you can run: +``` +grant usage on database raw to role transformer; +grant usage on future schemas in database raw to role transformer; +grant select on future tables in database raw to role transformer; +grant select on future views in database raw to role transformer; +``` +If you already have data loaded in the raw database, make sure also you run the following to update the permissions +``` +grant usage on all schemas in database raw to role transformer; +grant select on all tables in database raw to role transformer; +grant select on all views in database raw to role transformer; +``` +transformer also needs to be able to create in the analytics database: +``` +grant all on database analytics to role transformer; +``` +7. Let reporter read the transformed data +A previous version of this article recommended this be implemented through hooks in dbt, but this way lets you get away with a one-off statement. +``` +grant usage on database analytics to role reporter; +grant usage on future schemas in database analytics to role reporter; +grant select on future tables in database analytics to role reporter; +grant select on future views in database analytics to role reporter; +``` +Again, if you already have data in your analytics database, make sure you run: +``` +grant usage on all schemas in database analytics to role reporter; +grant select on all tables in database analytics to role transformer; +grant select on all views in database analytics to role transformer; +``` +8. Maintain +When new users are added, make sure you add them to the right role! Everything else should be inherited automatically thanks to those `future` grants. + +For more discussion and legacy information, refer to [this Discourse article](https://discourse.getdbt.com/t/setting-up-snowflake-the-exact-grant-statements-we-run/439). + +## Example Snowflake permissions + +The following example provides you with the SQL statements you can use to manage permissions. + +**Note** that `warehouse_name`, `database_name`, and `role_name` are placeholders and you can replace them as needed for your organization's naming convention. + +``` + +grant all on warehouse warehouse_name to role role_name; +grant usage on database database_name to role role_name; +grant create schema on database database_name to role role_name; +grant usage on schema database.an_existing_schema to role role_name; +grant create table on schema database.an_existing_schema to role role_name; +grant create view on schema database.an_existing_schema to role role_name; +grant usage on future schemas in database database_name to role role_name; +grant monitor on future schemas in database database_name to role role_name; +grant select on future tables in database database_name to role role_name; +grant select on future views in database database_name to role role_name; +grant usage on all schemas in database database_name to role role_name; +grant monitor on all schemas in database database_name to role role_name; +grant select on all tables in database database_name to role role_name; +grant select on all views in database database_name to role role_name; +``` + diff --git a/website/docs/reference/dbt_project.yml.md b/website/docs/reference/dbt_project.yml.md index 571e930d7da..9bd85d0d5dd 100644 --- a/website/docs/reference/dbt_project.yml.md +++ b/website/docs/reference/dbt_project.yml.md @@ -11,7 +11,7 @@ By default, dbt will look for `dbt_project.yml` in your current working director By default, dbt will look for `dbt_project.yml` in your current working directory and its parents, but you can set a different directory using the `--project-dir` flag or the `DBT_PROJECT_DIR` environment variable. -Starting from dbt v1.5 and higher, you can specify your dbt Cloud project ID in the `dbt_project.yml` file using the `dbt-cloud` config, which doesn't require validation or storage in the project config class. To find your project ID, check your dbt Cloud project URL, such as `https://cloud.getdbt.com/11/projects/123456`, where the project ID is `123456`. +Starting from dbt v1.5 and higher, you can specify your dbt Cloud project ID in the `dbt_project.yml` file using `project-id` under the `dbt-cloud` config. To find your project ID, check your dbt Cloud project URL, such as `https://cloud.getdbt.com/11/projects/123456`, where the project ID is `123456`. @@ -54,8 +54,8 @@ dbt uses YAML in a few different places. If you're new to YAML, it would be wort [require-dbt-version](/reference/project-configs/require-dbt-version): version-range | [version-range] [dbt-cloud](/docs/cloud/cloud-cli-installation): - project-id: project_id #Required - defer-env-id: 5678 #Optional + [project-id](/docs/cloud/configure-cloud-cli#configure-the-dbt-cloud-cli): project_id # Required + [defer-env-id](/docs/cloud/about-cloud-develop-defer#defer-in-dbt-cloud-cli): environment_id # Optional [quoting](/reference/project-configs/quoting): database: true | false diff --git a/website/docs/reference/references-overview.md b/website/docs/reference/references-overview.md index 85a374c5aa3..91a228b6c3e 100644 --- a/website/docs/reference/references-overview.md +++ b/website/docs/reference/references-overview.md @@ -51,9 +51,27 @@ Learn how to add more configurations to your dbt project or adapter, use propert icon="computer"/> + + + + + + diff --git a/website/docs/reference/snowflake-permissions.md b/website/docs/reference/snowflake-permissions.md deleted file mode 100644 index 6a469d12230..00000000000 --- a/website/docs/reference/snowflake-permissions.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Snowflake Permissions" ---- - -## Example Snowflake permissions - -``` --- NOTE: warehouse_name, database_name, and role_name are placeholders! --- Replace as-needed for your organization's naming convention! - -grant all on warehouse warehouse_name to role role_name; -grant usage on database database_name to role role_name; -grant create schema on database database_name to role role_name; -grant usage on schema database.an_existing_schema to role role_name; -grant create table on schema database.an_existing_schema to role role_name; -grant create view on schema database.an_existing_schema to role role_name; -grant usage on future schemas in database database_name to role role_name; -grant monitor on future schemas in database database_name to role role_name; -grant select on future tables in database database_name to role role_name; -grant select on future views in database database_name to role role_name; -grant usage on all schemas in database database_name to role role_name; -grant monitor on all schemas in database database_name to role role_name; -grant select on all tables in database database_name to role role_name; -grant select on all views in database database_name to role role_name; -``` diff --git a/website/sidebars.js b/website/sidebars.js index 7898715cd0d..055dfed0e7d 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -599,6 +599,23 @@ const sidebarSettings = { "docs/dbt-versions/upgrade-core-in-cloud", "docs/dbt-versions/product-lifecycles", "docs/dbt-versions/experimental-features", + { + type: "category", + label: "dbt Core upgrade guides", + link: { + type: "generated-index", + title: "Version upgrade guides", + description: + "Learn what's new in the latest version of dbt Core.", + slug: "/docs/dbt-versions/core-upgrade", + }, + items: [ + { + type: "autogenerated", + dirName: "docs/dbt-versions/core-upgrade", + }, + ], + }, { type: "category", label: "dbt Cloud Release Notes", @@ -936,7 +953,13 @@ const sidebarSettings = { { type: "category", label: "Database Permissions", - items: ["reference/snowflake-permissions"], + items: [ + "reference/database-permissions/about-database-permissions", + "reference/database-permissions/databricks-permissions", + "reference/database-permissions/postgres-permissions", + "reference/database-permissions/redshift-permissions", + "reference/database-permissions/snowflake-permissions", + ], }, ], guides: [ @@ -1109,20 +1132,17 @@ const sidebarSettings = { { type: "category", label: "Versions", - link: { - type: "generated-index", - title: "Version migration guides", - description: - "Learn how to upgrade to the latest version of dbt Core.", - slug: "/guides/migration/versions", - }, items: [ - { - type: "autogenerated", - dirName: "guides/migration/versions", + "docs/dbt-versions/core-upgrade/upgrading-to-v1.7", + "docs/dbt-versions/core-upgrade/upgrading-to-v1.6", + "docs/dbt-versions/core-upgrade/upgrading-to-v1.5", + "docs/dbt-versions/core-upgrade/upgrading-to-v1.4", + "docs/dbt-versions/core-upgrade/upgrading-to-v1.3", + "docs/dbt-versions/core-upgrade/upgrading-to-v1.2", + "docs/dbt-versions/core-upgrade/upgrading-to-v1.1", + "docs/dbt-versions/core-upgrade/upgrading-to-v1.0", + ], }, - ], - }, { type: "category", label: "Tools", diff --git a/website/snippets/_upgrade-move.md b/website/snippets/_upgrade-move.md new file mode 100644 index 00000000000..7572077fd1b --- /dev/null +++ b/website/snippets/_upgrade-move.md @@ -0,0 +1,5 @@ +:::important Upgrade Guides Are Moving + +The location of the dbt Core upgrade guides has changed, and they will soon be removed from `Guides`. The new location is in the `Docs` tab under `Available dbt versions`. You have been redirected to the new URL, so please update any saved links and bookmarks. + +::: \ No newline at end of file diff --git a/website/snippets/core-versions-table.md b/website/snippets/core-versions-table.md index b08c23c84c5..6ec1cb01e32 100644 --- a/website/snippets/core-versions-table.md +++ b/website/snippets/core-versions-table.md @@ -2,14 +2,14 @@ | dbt Core | Initial Release | Support Level | Critical Support Until | |------------------------------------------------------------|-----------------|----------------|-------------------------| -| [**v1.7**](/guides/migration/versions/upgrading-to-v1.7) (beta)| Oct 26, 2023 | - | - | -| [**v1.6**](/guides/migration/versions/upgrading-to-v1.6) | Jul 31, 2023 | Active | Jul 30, 2024 | -| [**v1.5**](/guides/migration/versions/upgrading-to-v1.5) | Apr 27, 2023 | Critical | Apr 27, 2024 | -| [**v1.4**](/guides/migration/versions/upgrading-to-v1.4) | Jan 25, 2023 | Critical | Jan 25, 2024 | -| [**v1.3**](/guides/migration/versions/upgrading-to-v1.3) | Oct 12, 2022 | End of Life* ⚠️ | Oct 12, 2023 | -| [**v1.2**](/guides/migration/versions/upgrading-to-v1.2) | Jul 26, 2022 | End of Life* ⚠️ | Jul 26, 2023 | -| [**v1.1**](/guides/migration/versions/upgrading-to-v1.1) ⚠️ | Apr 28, 2022 | Deprecated ⛔️ | Deprecated ⛔️ | -| [**v1.0**](/guides/migration/versions/upgrading-to-v1.0) ⚠️ | Dec 3, 2021 | Deprecated ⛔️ | Deprecated ⛔️ | +| [**v1.7**](/docs/dbt-versions/core-upgrade/upgrading-to-v1.7) | Nov 2, 2023 | Active | Nov 1, 2024 | +| [**v1.6**](/docs/dbt-versions/core-upgrade/upgrading-to-v1.6) | Jul 31, 2023 | Active | Jul 30, 2024 | +| [**v1.5**](/docs/dbt-versions/core-upgrade/upgrading-to-v1.5) | Apr 27, 2023 | Critical | Apr 27, 2024 | +| [**v1.4**](/docs/dbt-versions/core-upgrade/upgrading-to-v1.4) | Jan 25, 2023 | Critical | Jan 25, 2024 | +| [**v1.3**](/docs/dbt-versions/core-upgrade/upgrading-to-v1.3) | Oct 12, 2022 | End of Life* ⚠️ | Oct 12, 2023 | +| [**v1.2**](/docs/dbt-versions/core-upgrade/upgrading-to-v1.2) | Jul 26, 2022 | End of Life* ⚠️ | Jul 26, 2023 | +| [**v1.1**](/docs/dbt-versions/core-upgrade/upgrading-to-v1.1) ⚠️ | Apr 28, 2022 | Deprecated ⛔️ | Deprecated ⛔️ | +| [**v1.0**](/docs/dbt-versions/core-upgrade/upgrading-to-v1.0) ⚠️ | Dec 3, 2021 | Deprecated ⛔️ | Deprecated ⛔️ | | **v0.X** ⛔️ | (Various dates) | Deprecated ⛔️ | Deprecated ⛔️ | _*All versions of dbt Core since v1.0 are available in dbt Cloud until further notice. Versions that are EOL do not receive any fixes. For the best support, we recommend upgrading to a version released within the past 12 months._ ### Planned future releases @@ -18,6 +18,5 @@ _Future release dates are tentative and subject to change._ | dbt Core | Planned Release | Critical & dbt Cloud Support Until | |----------|-----------------|-------------------------------------| -| **v1.7** | _Oct 2023_ | _Oct 2024_ | | **v1.8** | _Jan 2024_ | _Jan 2025_ | | **v1.9** | _Apr 2024_ | _Apr 2025_ | diff --git a/website/snippets/metadata-api-prerequisites.md b/website/snippets/metadata-api-prerequisites.md index 35532e28bdc..6e2d1550223 100644 --- a/website/snippets/metadata-api-prerequisites.md +++ b/website/snippets/metadata-api-prerequisites.md @@ -2,5 +2,5 @@ - dbt Cloud [multi-tenant](/docs/cloud/about-cloud/tenancy#multi-tenant) or [single tenant](/docs/cloud/about-cloud/tenancy#single-tenant) account - You must be on a [Team or Enterprise plan](https://www.getdbt.com/pricing/) -- Your projects must be on dbt version 1.0 or higher. Refer to [Version migration guides](/guides/migration/versions) to upgrade +- Your projects must be on dbt version 1.0 or higher. Refer to [Version migration guides](/docs/dbt-versions/core-upgrade) to upgrade diff --git a/website/vercel.json b/website/vercel.json index 14b3a0a6af0..81d955e2d3d 100644 --- a/website/vercel.json +++ b/website/vercel.json @@ -2,6 +2,116 @@ "cleanUrls": true, "trailingSlash": false, "redirects": [ + { + "source": "/guides/migration/versions", + "destination": "/docs/dbt-versions/core-upgrade", + "permanent": true + }, + { + "source": "/guides/migration/versions/upgrading-to-v1.7", + "destination": "/docs/dbt-versions/core-upgrade/upgrading-to-v1.7", + "permanent": true + }, + { + "source": "/guides/migration/versions/upgrading-to-v1.6", + "destination": "/docs/dbt-versions/core-upgrade/upgrading-to-v1.6", + "permanent": true + }, + { + "source": "/guides/migration/versions/upgrading-to-v1.5", + "destination": "/docs/dbt-versions/core-upgrade/upgrading-to-v1.5", + "permanent": true + }, + { + "source": "/guides/migration/versions/upgrading-to-v1.4", + "destination": "/docs/dbt-versions/core-upgrade/upgrading-to-v1.4", + "permanent": true + }, + { + "source": "/guides/migration/versions/upgrading-to-v1.3", + "destination": "/docs/dbt-versions/core-upgrade/upgrading-to-v1.3", + "permanent": true + }, + { + "source": "/guides/migration/versions/upgrading-to-v1.2", + "destination": "/docs/dbt-versions/core-upgrade/upgrading-to-v1.2", + "permanent": true + }, + { + "source": "/guides/migration/versions/upgrading-to-v1.1", + "destination": "/docs/dbt-versions/core-upgrade/upgrading-to-v1.1", + "permanent": true + }, + { + "source": "/guides/migration/versions/upgrading-to-v1.0", + "destination": "/docs/dbt-versions/core-upgrade/upgrading-to-v1.0", + "permanent": true + }, + { + "source": "/guides/migration/versions/upgrading-to-v0.21", + "destination": "/docs/dbt-versions/core-upgrade/upgrading-to-v0.21", + "permanent": true + }, + { + "source": "/guides/migration/versions/upgrading-to-v0.20", + "destination": "/docs/dbt-versions/core-upgrade/upgrading-to-v0.20", + "permanent": true + }, + { + "source": "/guides/migration/versions/Older%20versions/upgrading-to-0-11-0", + "destination": "/docs/dbt-versions/core-upgrade/Older%20versions/upgrading-to-0-11-0", + "permanent": true + }, + { + "source": "/guides/migration/versions/Older%20versions/upgrading-to-0-12-0", + "destination": "/docs/dbt-versions/core-upgrade/Older%20versions/upgrading-to-0-12-0", + "permanent": true + }, + { + "source": "/guides/migration/versions/Older%20versions/upgrading-to-0-13-0", + "destination": "/docs/dbt-versions/core-upgrade/Older%20versions/upgrading-to-0-13-0", + "permanent": true + }, + { + "source": "/guides/migration/versions/Older%20versions/upgrading-to-0-14-0", + "destination": "/docs/dbt-versions/core-upgrade/Older%20versions/upgrading-to-0-14-0", + "permanent": true + }, + { + "source": "/guides/migration/versions/Older%20versions/upgrading-to-0-14-1", + "destination": "/docs/dbt-versions/core-upgrade/Older%20versions/upgrading-to-0-14-1", + "permanent": true + }, + { + "source": "/guides/migration/versions/Older%20versions/upgrading-to-0-15-0", + "destination": "/docs/dbt-versions/core-upgrade/Older%20versions/upgrading-to-0-15-0", + "permanent": true + }, + { + "source": "/guides/migration/versions/Older%20versions/upgrading-to-0-16-0", + "destination": "/docs/dbt-versions/core-upgrade/Older%20versions/upgrading-to-0-16-0", + "permanent": true + }, + { + "source": "/guides/migration/versions/Older%20versions/upgrading-to-0-17-0", + "destination": "/docs/dbt-versions/core-upgrade/Older%20versions/upgrading-to-0-17-0", + "permanent": true + }, + { + "source": "/guides/migration/versions/Older%20versions/upgrading-to-0-18-0", + "destination":"/docs/dbt-versions/core-upgrade/Older%20versions/upgrading-to-0-18-0" , + "permanent": true + }, + { + "source": "/guides/migration/versions/Older%20versions/upgrading-to-0-19-0", + "destination": "/docs/dbt-versions/core-upgrade/Older%20versions/upgrading-to-0-19-0", + "permanent": true + }, + { + "source": "/reference/snowflake-permissions", + "destination": "/reference/database-permissions/snowflake-permissions", + "permanent": true + }, { "source": "/docs/build/metricflow-cli", "destination": "/docs/build/metricflow-commands",