-
Notifications
You must be signed in to change notification settings - Fork 977
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update build-metrics-intro.md #4128
Merged
Merged
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
8b05f83
Update build-metrics-intro.md
mirnawong1 18e59fa
folding in user feedback to clarify core/dev avail
mirnawong1 bd3383d
Merge branch 'current' into mirnawong1-patch-5
mirnawong1 657afc9
Update website/docs/docs/build/about-metricflow.md
mirnawong1 140c4a0
Update website/docs/docs/build/build-metrics-intro.md
mirnawong1 2a70b13
Update website/docs/docs/build/sl-getting-started.md
mirnawong1 ec5d5ff
Update website/docs/docs/use-dbt-semantic-layer/quickstart-sl.md
mirnawong1 35e160a
Update website/docs/docs/use-dbt-semantic-layer/quickstart-sl.md
mirnawong1 d41569f
Update website/docs/docs/build/sl-getting-started.md
mirnawong1 7df8079
Update website/snippets/_v2-sl-prerequisites.md
mirnawong1 d29aa94
Update website/docs/docs/build/sl-getting-started.md
mirnawong1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,9 +23,9 @@ 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, a powerful component of the dbt Semantic Layer, simplifies the creation and management of company metrics. It offers flexible abstractions, SQL query generation, and enables fast retrieval of metric datasets 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: | ||
Use this guide to fully experience the power of the universal dbt Semantic Layer. Here are the following steps you'll take: | ||
|
||
- [Create a semantic model](#create-a-semantic-model) in dbt Cloud using MetricFlow | ||
- [Define metrics](#define-metrics) in dbt Cloud using MetricFlow | ||
|
@@ -34,6 +34,10 @@ Use this guide to fully experience the power of a universal dbt Semantic Layer. | |
- [Set up dbt Semantic Layer](#setup) in dbt Cloud | ||
- [Connect and query API](#connect-and-query-api) with dbt Cloud | ||
|
||
|
||
MetricFlow allows users to define metrics in their dbt project whether in dbt Cloud or in dbt Core. dbt Core users can use the [MetricFlow CLI](/docs/build/metricflow-cli) to define metrics in their local dbt Core project. | ||
|
||
However, to experience the power of the universal [dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl) and query those metrics in downstream tools, you'll need a dbt Cloud [Team or Enterprise](https://www.getdbt.com/pricing/) account. | ||
## Prerequisites | ||
|
||
import SetUp from '/snippets/_v2-sl-prerequisites.md'; | ||
|
@@ -86,7 +90,7 @@ import SlSetUp from '/snippets/_new-sl-setup.md'; | |
|
||
You can query your metrics in a JDBC-enabled tool or use existing first-class integrations with the dbt Semantic Layer. | ||
|
||
Before you begin, you must have a dbt Cloud Team or Enterprise [multi-tenant](/docs/cloud/about-cloud/regions-ip-addresses) deployment, hosted in North America (cloud.getdbt.com login). | ||
You must have a dbt Cloud Team or Enterprise [multi-tenant](/docs/cloud/about-cloud/regions-ip-addresses) deployment, hosted in North America (Additional region support coming soon). | ||
|
||
- <span>To learn how to use the JDBC API and what tools you can query it with, refer to the <a href="https://docs.getdbt.com/docs/dbt-cloud-apis/sl-api-overview" target="_self">{frontMatter.meta.api_name}</a></span>.<br /> | ||
|
||
|
@@ -112,13 +116,11 @@ User data passes through the Semantic Layer on its way back from the warehouse. | |
</details> | ||
<details> | ||
<summary>Is the dbt Semantic Layer open source?</summary> | ||
The dbt Semantic Layer is proprietary, however, some components of the dbt Semantic Layer are open source, like dbt-core and MetricFlow. <br /><br />The universal dbt Semantic Layer is available to all Team and Enterprise Plans during public beta. Users on dbt Cloud Developer plans or dbt Core users can use MetricFlow to only define and test metrics locally.</details> | ||
The dbt Semantic Layer is proprietary, however, some components of the dbt Semantic Layer are open source, like dbt-core and MetricFlow. <br /><br />dbt Cloud Developer or dbt Core users can define metrics in their project, including a local dbt Core project, using the dbt Cloud IDE or the MetricFlow CLI. However, to experience the universal dbt Semantic Layer and access those metrics using the API or downstream tools, users will must be on a dbt Cloud <a href="https://www.getdbt.com/pricing/">Team or Enterprise plan.</a></details> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same feedback (as further up) regarding MetricFlow CLI availability for dbt Cloud Developer users. If you scroll up to line 38 in this same doc, it only mentions dbt Core. |
||
<br></br> | ||
|
||
## Next steps | ||
|
||
Review the following documents to learn more and get started: | ||
|
||
- [Build your metrics](/docs/build/build-metrics-intro) | ||
- [Set up dbt Semantic Layer](docs/use-dbt-semantic-layer/setup-dbt-sl) | ||
- [Available integrations](/docs/use-dbt-semantic-layer/avail-sl-integrations) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
<span>During <a href="https://docs.getdbt.com/docs/dbt-versions/release-notes/Aug-2023/sl-revamp-beta#public-beta" target="_self">{props.cycle}</a>, you can access {props.product} on <a href="https://www.getdbt.com/pricing/">{props.plan}</a> multi-tenant plans <a href="https://docs.getdbt.com/docs/cloud/about-cloud/regions-ip-addresses" target="_self">{props.instance}</a> (cloud.getdbt.com login). It's available on dbt v1.6 or higher. dbt Cloud Developer plans and dbt Core users can use MetricFlow to define and test metrics locally, but can't dynamically query them with integrated tools.</span><br /><br /> | ||
<span>To define and query metrics with the {props.product}, you must be on a <a href="https://www.getdbt.com/pricing/">{props.plan}</a> multi-tenant plan, <a href="https://docs.getdbt.com/docs/cloud/about-cloud/regions-ip-addresses" target="_self">{props.instance}</a> (Additional region support coming soon).<br /><br /> The re-released dbt Semantic Layer is available on dbt v1.6 or higher. dbt Core users can use the <a href="https://docs.getdbt.com/docs/build/metricflow-cli">MetricFlow CLI</a> to define metrics in their local project, but won't be able dynamically query them with integrated tools.</span><br /><br /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The MetricFlow CLI installation instructions state: You can install MetricFlow using PyPI as an extension of your
dbt adapter in the CLI
." Will that have to do additional installations outside of just MetricFlow to get this working with a dbt Cloud Developer account? If so, we may need to add that to the CLI page as I don't see any mentions of it working with a cloud account.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the cli doesn't work in cloud so we don't need to add the info. but maybe i can add 'ide' to clarify.