diff --git a/website/docs/docs/build/conversion-metrics.md b/website/docs/docs/build/conversion-metrics.md index 87031f8a77c..e079f0ba1fb 100644 --- a/website/docs/docs/build/conversion-metrics.md +++ b/website/docs/docs/build/conversion-metrics.md @@ -21,7 +21,7 @@ The specification for conversion metrics is as follows: | `name` | The name of the metric. | Required | | `description` | The description of the metric. | Optional | | `type` | The type of metric (such as derived, ratio, and so on.). In this case, set as 'conversion' | Required | -| `label` | Displayed value in downstream tools. | Required | +| `label` | Required string that defines the display value in downstream tools. Accepts plain text, spaces, and quotes (such as `orders_total` or `"orders_total"`). | Required | | `type_params` | Specific configurations for each metric type. | Required | | `conversion_type_params` | Additional configuration specific to conversion metrics. | Required | | `entity` | The entity for each conversion event. | Required | diff --git a/website/docs/docs/build/cumulative-metrics.md b/website/docs/docs/build/cumulative-metrics.md index c7a09c3b0af..6d8cdfcd0b3 100644 --- a/website/docs/docs/build/cumulative-metrics.md +++ b/website/docs/docs/build/cumulative-metrics.md @@ -15,7 +15,7 @@ This metric is common for calculating things like weekly active users, or month- | `name` | The name of the metric. | Required | | `description` | The description of the metric. | Optional | | `type` | The type of the metric (cumulative, derived, ratio, or simple). | Required | -| `label` | The value that will be displayed in downstream tools. | Required | +| `label` | Required string that defines the display value in downstream tools. Accepts plain text, spaces, and quotes (such as `orders_total` or `"orders_total"`). | Required | | `type_params` | The type parameters of the metric. | Required | | `window` | The accumulation window, such as 1 month, 7 days, 1 year. This can't be used with `grain_to_date`. | Optional | | `grain_to_date` | Sets the accumulation grain, such as month will accumulate data for one month. Then restart at the beginning of the next. This can't be used with `window`. | Optional | diff --git a/website/docs/docs/build/derived-metrics.md b/website/docs/docs/build/derived-metrics.md index b1b3fde3ad0..fe1e39990c6 100644 --- a/website/docs/docs/build/derived-metrics.md +++ b/website/docs/docs/build/derived-metrics.md @@ -15,7 +15,7 @@ In MetricFlow, derived metrics are metrics created by defining an expression usi | `name` | The name of the metric. | Required | | `description` | The description of the metric. | Optional | | `type` | The type of the metric (cumulative, derived, ratio, or simple). | Required | -| `label` | The value that will be displayed in downstream tools. | Required | +| `label` | Required string that defines the display value in downstream tools. Accepts plain text, spaces, and quotes (such as `orders_total` or `"orders_total"`). | Required | | `type_params` | The type parameters of the metric. | Required | | `expr` | The derived expression. | Required | | `metrics` | The list of metrics used in the derived metrics. | Required | @@ -49,7 +49,7 @@ metrics: - name: order_gross_profit description: Gross profit from each order. type: derived - label: Order Gross Profit + label: Order gross profit type_params: expr: revenue - cost metrics: @@ -58,7 +58,7 @@ metrics: - name: order_cost alias: cost - name: food_order_gross_profit - label: Food Order Gross Profit + label: Food order gross profit description: "The gross profit for each food order." type: derived type_params: @@ -75,7 +75,7 @@ metrics: - name: order_total_growth_mom description: "Percentage growth of orders total completed to 1 month ago" type: derived - label: Order Total Growth % M/M + label: Order total growth % M/M type_params: expr: (order_total - order_total_prev_month)*100/order_total_prev_month metrics: @@ -115,7 +115,7 @@ You can query any granularity and offset window combination. The following examp - name: d7_booking_change description: Difference between bookings now and 7 days ago type: derived - label: d7 Bookings Change + label: d7 bookings change type_params: expr: bookings - bookings_7_days_ago metrics: diff --git a/website/docs/docs/build/dimensions.md b/website/docs/docs/build/dimensions.md index 2735eef0729..d3595d4fc68 100644 --- a/website/docs/docs/build/dimensions.md +++ b/website/docs/docs/build/dimensions.md @@ -17,7 +17,6 @@ Groups are defined within semantic models, alongside entities and measures, and All dimensions require a `name`, `type` and in some cases, an `expr` parameter. The `name` for your dimension must be unique to the semantic model and can not be the same as an existing `entity` or `measure` within that same model. - | Parameter | Description | Type | | --------- | ----------- | ---- | | `name` | Refers to the name of the group that will be visible to the user in downstream tools. It can also serve as an alias if the column name or SQL query reference is different and provided in the `expr` parameter.

