@@ -19,7 +22,6 @@ One of the core tenets of dbt is that analytic code should be version controlled
A note on parlance in this article since each code hosting platform uses different terms for similar concepts. The terms `pull request` (PR) and `merge request` (MR) are used interchangeably to mean the process of merging one branch into another branch.
-
### What are pipelines?
Pipelines (which are known by many names, such as workflows, actions, or build steps) are a series of pre-defined jobs that are triggered by specific events in your repository (PR created, commit pushed, branch merged, etc). Those jobs can do pretty much anything your heart desires assuming you have the proper security access and coding chops.
diff --git a/website/docs/guides/sl-snowflake-qs.md b/website/docs/guides/sl-snowflake-qs.md
index 6d9f88ab159..fb72ee0057e 100644
--- a/website/docs/guides/sl-snowflake-qs.md
+++ b/website/docs/guides/sl-snowflake-qs.md
@@ -619,6 +619,11 @@ select * from final
In the following steps, semantic models enable you to define how to interpret the data related to orders. It includes entities (like ID columns serving as keys for joining data), dimensions (for grouping or filtering data), and measures (for data aggregations).
1. In the `metrics` sub-directory, create a new file `fct_orders.yml`.
+
+:::tip
+Make sure to save all semantic models and metrics under the directory defined in the [`model-paths`](/reference/project-configs/model-paths) (or a subdirectory of it, like `models/semantic_models/`). If you save them outside of this path, it will result in an empty `semantic_manifest.json` file, and your semantic models or metrics won't be recognized.
+:::
+
2. Add the following code to that newly created file:
@@ -765,7 +770,11 @@ There are different types of metrics you can configure:
Once you've created your semantic models, it's time to start referencing those measures you made to create some metrics:
-Add metrics to your `fct_orders.yml` semantic model file:
+1. Add metrics to your `fct_orders.yml` semantic model file:
+
+:::tip
+Make sure to save all semantic models and metrics under the directory defined in the [`model-paths`](/reference/project-configs/model-paths) (or a subdirectory of it, like `models/semantic_models/`). If you save them outside of this path, it will result in an empty `semantic_manifest.json` file, and your semantic models or metrics won't be recognized.
+:::
@@ -946,15 +955,6 @@ https://github.com/dbt-labs/docs.getdbt.com/blob/current/website/snippets/_sl-ru
-
-
-What’s happening internally?
-
-- Merging the code into your main branch allows dbt Cloud to pull those changes and build the definition in the manifest produced by the run.
-- Re-running the job in the deployment environment helps materialize the models, which the metrics depend on, in the data platform. It also makes sure that the manifest is up to date.
-- The Semantic Layer APIs pull in the most recent manifest and enables your integration to extract metadata from it.
-
-
## Set up dbt Semantic Layer
diff --git a/website/docs/reference/dbt-jinja-functions/execute.md b/website/docs/reference/dbt-jinja-functions/execute.md
index f99bfa64734..65cd4708dc8 100644
--- a/website/docs/reference/dbt-jinja-functions/execute.md
+++ b/website/docs/reference/dbt-jinja-functions/execute.md
@@ -9,7 +9,7 @@ description: "Use `execute` to return True when dbt is in 'execute' mode."
When you execute a `dbt compile` or `dbt run` command, dbt:
-1. Reads all of the files in your project and generates a "manifest" comprised of models, tests, and other graph nodes present in your project. During this phase, dbt uses the `ref` statements it finds to generate the DAG for your project. **No SQL is run during this phase**, and `execute == False`.
+1. Reads all of the files in your project and generates a [manifest](/reference/artifacts/manifest-json) comprised of models, tests, and other graph nodes present in your project. During this phase, dbt uses the [`ref`](/reference/dbt-jinja-functions/ref) and [`source`](/reference/dbt-jinja-functions/source) statements it finds to generate the DAG for your project. **No SQL is run during this phase**, and `execute == False`.
2. Compiles (and runs) each node (eg. building models, or running tests). **SQL is run during this phase**, and `execute == True`.
Any Jinja that relies on a result being returned from the database will error during the parse phase. For example, this SQL will return an error:
diff --git a/website/docs/reference/global-configs/about-global-configs.md b/website/docs/reference/global-configs/about-global-configs.md
index bbbe63ac439..3708b8c96be 100644
--- a/website/docs/reference/global-configs/about-global-configs.md
+++ b/website/docs/reference/global-configs/about-global-configs.md
@@ -16,7 +16,7 @@ There is a significant overlap between dbt's flags and dbt's command line option
### Setting flags
There are multiple ways of setting flags, which depend on the use case:
-- **[Project-level `flags` in `dbt_project.yml`](/reference/global-configs/project-flags):** Define version-controlled defaults for everyone running this project. Preserve [legacy behaviors](/reference/global-configs/legacy-behaviors) until their slated deprecation.
+- **[Project-level `flags` in `dbt_project.yml`](/reference/global-configs/project-flags):** Define version-controlled defaults for everyone running this project. Also, opt in or opt out of [behavior changes](/reference/global-configs/behavior-changes) to manage your migration off legacy functionality.
- **[Environment variables](/reference/global-configs/environment-variable-configs):** Define different behavior in different runtime environments (development vs. production vs. [continuous integration](/docs/deploy/continuous-integration), or different behavior for different users in development (based on personal preferences).
- **[CLI options](/reference/global-configs/command-line-options):** Define behavior specific to _this invocation_. Supported for all dbt commands.
@@ -41,7 +41,7 @@ dbt run --no-fail-fast # set to False
There are two categories of exceptions:
1. **Flags setting file paths:** Flags for file paths that are relevant to runtime execution (for example, `--log-path` or `--state`) cannot be set in `dbt_project.yml`. To override defaults, pass CLI options or set environment variables (`DBT_LOG_PATH`, `DBT_STATE`). Flags that tell dbt where to find project resources (for example, `model-paths`) are set in `dbt_project.yml`, but as a top-level key, outside the `flags` dictionary; these configs are expected to be fully static and never vary based on the command or execution environment.
-2. **Opt-in flags:** Flags opting into [legacy dbt behaviors](/reference/global-configs/legacy-behaviors) can _only_ be defined in `dbt_project.yml`. These are intended to be set in version control and migrated via pull/merge request. Their values should not diverge indefinitely across invocations, environments, or users.
+2. **Opt-in flags:** Flags opting in or out of [behavior changes](/reference/global-configs/behavior-changes) can _only_ be defined in `dbt_project.yml`. These are intended to be set in version control and migrated via pull/merge request. Their values should not diverge indefinitely across invocations, environments, or users.
### Accessing flags
@@ -84,7 +84,7 @@ Because the values of `flags` can differ across invocations, we strongly advise
| [quiet](/reference/global-configs/logs#suppress-non-error-logs-in-output) | boolean | False | ❌ | `DBT_QUIET` | `--quiet` | ✅ |
| [resource-type](/reference/global-configs/resource-type) (v1.8+) | string | None | ❌ | `DBT_RESOURCE_TYPES`
`DBT_EXCLUDE_RESOURCE_TYPES` | `--resource-type`
`--exclude-resource-type` | ✅ |
| [send_anonymous_usage_stats](/reference/global-configs/usage-stats) | boolean | True | ✅ | `DBT_SEND_ANONYMOUS_USAGE_STATS` | `--send-anonymous-usage-stats`, `--no-send-anonymous-usage-stats` | ❌ |
-| [source_freshness_run_project_hooks](/reference/global-configs/legacy-behaviors#source_freshness_run_project_hooks) | boolean | False | ✅ | ❌ | ❌ | ❌ |
+| [source_freshness_run_project_hooks](/reference/global-configs/behavior-changes#source_freshness_run_project_hooks) | boolean | False | ✅ | ❌ | ❌ | ❌ |
| [state](/reference/node-selection/defer) | path | none | ❌ | `DBT_STATE`, `DBT_DEFER_STATE` | `--state`, `--defer-state` | ❌ |
| [static_parser](/reference/global-configs/parsing#static-parser) | boolean | True | ✅ | `DBT_STATIC_PARSER` | `--static-parser`, `--no-static-parser` | ❌ |
| [store_failures](/reference/resource-configs/store_failures) | boolean | False | ✅ (as resource config) | `DBT_STORE_FAILURES` | `--store-failures`, `--no-store-failures` | ✅ |
diff --git a/website/docs/reference/global-configs/legacy-behaviors.md b/website/docs/reference/global-configs/behavior-changes.md
similarity index 75%
rename from website/docs/reference/global-configs/legacy-behaviors.md
rename to website/docs/reference/global-configs/behavior-changes.md
index 1450fda1459..20f5722b944 100644
--- a/website/docs/reference/global-configs/legacy-behaviors.md
+++ b/website/docs/reference/global-configs/behavior-changes.md
@@ -1,7 +1,7 @@
---
-title: "Legacy behaviors"
-id: "legacy-behaviors"
-sidebar: "Legacy behaviors"
+title: "Behavior changes"
+id: "behavior-changes"
+sidebar: "Behavior changes"
---
Most flags exist to configure runtime behaviors with multiple valid choices. The right choice may vary based on the environment, user preference, or the specific invocation.
@@ -12,10 +12,31 @@ Another category of flags provides existing projects with a migration window for
- Providing maintainability of dbt software. Every fork in behavior requires additional testing & cognitive overhead that slows future development. These flags exist to facilitate migration from "current" to "better," not to stick around forever.
These flags go through three phases of development:
-1. **Introduction (disabled by default):** dbt adds logic to support both 'old' + 'new' behaviors. The 'new' behavior is gated behind a flag, disabled by default, preserving the old behavior.
+1. **Introduction (disabled by default):** dbt adds logic to support both 'old' and 'new' behaviors. The 'new' behavior is gated behind a flag, disabled by default, preserving the old behavior.
2. **Maturity (enabled by default):** The default value of the flag is switched, from `false` to `true`, enabling the new behavior by default. Users can preserve the 'old' behavior and opt out of the 'new' behavior by setting the flag to `false` in their projects. They may see deprecation warnings when they do so.
3. **Removal (generally enabled):** After marking the flag for deprecation, we remove it along with the 'old' behavior it supported from the dbt codebases. We aim to support most flags indefinitely, but we're not committed to supporting them forever. If we choose to remove a flag, we'll offer significant advance notice.
+## What is a behavior change?
+
+The same dbt project code and the same dbt commands return one result before the behavior change, and they return a different result after the behavior change.
+
+Examples of behavior changes:
+- dbt begins raising a validation _error_ that it didn't previously.
+- dbt changes the signature of a built-in macro. Your project has a custom reimplementation of that macro. This could lead to errors, because your custom reimplementation will be passed arguments it cannot accept.
+- A dbt adapter renames or removes a method that was previously available on the `{{ adapter }}` object in the dbt-Jinja context.
+- dbt makes a breaking change to contracted metadata artifacts by deleting a required field, changing the name or type of an existing field, or removing the default value of an existing field ([README](https://github.com/dbt-labs/dbt-core/blob/37d382c8e768d1e72acd767e0afdcb1f0dc5e9c5/core/dbt/artifacts/README.md#breaking-changes)).
+- dbt removes one of the fields from [structured logs](/reference/events-logging#structured-logging).
+
+The following are **not** behavior changes:
+- Fixing a bug where the previous behavior was defective, undesirable, or undocumented.
+- dbt begins raising a _warning_ that it didn't previously.
+- dbt updates the language of human-friendly messages in log events.
+- dbt makes a non-breaking change to contracted metadata artifacts by adding a new field with a default, or deleting a field with a default ([README](https://github.com/dbt-labs/dbt-core/blob/37d382c8e768d1e72acd767e0afdcb1f0dc5e9c5/core/dbt/artifacts/README.md#non-breaking-changes)).
+
+The vast majority of changes are not behavior changes. Because introducing these changes does not require any action on the part of users, they are included in continuous releases of dbt Cloud and patch releases of dbt Core.
+
+By contrast, behavior change migrations happen slowly, over the course of months, facilitated by behavior change flags. The flags are loosely coupled to the specific dbt runtime version. By setting flags, users have control over opting in (and later opting out) of these changes.
+
## Behavior change flags
These flags _must_ be set in the `flags` dictionary in `dbt_project.yml`. They configure behaviors closely tied to project code, which means they should be defined in version control and modified through pull or merge requests, with the same testing and peer review.
diff --git a/website/docs/reference/global-configs/project-flags.md b/website/docs/reference/global-configs/project-flags.md
index 896276d9735..cdbe3463b14 100644
--- a/website/docs/reference/global-configs/project-flags.md
+++ b/website/docs/reference/global-configs/project-flags.md
@@ -17,7 +17,7 @@ flags:
Reference the [table of all flags](/reference/global-configs/about-global-configs#available-flags) to see which global configs are available for setting in [`dbt_project.yml`](/reference/dbt_project.yml).
-The `flags` dictionary is the _only_ place you can opt out of [behavior changes](/reference/global-configs/legacy-behaviors), while the legacy behavior is still supported.
+The `flags` dictionary is the _only_ place you can opt out of [behavior changes](/reference/global-configs/behavior-changes), while the legacy behavior is still supported.
diff --git a/website/docs/reference/resource-configs/pre-hook-post-hook.md b/website/docs/reference/resource-configs/pre-hook-post-hook.md
index bf4375c9490..e1e7d67f02e 100644
--- a/website/docs/reference/resource-configs/pre-hook-post-hook.md
+++ b/website/docs/reference/resource-configs/pre-hook-post-hook.md
@@ -45,6 +45,18 @@ select ...
```
+
+
+
+
+```yml
+models:
+ - name: []
+ config:
+ [pre_hook](/reference/resource-configs/pre-hook-post-hook): | []
+ [post_hook](/reference/resource-configs/pre-hook-post-hook): | []
+```
+
@@ -66,6 +78,18 @@ seeds:
+
+
+```yml
+seeds:
+ - name: []
+ config:
+ [pre_hook](/reference/resource-configs/pre-hook-post-hook): | []
+ [post_hook](/reference/resource-configs/pre-hook-post-hook): | []
+```
+
+
+
@@ -102,6 +126,18 @@ select ...
+
+
+```yml
+snapshots:
+ - name: []
+ config:
+ [pre_hook](/reference/resource-configs/pre-hook-post-hook): | []
+ [post_hook](/reference/resource-configs/pre-hook-post-hook): | []
+```
+
+
+
diff --git a/website/docs/reference/seed-configs.md b/website/docs/reference/seed-configs.md
index dd733795eef..5d5c39071d6 100644
--- a/website/docs/reference/seed-configs.md
+++ b/website/docs/reference/seed-configs.md
@@ -113,8 +113,8 @@ seeds:
config:
[enabled](/reference/resource-configs/enabled): true | false
[tags](/reference/resource-configs/tags):
| []
- [pre-hook](/reference/resource-configs/pre-hook-post-hook): | []
- [post-hook](/reference/resource-configs/pre-hook-post-hook): | []
+ [pre_hook](/reference/resource-configs/pre-hook-post-hook): | []
+ [post_hook](/reference/resource-configs/pre-hook-post-hook): | []
[database](/reference/resource-configs/database):
[schema](/reference/resource-properties/schema):
[alias](/reference/resource-configs/alias):
diff --git a/website/sidebars.js b/website/sidebars.js
index d839e05e184..fe1118b3be2 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -587,10 +587,33 @@ const sidebarSettings = {
label: "Quickstart with the dbt Cloud Semantic Layer",
href: `/guides/sl-snowflake-qs`,
},
- "docs/use-dbt-semantic-layer/setup-sl",
- "docs/use-dbt-semantic-layer/sl-architecture",
- "docs/use-dbt-semantic-layer/exports",
- "docs/use-dbt-semantic-layer/sl-cache",
+ {
+ type: "category",
+ label: "Configure",
+ link: { type: "doc", id: "docs/use-dbt-semantic-layer/setup-sl" },
+ items: [
+ "docs/use-dbt-semantic-layer/setup-sl",
+ "docs/use-dbt-semantic-layer/sl-architecture",
+ ]
+ },
+ {
+ type: "category",
+ label: "Deploy metrics",
+ link: { type: "doc", id: "docs/use-dbt-semantic-layer/deploy-sl" },
+ items: [
+ "docs/use-dbt-semantic-layer/deploy-sl",
+ "docs/use-dbt-semantic-layer/exports",
+ "docs/use-dbt-semantic-layer/sl-cache"
+ ]
+ },
+ {
+ type: "category",
+ label: "Consume",
+ link: { type: "doc", id: "docs/use-dbt-semantic-layer/consume-metrics" },
+ items: [
+ "docs/use-dbt-semantic-layer/consume-metrics",
+ ]
+ },
"docs/use-dbt-semantic-layer/sl-faqs",
],
},
@@ -1074,6 +1097,7 @@ const sidebarSettings = {
},
items: [
"reference/global-configs/about-global-configs",
+ "reference/global-configs/behavior-changes",
{
type: "category",
label: "Setting flags",
@@ -1092,7 +1116,6 @@ const sidebarSettings = {
"reference/global-configs/failing-fast",
"reference/global-configs/indirect-selection",
"reference/global-configs/json-artifacts",
- "reference/global-configs/legacy-behaviors",
"reference/global-configs/parsing",
"reference/global-configs/print-output",
"reference/global-configs/record-timing-info",
diff --git a/website/snippets/_new-sl-setup.md b/website/snippets/_new-sl-setup.md
index ed0fa86f8b2..b9c64bc36f6 100644
--- a/website/snippets/_new-sl-setup.md
+++ b/website/snippets/_new-sl-setup.md
@@ -13,32 +13,41 @@ Select the environment where you want to enable the Semantic Layer:
2. On the **Settings** left sidebar, select the specific project you want to enable the Semantic Layer for.
3. In the **Project details** page, navigate to the **Semantic Layer** section. Select **Configure Semantic Layer**.
-
+
4. In the **Set Up Semantic Layer Configuration** page, select the deployment environment you want for the Semantic Layer and click **Save**. This provides administrators with the flexibility to choose the environment where the Semantic Layer will be enabled.
-:::tip dbt Cloud Enterprise can skip to [Add more credentials](#4-add-more-credentials)
-dbt Cloud Enterprise plans can add multiple credentials and have a different set up. Skip to [Add more credentials](#4-add-more-credentials) for more configuration details.
-:::
+
### 2. Add a credential and create service tokens
-The dbt Semantic Layer uses [service tokens](/docs/dbt-cloud-apis/service-tokens) for authentication which are tied to an underlying data platform credential that you configure. The credential configured is used to execute queries that the Semantic Layer issues against your data platform. This credential controls the physical access to underlying data accessed by the Semantic Layer, and all access policies set in the data platform for this credential will be respected.
+The dbt Semantic Layer uses [service tokens](/docs/dbt-cloud-apis/service-tokens) for authentication which are tied to an underlying data platform credential that you configure. The credential configured is used to execute queries that the Semantic Layer issues against your data platform.
+
+This credential controls the physical access to underlying data accessed by the Semantic Layer, and all access policies set in the data platform for this credential will be respected.
+
+| Feature | Team plan | Enterprise plan |
+| --- | :---: | :---: |
+| Service tokens | Can create multiple service tokens linked to one credential. | Can use multiple credentials and link multiple service tokens to each credential. Note that you cannot link a single service token to more than one credential. |
+| Credentials per project | One credential per project. | Can [add multiple](#4-add-more-credentials) credentials per project. |
+| Link multiple service tokens to a single credential | ✅ | ✅ |
-dbt Cloud Enterprise plans can add multiple credentials and map those to service tokens. Refer to [Add more credentials](#4-add-more-credentials) for more information.
+*If you're on a Team plan and need to add more credentials, consider upgrading to our [Enterprise plan](https://www.getdbt.com/contact). Enterprise users can refer to [Add more credentials](#4-add-more-credentials) for detailed steps on adding multiple credentials.*
-1. In the **Set Up Semantic Layer Configuration** page, enter the credentials specific to your data platform that you want the Semantic Layer to use.
+1. After selecting the deployment environment, you should see the **Credentials & service tokens** page.
+2. Click the **Add Semantic Layer credential** button.
+3. In the **1. Add credentials** section, enter the credentials specific to your data platform that you want the Semantic Layer to use.
- Use credentials with minimal privileges. The Semantic Layer requires read access to the schema(s) containing the dbt models used in your semantic models for downstream applications
- Note, environment variables such as `{{env_var('DBT_WAREHOUSE') }}`, aren't supported in the dbt Semantic Layer yet. You must use the actual credentials.
-
-1. Create a **Service Token** after you add the credential.
- * Enterprise plans: Name and generate a service token on the credential page directly.
- * Team plans: You can return to the **Project Details** page and click the **Generate a Service Token** button.
-2. Name the token and save it. Once the token is generated, you won't be able to view this token again so make sure to record it somewhere safe.
+
+
+4. After adding credentials, scroll to **2. Map new service token**.
+5. Name the token and ensure the permission set includes 'Semantic Layer Only' and 'Metadata Only'.
+6. Click **Save**. Once the token is generated, you won't be able to view this token again so make sure to record it somewhere safe.
:::info
-Teams plans can create multiple service tokens that map to one underlying credential. Adding [multiple credentials](#4-add-more-credentials) for tailored access is available for Enterprise plans.
+- Team plans can create multiple service tokens that link to a single underlying credential, but each project can only have one credential.
+- Enterprise plans can [add multiple credentials](#4-add-more-credentials) and map those to service tokens for tailored access.
Book a free live demo to discover the full potential of dbt Cloud Enterprise.
:::
@@ -63,20 +72,35 @@ Note that:
To add multiple credentials and map them to service tokens:
-1. After configuring your environment, on the **Credentials & service tokens** page click the **Add Semantic Layer credential** button to configure the credential for your data platform.
-2. On the **Create New Semantic Layer Credential** page, you can create multiple credentials and map them to a service token.
-3. In the **Add credentials** section, fill in the data platform's credential fields. We recommend using “read-only” credentials.
+1. After configuring your environment, on the **Credentials & service tokens** page, click the **Add Semantic Layer credential** button to create multiple credentials and map them to a service token.
+2. In the **1. Add credentials** section, fill in the data platform's credential fields. We recommend using “read-only” credentials.
-4. In the **Map new service token** section, map a service token to the credential you configured in the previous step. dbt Cloud automatically selects the service token permission set you need (Semantic Layer Only and Metadata Only).
- - To add another service token, click **Add service token** under the **Linked service tokens** section.
-5. Click **Save** to link the service token to the credential. Remember to copy and save the service token securely, as it won't be viewable again after generation.
-
+3. In the **2. Map new service token** section, map a service token to the credential you configured in the previous step. dbt Cloud automatically selects the service token permission set you need (Semantic Layer Only and Metadata Only).
+
+4. To add another service token during configuration, click **Add Service Token**.
+5. You can link more service tokens to the same credential later on in the **Semantic Layer Configuration Details** page. To add another service token to an existing Semantic Layer configuration, click **Add service token** under the **Linked service tokens** section.
+6. Click **Save** to link the service token to the credential. Remember to copy and save the service token securely, as it won't be viewable again after generation.
+
+
+7. To delete a credential, go back to the **Credentials & service tokens** page.
+8. Under **Linked Service Tokens**, click **Edit** and, select **Delete Credential** to remove a credential.
-6. To delete a credential, go back to the **Semantic Layer & Credential**s page. Select **Delete credential** to remove a credential and click **Save**.
-
When you delete a credential, any service tokens mapped to that credential in the project will no longer work and will break for any end users.
+## Delete configuration
+You can delete the entire Semantic Layer configuration for a project. Note that deleting the Semantic Layer configuration will remove all credentials and unlink all service tokens to the project. It will also cause all queries to the Semantic Layer to fail.
+
+Follow these steps to delete the Semantic Layer configuration for a project:
+
+1. Navigate to the **Project details** page.
+2. In the **Semantic Layer** section, select **Delete Semantic Layer**.
+3. Confirm the deletion by clicking **Yes, delete semantic layer** in the confirmation pop up.
+
+To re-enable the dbt Semantic Layer setup in the future, you will need to recreate your setup configurations by following the [previous steps](#set-up-dbt-semantic-layer). If your semantic models and metrics are still in your project, no changes are needed. If you've removed them, you'll need to set up the YAML configs again.
+
+
+
## Additional configuration
The following are the additional flexible configurations for Semantic Layer credentials.
diff --git a/website/snippets/_sl-run-prod-job.md b/website/snippets/_sl-run-prod-job.md
index 8eb4049efc8..f820b7f3f79 100644
--- a/website/snippets/_sl-run-prod-job.md
+++ b/website/snippets/_sl-run-prod-job.md
@@ -1,9 +1,22 @@
-Once you’ve committed and merged your metric changes in your dbt project, you can perform a job run in your deployment environment in dbt Cloud to materialize your metrics. The deployment environment is only supported for the dbt Semantic Layer currently.
+This section explains how you can perform a job run in your deployment environment in dbt Cloud to materialize and deploy your metrics. Currently, the deployment environment is only supported.
-1. In dbt Cloud, create a new [deployment environment](/docs/deploy/deploy-environments#create-a-deployment-environment) or use an existing environment on dbt 1.6 or higher.
+1. Once you’ve [defined your semantic models and metrics](/guides/sl-snowflake-qs?step=10), commit and merge your metric changes in your dbt project.
+2. In dbt Cloud, create a new [deployment environment](/docs/deploy/deploy-environments#create-a-deployment-environment) or use an existing environment on dbt 1.6 or higher.
* Note — Deployment environment is currently supported (_development experience coming soon_)
-2. To create a new environment, navigate to **Deploy** in the navigation menu, select **Environments**, and then select **Create new environment**.
-3. Fill in your deployment credentials with your Snowflake username and password. You can name the schema anything you want. Click **Save** to create your new production environment.
-4. [Create a new deploy job](/docs/deploy/deploy-jobs#create-and-schedule-jobs) that runs in the environment you just created. Go back to the **Deploy** menu, select **Jobs**, select **Create job**, and click **Deploy job**.
-5. Set the job to run a `dbt build` and select the **Generate docs on run** checkbox.
-6. Run the job and make sure it runs successfully.
+3. To create a new environment, navigate to **Deploy** in the navigation menu, select **Environments**, and then select **Create new environment**.
+4. Fill in your deployment credentials with your Snowflake username and password. You can name the schema anything you want. Click **Save** to create your new production environment.
+5. [Create a new deploy job](/docs/deploy/deploy-jobs#create-and-schedule-jobs) that runs in the environment you just created. Go back to the **Deploy** menu, select **Jobs**, select **Create job**, and click **Deploy job**.
+6. Set the job to run a `dbt parse` job to parse your projects and generate a [`semantic_manifest.json` artifact](/docs/dbt-cloud-apis/sl-manifest) file. Although running `dbt build` isn't required, you can choose to do so if needed.
+7. Run the job by clicking the **Run now** button. Monitor the job's progress in real-time through the **Run summary** tab.
+
+ Once the job completes successfully, your dbt project, including the generated documentation, will be fully deployed and available for use in your production environment. If any issues arise, review the logs to diagnose and address any errors.
+
+
+
+What’s happening internally?
+
+- Merging the code into your main branch allows dbt Cloud to pull those changes and build the definition in the manifest produced by the run.
+- Re-running the job in the deployment environment helps materialize the models, which the metrics depend on, in the data platform. It also makes sure that the manifest is up to date.
+- The Semantic Layer APIs pull in the most recent manifest and enables your integration to extract metadata from it.
+
+
diff --git a/website/src/theme/DocRoot/Layout/Main/index.js b/website/src/theme/DocRoot/Layout/Main/index.js
index 7303e484863..458cb9d8716 100644
--- a/website/src/theme/DocRoot/Layout/Main/index.js
+++ b/website/src/theme/DocRoot/Layout/Main/index.js
@@ -71,7 +71,7 @@ export default function DocRootLayoutMain({
} else {
setPreData({
showisPrereleaseBanner: true,
- isPrereleaseBannerText: `You are currently viewing v${dbtVersion}, which is a prerelease of dbt Core. The latest stable version is v${latestStableRelease}`,
+ isPrereleaseBannerText: `You are viewing the docs for a prerelease version of dbt Core. There may be features described that are still in development, incomplete, or unstable. For the latest generally available features, install the latest stable version`,
});
}
// If EOLDate not set for version, do not show banner
@@ -86,12 +86,12 @@ export default function DocRootLayoutMain({
if (new Date() > new Date(EOLDate)) {
setEOLData({
showEOLBanner: true,
- EOLBannerText: `This version of dbt Core is no longer supported. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, you should upgrade to ${latestStableRelease}, the latest stable version.`,
+ EOLBannerText: `This version of dbt Core is no longer supported. There will be no more patches or security fixes. For improved performance, security, and features, upgrade to the latest stable version.`,
});
} else if (new Date() > threeMonths) {
setEOLData({
showEOLBanner: true,
- EOLBannerText: `This version of dbt Core is nearing the end of its critical support period. For better performance, improved security, and new features, you should upgrade to ${latestStableRelease}, the latest stable version.`,
+ EOLBannerText: `This version of dbt Core is nearing the end of its critical support period. For improved perfomance, security, and features, upgrade to the latest stable version.`,
});
} else {
setEOLData({
diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-consumption-lenses.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-consumption-lenses.jpg
new file mode 100644
index 00000000000..9bf6c7ca0e3
Binary files /dev/null and b/website/static/img/docs/collaborate/dbt-explorer/model-consumption-lenses.jpg differ
diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-consumption-list.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-consumption-list.jpg
new file mode 100644
index 00000000000..653fe7a2f43
Binary files /dev/null and b/website/static/img/docs/collaborate/dbt-explorer/model-consumption-list.jpg differ
diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-query-lenses.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-query-lenses.jpg
deleted file mode 100644
index caa0cc72d67..00000000000
Binary files a/website/static/img/docs/collaborate/dbt-explorer/model-query-lenses.jpg and /dev/null differ
diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-query-list.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-query-list.jpg
deleted file mode 100644
index 14c5c1ceb9c..00000000000
Binary files a/website/static/img/docs/collaborate/dbt-explorer/model-query-list.jpg and /dev/null differ
diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-query-queried-models.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-query-queried-models.jpg
deleted file mode 100644
index 6b20b501880..00000000000
Binary files a/website/static/img/docs/collaborate/dbt-explorer/model-query-queried-models.jpg and /dev/null differ
diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-query-usage-queries.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-query-usage-queries.jpg
deleted file mode 100644
index 41857b3a482..00000000000
Binary files a/website/static/img/docs/collaborate/dbt-explorer/model-query-usage-queries.jpg and /dev/null differ
diff --git a/website/static/img/docs/collaborate/dbt-explorer/most-consumed-models.jpg b/website/static/img/docs/collaborate/dbt-explorer/most-consumed-models.jpg
new file mode 100644
index 00000000000..9e14db15f90
Binary files /dev/null and b/website/static/img/docs/collaborate/dbt-explorer/most-consumed-models.jpg differ
diff --git a/website/static/img/docs/collaborate/model-consumption-queries.jpg b/website/static/img/docs/collaborate/model-consumption-queries.jpg
new file mode 100644
index 00000000000..7fe9b23866c
Binary files /dev/null and b/website/static/img/docs/collaborate/model-consumption-queries.jpg differ
diff --git a/website/static/img/docs/dbt-cloud/semantic-layer/sl-add-credential.jpg b/website/static/img/docs/dbt-cloud/semantic-layer/sl-add-credential.jpg
index b2139da47b0..30baa7acf31 100644
Binary files a/website/static/img/docs/dbt-cloud/semantic-layer/sl-add-credential.jpg and b/website/static/img/docs/dbt-cloud/semantic-layer/sl-add-credential.jpg differ
diff --git a/website/static/img/docs/dbt-cloud/semantic-layer/sl-configure-sl.jpg b/website/static/img/docs/dbt-cloud/semantic-layer/sl-configure-sl.jpg
deleted file mode 100644
index fc44f409efe..00000000000
Binary files a/website/static/img/docs/dbt-cloud/semantic-layer/sl-configure-sl.jpg and /dev/null differ
diff --git a/website/static/img/docs/dbt-cloud/semantic-layer/sl-create-service-token-page.jpg b/website/static/img/docs/dbt-cloud/semantic-layer/sl-create-service-token-page.jpg
index 8e288183be2..da7a57a3d99 100644
Binary files a/website/static/img/docs/dbt-cloud/semantic-layer/sl-create-service-token-page.jpg and b/website/static/img/docs/dbt-cloud/semantic-layer/sl-create-service-token-page.jpg differ
diff --git a/website/static/img/docs/dbt-cloud/semantic-layer/sl-credential-created.jpg b/website/static/img/docs/dbt-cloud/semantic-layer/sl-credential-created.jpg
deleted file mode 100644
index 8c0081129fa..00000000000
Binary files a/website/static/img/docs/dbt-cloud/semantic-layer/sl-credential-created.jpg and /dev/null differ
diff --git a/website/static/img/docs/dbt-cloud/semantic-layer/sl-credentials-service-token.jpg b/website/static/img/docs/dbt-cloud/semantic-layer/sl-credentials-service-token.jpg
new file mode 100644
index 00000000000..7d302201e1f
Binary files /dev/null and b/website/static/img/docs/dbt-cloud/semantic-layer/sl-credentials-service-token.jpg differ
diff --git a/website/static/img/docs/dbt-cloud/semantic-layer/sl-delete-config.jpg b/website/static/img/docs/dbt-cloud/semantic-layer/sl-delete-config.jpg
new file mode 100644
index 00000000000..c53c3e9d302
Binary files /dev/null and b/website/static/img/docs/dbt-cloud/semantic-layer/sl-delete-config.jpg differ
diff --git a/website/static/img/docs/dbt-cloud/semantic-layer/sl-select-env.jpg b/website/static/img/docs/dbt-cloud/semantic-layer/sl-select-env.jpg
new file mode 100644
index 00000000000..f19cb22f2cf
Binary files /dev/null and b/website/static/img/docs/dbt-cloud/semantic-layer/sl-select-env.jpg differ
diff --git a/website/vercel.json b/website/vercel.json
index 8fdf311e72f..f79fc959187 100644
--- a/website/vercel.json
+++ b/website/vercel.json
@@ -599,6 +599,11 @@
"destination": "/reference/global-configs/command-line-options",
"permanent": true
},
+ {
+ "source": "/reference/global-configs/legacy-behaviors",
+ "destination": "/reference/global-configs/behavior-changes",
+ "permanent": true
+ },
{
"source": "/reference/global-configs/yaml-configurations",
"destination": "/reference/global-configs/project-flags",