From 161b276cf81472fe4f6f5c989c8aef2adc82cf73 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 7 Aug 2023 11:59:58 +0100 Subject: [PATCH 1/7] Update build-metrics-intro.md add clarification that postgres supported in metricflow but not dbt cloud yet per [slack thread](https://getdbt.slack.com/archives/C046L0VTVR6/p1691092050990009?thread_ts=1691089665.187629&cid=C046L0VTVR6) - Use MetricFlow with Snowflake, BigQuery, Databricks, Postgres (CLI only), or Redshift. (dbt Cloud Postgres support coming soon) --- website/docs/docs/build/build-metrics-intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/build/build-metrics-intro.md b/website/docs/docs/build/build-metrics-intro.md index ed10a874a3c..232b3f83ee0 100644 --- a/website/docs/docs/build/build-metrics-intro.md +++ b/website/docs/docs/build/build-metrics-intro.md @@ -21,7 +21,7 @@ Before you start, consider the following guidelines: - Define metrics in YAML and query them using these [new metric specifications](https://github.com/dbt-labs/dbt-core/discussions/7456). - You must be on dbt v1.6 or higher to use MetricFlow. [Upgrade your dbt Cloud version](/docs/dbt-versions/upgrade-core-in-cloud) to get started. -- Use MetricFlow with Snowflake, Postgres, BigQuery, Databricks, or Redshift. +- Use MetricFlow with Snowflake, BigQuery, Databricks, Postgres (CLI only), or Redshift. (dbt Cloud Postgres support coming soon) - Unlock insights and query your metrics using the [dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl) and its diverse range of [available integrations](/docs/use-dbt-semantic-layer/avail-sl-integrations). From 17f4408f0311f70e09bfece56dc13e1fa1439604 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 7 Aug 2023 12:00:39 +0100 Subject: [PATCH 2/7] Update quickstart-sl.md --- website/docs/docs/use-dbt-semantic-layer/quickstart-sl.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/quickstart-sl.md b/website/docs/docs/use-dbt-semantic-layer/quickstart-sl.md index 8dbcc6c46f3..f70433cd10a 100644 --- a/website/docs/docs/use-dbt-semantic-layer/quickstart-sl.md +++ b/website/docs/docs/use-dbt-semantic-layer/quickstart-sl.md @@ -23,7 +23,7 @@ import TestQuery from '/snippets/_sl-test-and-query-metrics.md'; The dbt Semantic Layer, powered by [MetricFlow](/docs/build/about-metricflow), simplifies defining and using critical business metrics. It centralizes metric definitions, eliminates duplicate coding, and ensures consistent self-service access to metrics in downstream tools. -MetricFlow is a powerful component within the dbt Semantic Layer that helps users define and manage company metrics efficiently. It provides flexible abstractions and SQL query generation, and also allows data consumers to retrieve metric datasets quickly and easily from a data platform. +MetricFlow is a powerful component within the dbt Semantic Layer that helps users define and manage company metrics efficiently. It provides flexible abstractions and SQL query generation and also allows data consumers to retrieve metric datasets quickly and easily from a data platform. Use this guide to fully experience the power of a universal dbt Semantic Layer. Here are the following steps you'll take: From c263c9155e53c826217c89e19ff86811e49bfcb8 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 7 Aug 2023 12:01:48 +0100 Subject: [PATCH 3/7] Update _v2-sl-prerequisites.md --- website/snippets/_v2-sl-prerequisites.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/snippets/_v2-sl-prerequisites.md b/website/snippets/_v2-sl-prerequisites.md index 95d563c9359..cce4555af87 100644 --- a/website/snippets/_v2-sl-prerequisites.md +++ b/website/snippets/_v2-sl-prerequisites.md @@ -3,11 +3,11 @@ To use the Semantic Layer, you must: -- Have a dbt Cloud Team or Enterprise [multi-tenant](/docs/cloud/about-cloud/regions-ip-addresses) deployment, hosted in North America -- Have both your production and development environments running dbt version 1.6 or higher -- Use Snowflake, BigQuery, Databricks, and Redshift data platform +- Have a dbt Cloud Team or Enterprise [multi-tenant](/docs/cloud/about-cloud/regions-ip-addresses) deployment, hosted in North America. +- Have both your production and development environments running dbt version 1.6 or higher. +- Use Snowflake, BigQuery, Databricks, and Redshift. - Create a successful run in the environment where you configure the Semantic Layer.
- **Note:** Semantic Layer currently supports Deployment environment. (_development experience coming soon_) + **Note:** Semantic Layer currently supports the Deployment environment. (_development experience coming soon_) - Install the [MetricFlow CLI](/docs/build/metricflow-cli). After installing the package, make sure you run at least one model. - Set up the [Semantic Layer API](/docs/dbt-cloud-apis/sl-api-overview) in the integrated tool to import metric definitions.
**Note:** Developer accounts can only query data manually using the [MetricFlow CLI](/docs/build/metricflow-cli) and SQL. To dynamically query metrics using external tools, you must have a dbt Cloud Team or Enterprise account with access to the Semantic Layer API.
From 090ae602666d4c46ab3938b4640370c6e884fad8 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 7 Aug 2023 12:02:56 +0100 Subject: [PATCH 4/7] Update sl-getting-started.md --- website/docs/docs/build/sl-getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/build/sl-getting-started.md b/website/docs/docs/build/sl-getting-started.md index 7259a7eb22c..bfe8eb00f4d 100644 --- a/website/docs/docs/build/sl-getting-started.md +++ b/website/docs/docs/build/sl-getting-started.md @@ -29,7 +29,7 @@ To fully experience the power of a universal dbt Semantic Layer, take the follow - Have an understanding of key concepts in [MetricFlow](/docs/build/about-metricflow), which powers the revamped dbt Semantic Layer. - Have both your production and development environments running dbt version 1.6 or higher. Refer to [upgrade in dbt Cloud](/docs/dbt-versions/upgrade-core-in-cloud) for more info. -- Use Snowflake, BigQuery, Databricks, or Redshift data platform +- Use MetricFlow with Snowflake, BigQuery, Databricks, Postgres (CLI only), or Redshift. (dbt Cloud Postgres support coming soon) - A successful run in the environment where your Semantic Layer is configured - To query with dbt Cloud: * Have a dbt Cloud Team or Enterprise [multi-tenant](/docs/cloud/about-cloud/regions-ip-addresses) deployment, hosted in North America (Other regions coming soon) From 12d8824d43f2bb2beed449ff1fae0dec003deb19 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 7 Aug 2023 12:04:09 +0100 Subject: [PATCH 5/7] Update website/snippets/_v2-sl-prerequisites.md --- website/snippets/_v2-sl-prerequisites.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/snippets/_v2-sl-prerequisites.md b/website/snippets/_v2-sl-prerequisites.md index cce4555af87..28c82e6f913 100644 --- a/website/snippets/_v2-sl-prerequisites.md +++ b/website/snippets/_v2-sl-prerequisites.md @@ -5,7 +5,7 @@ To use the Semantic Layer, you must: - Have a dbt Cloud Team or Enterprise [multi-tenant](/docs/cloud/about-cloud/regions-ip-addresses) deployment, hosted in North America. - Have both your production and development environments running dbt version 1.6 or higher. -- Use Snowflake, BigQuery, Databricks, and Redshift. +- Use Snowflake, BigQuery, Databricks, or Redshift. (dbt Cloud Postgres support coming soon). - Create a successful run in the environment where you configure the Semantic Layer.
**Note:** Semantic Layer currently supports the Deployment environment. (_development experience coming soon_) - Install the [MetricFlow CLI](/docs/build/metricflow-cli). After installing the package, make sure you run at least one model. From 2d8d40162cc5b89e39b914de877ebbfb16e791d6 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 7 Aug 2023 12:04:32 +0100 Subject: [PATCH 6/7] Update website/snippets/_v2-sl-prerequisites.md --- website/snippets/_v2-sl-prerequisites.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/snippets/_v2-sl-prerequisites.md b/website/snippets/_v2-sl-prerequisites.md index 28c82e6f913..8e7075db257 100644 --- a/website/snippets/_v2-sl-prerequisites.md +++ b/website/snippets/_v2-sl-prerequisites.md @@ -5,7 +5,7 @@ To use the Semantic Layer, you must: - Have a dbt Cloud Team or Enterprise [multi-tenant](/docs/cloud/about-cloud/regions-ip-addresses) deployment, hosted in North America. - Have both your production and development environments running dbt version 1.6 or higher. -- Use Snowflake, BigQuery, Databricks, or Redshift. (dbt Cloud Postgres support coming soon). +- Use Snowflake, BigQuery, Databricks, or Redshift (dbt Cloud Postgres support coming soon). - Create a successful run in the environment where you configure the Semantic Layer.
**Note:** Semantic Layer currently supports the Deployment environment. (_development experience coming soon_) - Install the [MetricFlow CLI](/docs/build/metricflow-cli). After installing the package, make sure you run at least one model. From 36b1140b2d87f036c986919ac1ce9989e64632df Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 7 Aug 2023 12:20:47 +0100 Subject: [PATCH 7/7] Update metrics-overview.md update to required and fix typo --- website/docs/docs/build/metrics-overview.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/website/docs/docs/build/metrics-overview.md b/website/docs/docs/build/metrics-overview.md index 5607fcbab99..fd84c96e0ec 100644 --- a/website/docs/docs/build/metrics-overview.md +++ b/website/docs/docs/build/metrics-overview.md @@ -13,9 +13,9 @@ The keys for metrics definitions are: | Component | Description | Type | | --------- | ----------- | ---- | | `name` | Provide the reference name for the metric. This name must be unique amongst all metrics. | Required | -| `type` | Define the type of metric, which can be a measure (`simple`) or ratio (`ratio`)). | Optional | +| `type` | Define the type of metric, which can be a measure (`simple`) or ratio (`ratio`)). | Required | | `type_params` | Additional parameters used to configure metrics. `type_params` are different for each metric type. | Required | -| `filter` | For any type of metric, you may optionally include a filter string, which applies a filter for a dimension, entity or time dimension when computing the metric. You can think of this as your WHERE clause. | Optional | +| `filter` | For any type of metric, you may optionally include a filter string, which applies a filter for a dimension, entity, or time dimension when computing the metric. You can think of this as your WHERE clause. | Optional | | `meta` | Additional metadata you want to add to your metric. | @@ -38,7 +38,7 @@ metrics: This page explains the different supported metric types you can add to your dbt project. + ## Related docs