Dimension names should be unique within a semantic model, but they can be non-unique across different models as MetricFlow uses [joins](/docs/build/join-logic) to identify the right dimension. | Required | @@ -25,16 +24,18 @@ All dimensions require a `name`, `type` and in some cases, an `expr` parameter. | `type_params` | Specific type params such as if the time is primary or used as a partition | Required | | `description` | A clear description of the dimension | Optional | | `expr` | Defines the underlying column or SQL query for a dimension. If no `expr` is specified, MetricFlow will use the column with the same name as the group. You can use column name itself to input a SQL expression. | Optional | +| `label` | A recommended string that defines the display value in downstream tools. Accepts plain text, spaces, and quotes (such as `orders_total` or `"orders_total"`). | Optional | Refer to the following for the complete specification for dimensions: ```yaml dimensions: - - name: name of the group that will be visible to the user in downstream tools - type: Categorical or Time - type_params: specific type params such as if the time is primary or used as a partition - description: same as always - expr: the column name or expression. If not provided the default is the dimension name + - name: Name of the group that will be visible to the user in downstream tools # Required + type: Categorical or Time # Required + label: Recommended adding a string that defines the display value in downstream tools. # Optional + type_params: Specific type params such as if the time is primary or used as a partition # Required + description: Same as always # Optional + expr: The column name or expression. If not provided the default is the dimension name # Optional ``` Refer to the following example to see how dimensions are used in a semantic model: @@ -56,6 +57,7 @@ semantic_models: dimensions: - name: metric_time type: time + label: "Date of transaction" # Recommend adding a label to define the value displayed in downstream tools expr: date_trunc('day', ts) - name: is_bulk_transaction type: categorical @@ -99,7 +101,6 @@ dimensions: ### Time - :::tip use datetime data type if using BigQuery To use BigQuery as your data platform, time dimensions columns need to be in the datetime data type. If they are stored in another type, you can cast them to datetime using the `expr` property. Time dimensions are used to group metrics by different levels of time, such as day, week, month, quarter, and year. MetricFlow supports these granularities, which can be specified using the `time_granularity` parameter. ::: @@ -142,12 +143,14 @@ mf query --metrics messages_per_month --group-by metric_time__year --order metri dimensions: - name: created_at type: time + label: "Date of creation" expr: date_trunc('day', ts_created) #ts_created is the underlying column name from the table is_partition: True type_params: time_granularity: day - name: deleted_at type: time + label: "Date of deletion" expr: date_trunc('day', ts_deleted) #ts_deleted is the underlying column name from the table is_partition: True type_params: @@ -177,12 +180,14 @@ Aggregation between metrics with different granularities is possible, with the S dimensions: - name: created_at type: time + label: "Date of creation" expr: date_trunc('day', ts_created) #ts_created is the underlying column name from the table is_partition: True type_params: time_granularity: day - name: deleted_at type: time + label: "Date of deletion" expr: date_trunc('day', ts_deleted) #ts_deleted is the underlying column name from the table is_partition: True type_params: @@ -265,6 +270,7 @@ semantic_models: dimensions: - name: tier_start type: time + label: "Start date of tier" expr: start_date type_params: time_granularity: day @@ -272,6 +278,7 @@ semantic_models: is_start: True - name: tier_end type: time + label: "End date of tier" expr: end_date type_params: time_granularity: day @@ -329,6 +336,7 @@ semantic_models: dimensions: - name: metric_time type: time + label: "Date of transaction" is_partition: true type_params: time_granularity: day diff --git a/website/docs/docs/build/environment-variables.md b/website/docs/docs/build/environment-variables.md index 9f4d8412686..a8784847f33 100644 --- a/website/docs/docs/build/environment-variables.md +++ b/website/docs/docs/build/environment-variables.md @@ -36,7 +36,7 @@ To set environment variables at the project and environment level, click **Deplo You'll notice there is a `Project Default` column. This is a great place to set a value that will persist across your whole project, independent of where the code is run. We recommend setting this value when you want to supply a catch-all default or add a project-wide token or secret. -To the right of the `Project Default` column are all your environments. Values set at the environment level take priority over the project level default value. This is where you can tell dbt Cloud to interpret an environment value differently in your Staging vs. Production environment, as example. +To the right of the `Project Default` column are all your environments. Values set at the environment level take priority over the project-level default value. This is where you can tell dbt Cloud to interpret an environment value differently in your Staging vs. Production environment, as an example. @@ -98,6 +98,8 @@ dbt Cloud has a number of pre-defined variables built in. Variables are set auto **dbt Cloud IDE details** +The following environment variable is set automatically for the dbt Cloud IDE: + - `DBT_CLOUD_GIT_BRANCH`: Provides the development Git branch name in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud). - Available in dbt v 1.6 and later. - The variable changes when the branch is changed. @@ -110,7 +112,7 @@ Use case — This is useful in cases where you want to dynamically use the G **dbt Cloud context** -The following environment variables are set automatically for deployment runs, and their values cannot be changed. +The following environment variables are set automatically for deployment runs: - `DBT_ENV`: This key is reserved for the dbt Cloud application and will always resolve to 'prod' diff --git a/website/docs/docs/build/measures.md b/website/docs/docs/build/measures.md index 49ed524d6b5..5265ebf83a8 100644 --- a/website/docs/docs/build/measures.md +++ b/website/docs/docs/build/measures.md @@ -27,16 +27,14 @@ measures: agg_params: 'specific aggregation properties such as a percentile' ## Optional agg_time_dimension: The time field. Defaults to the default agg time dimension for the semantic model. ## Optional non_additive_dimension: 'Use these configs when you need non-additive dimensions.' ## Optional - label: How the metric appears in project docs and downstream integrations. ## Required ``` -### Name +### Name When you create a measure, you can either give it a custom name or use the `name` of the data platform column directly. If the `name` of the measure is different from the column name, you need to add an `expr` to specify the column name. The `name` of the measure is used when creating a metric. Measure names must be unique across all semantic models in a project and can not be the same as an existing `entity` or `dimension` within that same model. - ### Description The description describes the calculated measure. It's strongly recommended you create verbose and human-readable descriptions in this field. diff --git a/website/docs/docs/build/metricflow-commands.md b/website/docs/docs/build/metricflow-commands.md index 6ff5cf16a01..035eb5fcf53 100644 --- a/website/docs/docs/build/metricflow-commands.md +++ b/website/docs/docs/build/metricflow-commands.md @@ -84,6 +84,10 @@ You can use the `dbt sl` prefix before the command name to execute them in the d - [`tutorial`](#tutorial) — Dedicated MetricFlow tutorial to help get you started. --> +:::tip Run dbt parse to reflect metric changes +When you make changes to metrics, make sure to run `dbt parse` at a minimum to update the dbt Semantic Layer. This updates the `semantic_manifest.json` file, reflecting your changes when querying metrics. By running `dbt parse`, you won't need to rebuild all the models. +::: + Check out the following video for a short video demo of how to query or preview metrics with the dbt Cloud CLI: diff --git a/website/docs/docs/build/metrics-overview.md b/website/docs/docs/build/metrics-overview.md index 483098cc47d..39df3f9f5fe 100644 --- a/website/docs/docs/build/metrics-overview.md +++ b/website/docs/docs/build/metrics-overview.md @@ -21,8 +21,8 @@ The keys for metrics definitions are: | `description` | Describe your metric. | Optional | | `type` | Define the type of metric, which can be `conversion`, `cumulative`, `derived`, `ratio`, or `simple`. | Required | | `type_params` | Additional parameters used to configure metrics. `type_params` are different for each metric type. | Required | +| `label` | Required string that defines the display value in downstream tools. Accepts plain text, spaces, and quotes (such as `orders_total` or `"orders_total"`). | Required | | `config` | Use the [`config`](/reference/resource-properties/config) property to specify configurations for your metric. Supports [`meta`](/reference/resource-configs/meta), [`group`](/reference/resource-configs/group), and [`enabled`](/reference/resource-configs/enabled) configurations. | Optional | -| `label` | The display name for your metric. This value will be shown in downstream tools. | Required | | `filter` | You can optionally add a filter string to any metric type, applying filters to dimensions, entities, or time dimensions during metric computation. Consider it as your WHERE clause. | Optional | Here's a complete example of the metrics spec configuration: @@ -56,7 +56,7 @@ metrics: | `type_params` | Additional parameters used to configure metrics. `type_params` are different for each metric type. | Required | | `config` | Provide the specific configurations for your metric. | Optional | | `meta` | Use the [`meta` config](/reference/resource-configs/meta) to set metadata for a resource. | Optional | -| `label` | The display name for your metric. This value will be shown in downstream tools. | Required | +| `label` | Required string that defines the display value in downstream tools. Accepts plain text, spaces, and quotes (such as `orders_total` or `"orders_total"`). | Required | | `filter` | You can optionally add a filter string to any metric type, applying filters to dimensions, entities, or time dimensions during metric computation. Consider it as your WHERE clause. | Optional | Here's a complete example of the metrics spec configuration: @@ -123,7 +123,7 @@ metrics: owners: - support@getdbt.com type: cumulative - label: Weekly Active Users + label: Weekly active users type_params: measure: name: active_users @@ -144,7 +144,7 @@ metrics: - name: order_gross_profit description: Gross profit from each order. type: derived - label: Order Gross Profit + label: Order gross profit type_params: expr: revenue - cost metrics: @@ -206,9 +206,8 @@ metrics: - `name`— Use this parameter to define the reference name of the metric. The name must be unique amongst metrics and can include lowercase letters, numbers, and underscores. You can use this name to call the metric from the dbt Semantic Layer API. - +**Note:** If you've already defined the measure using the `create_metric: True` parameter, you don't need to create simple metrics. However, if you would like to include a constraint on top of the measure, you will need to create a simple type metric. + ```yaml metrics: - name: cancellations diff --git a/website/docs/docs/build/packages.md b/website/docs/docs/build/packages.md index 92ad678b271..aae8cc94361 100644 --- a/website/docs/docs/build/packages.md +++ b/website/docs/docs/build/packages.md @@ -94,7 +94,7 @@ Some package maintainers may wish to push prerelease versions of packages to the By default, `dbt deps` will not include prerelease versions when resolving package dependencies. You can enable the installation of prereleases in one of two ways: - Explicitly specifying a prerelease version in your `version` criteria -- Setting `install-prerelease` to `true`, and providing a compatible version range +- Setting `install_prerelease` to `true`, and providing a compatible version range For example, both of the following configurations would successfully install `0.4.5-a2` for the [`dbt_artifacts` package](https://hub.getdbt.com/brooklyn-data/dbt_artifacts/latest/): @@ -108,7 +108,7 @@ packages: packages: - package: brooklyn-data/dbt_artifacts version: [">=0.4.4", "<0.4.6"] - install-prerelease: true + install_prerelease: true ``` ### Git packages diff --git a/website/docs/docs/build/project-variables.md b/website/docs/docs/build/project-variables.md index a328731c7d4..8ed0d86aa9e 100644 --- a/website/docs/docs/build/project-variables.md +++ b/website/docs/docs/build/project-variables.md @@ -110,7 +110,7 @@ The order of precedence for variable declaration is as follows (highest priority -If dbt is unable to find a definition for a variable after checking these four places, then a compilation error will be raised. +If dbt is unable to find a definition for a variable after checking all possible variable declaration places, then a compilation error will be raised. **Note:** Variable scope is based on the node ultimately using that variable. Imagine the case where a model defined in the root project is calling a macro defined in an installed package. That macro, in turn, uses the value of a variable. The variable will be resolved based on the _root project's_ scope, rather than the package's scope. diff --git a/website/docs/docs/build/ratio-metrics.md b/website/docs/docs/build/ratio-metrics.md index 014131a0939..fa9b8001970 100644 --- a/website/docs/docs/build/ratio-metrics.md +++ b/website/docs/docs/build/ratio-metrics.md @@ -8,14 +8,14 @@ tags: [Metrics, Semantic Layer] Ratio allows you to create a ratio between two metrics. You simply specify a numerator and a denominator metric. Additionally, you can apply a dimensional filter to both the numerator and denominator using a constraint string when computing the metric. - The parameters, description, and type for ratio metrics are: + The parameters, description, and type for ratio metrics are: | Parameter | Description | Type | | --------- | ----------- | ---- | | `name` | The name of the metric. | Required | | `description` | The description of the metric. | Optional | | `type` | The type of the metric (cumulative, derived, ratio, or simple). | Required | -| `label` | The value that will be displayed in downstream tools. | Required | +| `label` | Required string that defines the display value in downstream tools. Accepts plain text, spaces, and quotes (such as `orders_total` or `"orders_total"`). | Required | | `type_params` | The type parameters of the metric. | Required | | `numerator` | The name of the metric used for the numerator, or structure of properties. | Required | | `denominator` | The name of the metric used for the denominator, or structure of properties. | Required | @@ -29,7 +29,7 @@ metrics: - name: The metric name # Required description: the metric description # Optional type: ratio # Required - label: The value that will be displayed in downstream tools #Required + label: String that defines the display value in downstream tools. (such as orders_total or "orders_total") #Required type_params: # Required numerator: The name of the metric used for the numerator, or structure of properties # Required name: Name of metric used for the numerator # Required @@ -49,7 +49,7 @@ For advanced data modeling, you can use `fill_nulls_with` and `join_to_timespine metrics: - name: food_order_pct description: "The food order count as a ratio of the total order count" - label: Food Order Ratio + label: Food order ratio type: ratio type_params: numerator: food_orders diff --git a/website/docs/docs/build/seeds.md b/website/docs/docs/build/seeds.md index 59d75b2ae8b..b8074cf5649 100644 --- a/website/docs/docs/build/seeds.md +++ b/website/docs/docs/build/seeds.md @@ -81,7 +81,7 @@ You can document and test seeds in YAML by declaring properties — check out th ## FAQs - + diff --git a/website/docs/docs/build/semantic-models.md b/website/docs/docs/build/semantic-models.md index 37c994d50d2..95969b63437 100644 --- a/website/docs/docs/build/semantic-models.md +++ b/website/docs/docs/build/semantic-models.md @@ -24,7 +24,6 @@ import SLCourses from '/snippets/_sl-course.md'; - Here we describe the Semantic model components with examples: | Component | Description | Type | @@ -147,22 +146,23 @@ Semantic models support [`meta`](/reference/resource-configs/meta), [`group`](/r -### Name +### Name Define the name of the semantic model. You must define a unique name for the semantic model. The semantic graph will use this name to identify the model, and you can update it at any time. Avoid using double underscores (__) in the name as they're not supported. -### Description +### Description Includes important details in the description of the semantic model. This description will primarily be used by other configuration contributors. You can use the pipe operator `(|)` to include multiple lines in the description. -### Model +### Model Specify the dbt model for the semantic model using the [`ref` function](/reference/dbt-jinja-functions/ref). ### Defaults -Defaults for the semantic model. Currently only `agg_time_dimension`. `agg_time_dimension` represents the default time dimensions for measures. This can be overridden by adding the `agg_time_dimension` key directly to a measure - see [Dimensions](/docs/build/dimensions) for examples. -### Entities +Defaults for the semantic model. Currently only `agg_time_dimension`. `agg_time_dimension` represents the default time dimensions for measures. This can be overridden by adding the `agg_time_dimension` key directly to a measure - see [Dimensions](/docs/build/dimensions) for examples. + +### Entities To specify the [entities](/docs/build/entities) in your model, use their columns as join keys and indicate their `type` as primary, foreign, or unique keys with the type parameter. diff --git a/website/docs/docs/build/simple.md b/website/docs/docs/build/simple.md index 88d01328d9c..6377448b838 100644 --- a/website/docs/docs/build/simple.md +++ b/website/docs/docs/build/simple.md @@ -16,7 +16,7 @@ Simple metrics are metrics that directly reference a single measure, without any | `name` | The name of the metric. | Required | | `description` | The description of the metric. | Optional | | `type` | The type of the metric (cumulative, derived, ratio, or simple). | Required | -| `label` | The value that will be displayed in downstream tools. | Required | +| `label` | Required string that defines the display value in downstream tools. Accepts plain text, spaces, and quotes (such as `orders_total` or `"orders_total"`). | Required | | `type_params` | The type parameters of the metric. | Required | | `measure` | A list of measure inputs | Required | | `measure:name` | The measure you're referencing. | Required | @@ -64,7 +64,7 @@ If you've already defined the measure using the `create_metric: true` parameter, - name: large_orders description: "Order with order values over 20." type: SIMPLE - label: Large Orders + label: Large orders type_params: measure: name: orders diff --git a/website/docs/docs/collaborate/explore-projects.md b/website/docs/docs/collaborate/explore-projects.md index af0241ba6ca..4633e86d86c 100644 --- a/website/docs/docs/collaborate/explore-projects.md +++ b/website/docs/docs/collaborate/explore-projects.md @@ -12,7 +12,7 @@ With dbt Explorer, you can view your project's [resources](/docs/build/projects) ## Prerequisites -- You have a [multi-tenant](/docs/cloud/about-cloud/tenancy#multi-tenant) or AWS single-tenant dbt Cloud account on the [Team or Enterprise plan](https://www.getdbt.com/pricing/). +- You have a dbt Cloud account on the [Team or Enterprise plan](https://www.getdbt.com/pricing/). - You have set up a [production deployment environment](/docs/deploy/deploy-environments#set-as-production-environment) for each project you want to explore. - There has been at least one successful job run in the production deployment environment. - You are on the dbt Explorer page. To do this, select **Explore** from the top navigation bar in dbt Cloud. diff --git a/website/docs/faqs/Tests/configurable-data-path.md b/website/docs/faqs/Seeds/configurable-data-path.md similarity index 100% rename from website/docs/faqs/Tests/configurable-data-path.md rename to website/docs/faqs/Seeds/configurable-data-path.md diff --git a/website/docs/guides/sl-partner-integration-guide.md b/website/docs/guides/sl-partner-integration-guide.md index cf19f914d30..8d14755db05 100644 --- a/website/docs/guides/sl-partner-integration-guide.md +++ b/website/docs/guides/sl-partner-integration-guide.md @@ -50,8 +50,6 @@ Please send us the following header with every query: Additionally, it would be helpful if you also included the email and username of the person generating the query from your application. - - ## Use best practices when exposing metrics Best practices for exposing metrics are summarized into five themes: @@ -93,7 +91,7 @@ By implementing these recommendations, the data interaction process becomes more We recommend organizing metrics and dimensions in ways that a non-technical user can understand the data model, without needing much context: -- **Organizing dimensions** — To help non-technical users understand the data model better, we recommend organizing dimensions based on the entity they originated from. For example, consider dimensions like `user__country` and `product__category`.

You can create groups by extracting `user` and `product` and then nest the respective dimensions under each group. This way, dimensions align with the entity or semantic model they belong to and make them more user-friendly and accessible. +- **Organizing dimensions** — To help non-technical users understand the data model better, we recommend organizing dimensions based on the entity they originated from. For example, consider dimensions like `user__country` and `product__category`.

You can create groups by extracting `user` and `product` and then nest the respective dimensions under each group. This way, dimensions align with the entity or semantic model they belong to and make them more user-friendly and accessible. Additionally, we recommending adding a `label` parameter to dimensions in order to define the value displayed in downstream tools. - **Organizing metrics** — The goal is to organize metrics into a hierarchy in our configurations, instead of presenting them in a long list.

This hierarchy helps you organize metrics based on specific criteria, such as business unit or team. By providing this structured organization, users can find and navigate metrics more efficiently, enhancing their overall data analysis experience. @@ -170,7 +168,6 @@ These are recommendations on how to evolve a Semantic Layer integration and not * Querying dimensions without metrics and other more advanced querying functionality * Suggest metrics to users based on teams/identity, and so on. - ### Related docs - [dbt Semantic Layer FAQs](/docs/use-dbt-semantic-layer/sl-faqs) - [Use the dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl) to learn about the product. @@ -178,4 +175,4 @@ These are recommendations on how to evolve a Semantic Layer integration and not - [dbt Semantic Layer integrations page](https://www.getdbt.com/product/semantic-layer-integrations) for information about the available partner integrations. - \ No newline at end of file + diff --git a/website/docs/reference/resource-configs/check_cols.md b/website/docs/reference/resource-configs/check_cols.md index 50a34b6a87e..bd187409379 100644 --- a/website/docs/reference/resource-configs/check_cols.md +++ b/website/docs/reference/resource-configs/check_cols.md @@ -8,7 +8,7 @@ datatype: "[column_name] | all" ```jinja2 {{ config( strategy="check", - updated_at=["column_name"] + check_cols=["column_name"] ) }} ``` diff --git a/website/snippets/_sl-measures-parameters.md b/website/snippets/_sl-measures-parameters.md index e41268a5867..d3310968eb6 100644 --- a/website/snippets/_sl-measures-parameters.md +++ b/website/snippets/_sl-measures-parameters.md @@ -1,12 +1,10 @@ -| Parameter | Description | +| Parameter | Description | | --- | --- | --- | | [`name`](/docs/build/measures#name) | Provide a name for the measure, which must be unique and can't be repeated across all semantic models in your dbt project. | Required | | [`description`](/docs/build/measures#description) | Describes the calculated measure. | Optional | | [`agg`](/docs/build/measures#description) | dbt supports the following aggregations: `sum`, `max`, `min`, `avg`, `median`, `count_distinct`, and `sum_boolean`. | Required | | [`expr`](/docs/build/measures#expr) | Either reference an existing column in the table or use a SQL expression to create or derive a new one. | Optional | | [`non_additive_dimension`](/docs/build/measures#non-additive-dimensions) | Non-additive dimensions can be specified for measures that cannot be aggregated over certain dimensions, such as bank account balances, to avoid producing incorrect results. | Optional | -| `agg_params` | Specific aggregation properties such as a percentile. | Optional | +| `agg_params` | Specific aggregation properties such as a percentile. | Optional | | `agg_time_dimension` | The time field. Defaults to the default agg time dimension for the semantic model. | Optional | 1.6 and higher | -| `label`* | How the metric appears in project docs and downstream integrations. | Required | -| `create_metric`* | You can create a metric directly from a measure with `create_metric: True` and specify its display name with `create_metric_display_name`. | Optional | -*Available on dbt version 1.7 or higher. +| `create_metric` | Create a `simple` metric from a measure by setting `create_metric: True`. Specify its display name with `create_metric_display_name`. Available in dbt version 1.7 or higher. | Optional | diff --git a/website/snippets/_sl-test-and-query-metrics.md b/website/snippets/_sl-test-and-query-metrics.md index ef1cc55cbe1..2b3594002a4 100644 --- a/website/snippets/_sl-test-and-query-metrics.md +++ b/website/snippets/_sl-test-and-query-metrics.md @@ -24,9 +24,9 @@ Refer to the following steps to get started: 2. Run a dbt command, such as `dbt parse`, `dbt run`, `dbt compile`, or `dbt build`. If you don't, you'll receive an error message that begins with: "ensure that you've ran an artifacts....". 3. MetricFlow builds a semantic graph and generates a `semantic_manifest.json` file in dbt Cloud, which is stored in the `/target` directory. If using the Jaffle Shop example, run `dbt seed && dbt run` to ensure the required data is in your data platform before proceeding. -:::info Run dbt parse when you make changes to metrics -Any time you make changes to metrics, you need to run `dbt parse` at a minimum. This ensures the `semantic_manifest.json` file is updated and you can have your changes reflected when querying metrics. -::: +:::tip Run dbt parse to reflect metric changes +When you make changes to metrics, make sure to run `dbt parse` at a minimum to update the dbt Semantic Layer. This updates the `semantic_manifest.json` file, reflecting your changes when querying metrics. By running `dbt parse`, you won't need to rebuild all the models. +:: 4. Run `dbt sl --help` to confirm you have MetricFlow installed and that you can view the available commands. 5. Run `dbt sl query --metrics --group-by ` to query the metrics and dimensions. For example, to query the `order_total` and `order_count` (both metrics), and then group them by the `order_date` (dimension), you would run: diff --git a/website/snippets/cloud-feature-parity.md b/website/snippets/cloud-feature-parity.md index f97e1ad1bd1..c3e472cbedc 100644 --- a/website/snippets/cloud-feature-parity.md +++ b/website/snippets/cloud-feature-parity.md @@ -6,8 +6,8 @@ The following table outlines which dbt Cloud features are supported on the diffe | dbt Cloud IDE | ✅ | ✅ | ✅ | | dbt Cloud CLI | ✅ | ✅ | ❌ | | Audit logs | ✅ | ✅ | ✅ | -| Discovery API | ✅ | ✅ | ❌ | -| dbt Explorer | ✅ | ✅ | ❌ | +| Discovery API | ✅ | ✅ | ✅ | +| dbt Explorer | ✅ | ✅ | ✅ | | Webhooks (Outbound) | ✅ | ✅ | ❌ | | Continuous Integration, including CI jobs | ✅ | ✅ | ✅ | | dbt Semantic Layer | ✅ | ✅ (Upon request) | ❌ | diff --git a/website/src/css/custom.css b/website/src/css/custom.css index 38389a71b53..10d398c2bc6 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -1226,17 +1226,22 @@ html[data-theme="dark"] .main-wrapper nav a:active { /* keys wrapper */ button .DocSearch-Button-Keys { - border: 1px solid var(--docsearch-muted-color-for-keys); - border-radius: 5px; + border: none; padding: 0.24em 0.5em; - gap: 0.1em; + gap: 0; + margin-right: -13px; } /* single key */ button .DocSearch-Button-Key { - font-size: 1.25rem; + font-size: 1.12rem; + line-height: 1em; + vertical-align: middle; margin-right: 0; - padding: 4px 4px 2px; + padding: 0.24em 0.4em 2px; + width: 0; + height: 1em; + gap: 0; } /* Add dark background on hover for searchbox */ diff --git a/website/vercel.json b/website/vercel.json index 077f3e54a74..2401bd989b4 100644 --- a/website/vercel.json +++ b/website/vercel.json @@ -2,6 +2,11 @@ "cleanUrls": true, "trailingSlash": false, "redirects": [ + { + "source": "/docs/faqs/Tests/configurable-data-path", + "destination": "/docs/faqs/Seeds/configurable-data-path", + "permanent": true + }, { "source": "/docs/build/sl-getting-started", "destination": "/guides/sl-snowflake-qs", @@ -4842,7 +4847,7 @@ }, { "key": "Content-Security-Policy", - "value": "img-src 'self' https:;" + "value": "img-src 'self' data: https:;" }, { "key": "Strict-Transport-Security",