Skip to content
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

Sl deprecation #4620

Merged
merged 33 commits into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
573b65e
deprecated content
mirnawong1 Dec 6, 2023
8b00253
updat elink
mirnawong1 Dec 6, 2023
a280913
removing metric and metrics schema
mirnawong1 Dec 7, 2023
d569754
update sidebar
mirnawong1 Dec 11, 2023
09407b6
Merge branch 'current' into sl-deprecation
mirnawong1 Dec 11, 2023
8ee808d
Create legacy-sl.md
mirnawong1 Dec 11, 2023
9edcc6d
update rn
mirnawong1 Dec 11, 2023
f9c7d9b
tweaks of rn
mirnawong1 Dec 11, 2023
4113f88
remove link as redundant
mirnawong1 Dec 11, 2023
e7edde9
Merge branch 'current' into sl-deprecation
mirnawong1 Dec 11, 2023
36a30c0
fix broken links
mirnawong1 Dec 11, 2023
3c5bb3f
Merge branch 'sl-deprecation' of https://github.com/dbt-labs/docs.get…
mirnawong1 Dec 11, 2023
c4cdcda
fix broken links
mirnawong1 Dec 11, 2023
f236d2b
Merge branch 'current' into sl-deprecation
mirnawong1 Dec 11, 2023
f0235af
remove version blocks
mirnawong1 Dec 11, 2023
cfde487
Merge branch 'current' into sl-deprecation
mirnawong1 Dec 11, 2023
0408a62
tweak
mirnawong1 Dec 11, 2023
66f2ce8
Merge branch 'sl-deprecation' of https://github.com/dbt-labs/docs.get…
mirnawong1 Dec 11, 2023
eda9ad9
add notice
mirnawong1 Dec 12, 2023
a761276
update notice
mirnawong1 Dec 12, 2023
16e9d20
Merge branch 'current' into sl-deprecation
mirnawong1 Dec 12, 2023
7166bb7
tweak
mirnawong1 Dec 12, 2023
c84a378
change
mirnawong1 Dec 12, 2023
a0b2d9d
fi bullets
mirnawong1 Dec 12, 2023
a4e83e4
Update website/snippets/_sl-deprecation-notice.md
mirnawong1 Dec 13, 2023
735edf3
Update website/docs/docs/dbt-versions/release-notes/74-Dec-2023/legac…
mirnawong1 Dec 13, 2023
5a2b28e
Update website/snippets/_new-sl-setup.md
mirnawong1 Dec 13, 2023
a8a3e31
Merge branch 'current' into sl-deprecation
mirnawong1 Dec 13, 2023
1d66dfd
Update website/docs/docs/dbt-versions/release-notes/74-Dec-2023/legac…
mirnawong1 Dec 13, 2023
8083366
Update website/docs/docs/dbt-versions/release-notes/74-Dec-2023/legac…
mirnawong1 Dec 13, 2023
fb52a37
Merge branch 'current' into sl-deprecation
mirnawong1 Dec 14, 2023
ec3a6da
Merge branch 'current' into sl-deprecation
mirnawong1 Dec 15, 2023
abcafe4
Merge branch 'current' into sl-deprecation
mirnawong1 Dec 15, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
696 changes: 0 additions & 696 deletions website/docs/docs/build/metrics.md

This file was deleted.

2 changes: 1 addition & 1 deletion website/docs/docs/build/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ At a minimum, all a project needs is the `dbt_project.yml` project configuration
| [docs](/docs/collaborate/documentation) | Docs for your project that you can build. |
| [sources](/docs/build/sources) | A way to name and describe the data loaded into your warehouse by your Extract and Load tools. |
| [exposures](/docs/build/exposures) | A way to define and describe a downstream use of your project. |
| [metrics](/docs/build/metrics) | A way for you to define metrics for your project. |
| [metrics](/docs/build/build-metrics-intro) | A way for you to define metrics for your project. |
| [groups](/docs/build/groups) | Groups enable collaborative node organization in restricted collections. |
| [analysis](/docs/build/analyses) | A way to organize analytical SQL queries in your project such as the general ledger from your QuickBooks. |

Expand Down

This file was deleted.

This file was deleted.

8 changes: 3 additions & 5 deletions website/docs/docs/dbt-cloud-apis/sl-api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ pagination_next: "docs/dbt-cloud-apis/sl-jdbc"

<VersionBlock lastVersion="1.5">

import LegacyInfo from '/snippets/_legacy-sl-callout.md';

<LegacyInfo />
import DeprecationNotice from '/snippets/_sl-deprecation-notice.md';

<DeprecationNotice />

</VersionBlock>

The rapid growth of different tools in the modern data stack has helped data professionals address the diverse needs of different teams. The downside of this growth is the fragmentation of business logic across teams, tools, and workloads.
Expand Down Expand Up @@ -57,5 +57,3 @@ plan="dbt Cloud Team or Enterprise"
icon="dbt-bit"/>

</div>


6 changes: 3 additions & 3 deletions website/docs/docs/dbt-cloud-apis/sl-graphql.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ tags: [Semantic Layer, APIs]

<VersionBlock lastVersion="1.5">

import LegacyInfo from '/snippets/_legacy-sl-callout.md';

<LegacyInfo />
import DeprecationNotice from '/snippets/_sl-deprecation-notice.md';

<DeprecationNotice />

</VersionBlock>


Expand Down
6 changes: 3 additions & 3 deletions website/docs/docs/dbt-cloud-apis/sl-jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ tags: [Semantic Layer, API]

<VersionBlock lastVersion="1.5">

import LegacyInfo from '/snippets/_legacy-sl-callout.md';

<LegacyInfo />
import DeprecationNotice from '/snippets/_sl-deprecation-notice.md';

<DeprecationNotice />

</VersionBlock>

The dbt Semantic Layer Java Database Connectivity (JDBC) API enables users to query metrics and dimensions using the JDBC protocol, while also providing standard metadata functionality.
Expand Down
7 changes: 3 additions & 4 deletions website/docs/docs/dbt-cloud-apis/sl-manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ pagination_next: null

<VersionBlock lastVersion="1.5">

import LegacyInfo from '/snippets/_legacy-sl-callout.md';

<LegacyInfo />
import DeprecationNotice from '/snippets/_sl-deprecation-notice.md';

<DeprecationNotice />

</VersionBlock>

dbt creates an [artifact](/reference/artifacts/dbt-artifacts) file called the _Semantic Manifest_ (`semantic_manifest.json`), which MetricFlow requires to build and run metric queries properly for the dbt Semantic Layer. This artifact contains comprehensive information about your dbt Semantic Layer. It is an internal file that acts as the integration point with MetricFlow.
Expand Down Expand Up @@ -97,4 +97,3 @@ Top-level keys for the semantic manifest are:

- [dbt Semantic Layer API](/docs/dbt-cloud-apis/sl-api-overview)
- [About dbt artifacts](/reference/artifacts/dbt-artifacts)

Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ For more detailed information and to ask any questions, please visit [dbt-core/d

- [**Events and structured logging**](/reference/events-logging): dbt's event system got a makeover. Expect more consistency in the availability and structure of information, backed by type-safe event schemas.
- [**Python support**](/faqs/Core/install-python-compatibility): Python 3.11 was released in October 2022. It is officially supported in dbt-core v1.4, although full support depends also on the adapter plugin for your data platform. According to the Python maintainers, "Python 3.11 is between 10-60% faster than Python 3.10." We encourage you to try [`dbt parse`](/reference/commands/parse) with dbt Core v1.4 + Python 3.11, and compare the timing with dbt Core v1.3 + Python 3.10. Let us know what you find!
- [**Metrics**](/docs/build/metrics): `time_grain` is optional, to provide better ergonomics around metrics that aren't time-bound.
- [**Metrics**](/docs/build/build-metrics-intro): `time_grain` is optional, to provide better ergonomics around metrics that aren't time-bound.
- **dbt-Jinja context:** The [local_md5](/reference/dbt-jinja-functions/local_md5) context method will calculate an [MD5 hash](https://en.wikipedia.org/wiki/MD5) for use _within_ dbt. (Not to be confused with SQL md5!)
- [**Exposures**](/docs/build/exposures) can now depend on `metrics`.
- [**"Tarball" packages**](/docs/build/packages#internally-hosted-tarball-URL): Some organizations have security requirements to pull resources only from internal services. To address the need to install packages from hosted environments (such as Artifactory or cloud storage buckets), it's possible to specify any accessible URL where a compressed dbt package can be downloaded.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ GitHub discussion with details: [dbt-labs/dbt-core#6011](https://github.com/dbt-
## New and changed documentation

- **[Python models](/docs/build/python-models)** are natively supported in `dbt-core` for the first time, on data warehouses that support Python runtimes.
- Updates made to **[Metrics](/docs/build/metrics)** reflect their new syntax for definition, as well as additional properties that are now available.
- Updates made to **[Metrics](/docs/build/build-metrics-intro)** reflect their new syntax for definition, as well as additional properties that are now available.
- Plus, a few related updates to **[exposure properties](/reference/exposure-properties)**: `config`, `label`, and `name` validation.

- **[Custom `node_color`](/reference/resource-configs/docs.md)** in `dbt-docs`. For the first time, you can control the colors displayed in dbt's DAG. Want bronze, silver, and gold layers? It's at your fingertips.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ See GitHub discussion [dbt-labs/dbt-core#5468](https://github.com/dbt-labs/dbt-c
## New and changed functionality

- **[Grants](/reference/resource-configs/grants)** are natively supported in `dbt-core` for the first time. That support extends to all standard materializations, and the most popular adapters. If you already use hooks to apply simple grants, we encourage you to use built-in `grants` to configure your models, seeds, and snapshots instead. This will enable you to [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) up your duplicated or boilerplate code.
- **[Metrics](/docs/build/metrics)** now support an `expression` type (metrics-on-metrics), as well as a `metric()` function to use when referencing metrics from within models, macros, or `expression`-type metrics. For more information on how to use expression metrics, check out the [**`dbt_metrics` package**](https://github.com/dbt-labs/dbt_metrics)
- **[Metrics](/docs/build/build-metrics-intro)** now support an `expression` type (metrics-on-metrics), as well as a `metric()` function to use when referencing metrics from within models, macros, or `expression`-type metrics. For more information on how to use expression metrics, check out the [**`dbt_metrics` package**](https://github.com/dbt-labs/dbt_metrics)
- **[dbt-Jinja functions](/reference/dbt-jinja-functions)** now include the [`itertools` Python module](/reference/dbt-jinja-functions/modules#itertools), as well as the [set](/reference/dbt-jinja-functions/set) and [zip](/reference/dbt-jinja-functions/zip) functions.
- **[Node selection](/reference/node-selection/syntax)** includes a [file selection method](/reference/node-selection/methods#the-file-method) (`-s model.sql`), and [yaml selector](/reference/node-selection/yaml-selectors) inheritance.
- **[Global configs](/reference/global-configs/about-global-configs)** now include CLI flag and environment variable settings for [`target-path`](/reference/project-configs/target-path) and [`log-path`](/reference/project-configs/log-path), which can be used to override the values set in `dbt_project.yml`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Several under-the-hood changes from past minor versions, tagged with deprecation

## New features and changed documentation

- Add [metrics](/docs/build/metrics), a new node type
- Add [metrics](/docs/build/build-metrics-intro), a new node type
- [Generic tests](/best-practices/writing-custom-generic-tests) can be defined in `tests/generic` (new), in addition to `macros/` (as before)
- [Parsing](/reference/parsing): partial parsing and static parsing have been turned on by default.
- [Global configs](/reference/global-configs/about-global-configs) have been standardized. Related updates to [global CLI flags](/reference/global-cli-flags) and [`profiles.yml`](/docs/core/connect-data-platform/profiles.yml).
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "Deprecation: dbt Metrics and the legacy dbt Semantic Layer is now deprecated"
description: "December 2023: For users on dbt v1.5 and lower, dbt Metrics and the legacy dbt Semantic Layer has been deprecated. Use the migration guide to migrate to and access the latest dbt Semantic Layer. "
sidebar_label: "Deprecation: dbt Metrics and Legacy dbt Semantic Layer"
sidebar_position: 09
date: 2023-12-15
---

dbt Labs has deprecated dbt Metrics and the legacy dbt Semantic Layer, both supported on dbt version 1.5 or lower. These changes will be in effect on _December 15th, 2023_.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

This deprecation means dbt Metrics and the legacy Semantic Layer are no longer supported. We also removed the feature from the dbt Cloud user interface and documentation site.

### Why this change?

The [re-released dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl), powered by MetricFlow, offers enhanced flexibility, performance, and user experience, marking a significant advancement for the dbt community.

### Key changes and impact

- **Deprecation date** &mdash; The legacy Semantic Layer and dbt Metrics will be officially deprecated on December 15th, 2023.
- **Replacement** &mdash; [MetricFlow](/docs/build/build-metrics-intro) replaces dbt Metrics for defining semantic logic. The `dbt_metrics` package will no longer be supported post-deprecation.
- **New feature** &mdash; Exports replaces the materializations functionality and will be available in dbt Cloud in December or January.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

### Breaking changes and recommendations

- For users on dbt version 1.6 and lower with dbt Metrics and Snowflake proxy:
- **Impact**: Post-deprecation, queries using the proxy _will not_ run.
- **Action required:** _Immediate_ migration is necessary. Refer to the [dbt Semantic Layer migration guide](/guides/sl-migration?step=1)

- For users on dbt version 1.6 and lower using dbt Metrics without Snowflake proxy:
- **Impact**: No immediate disruption, but the package will not receive updates or support after deprecation
- **Recommendation**: Plan migration to the re-released Semantic Layer for compatibility with dbt version 1.6 and higher.

### Engage and support

- Feedback and community support &mdash; Engage and share feedback with the dbt Labs team and dbt Community slack using channels like [#dbt-cloud-semantic-layer](https://getdbt.slack.com/archives/C046L0VTVR6) and [#dbt-metricflow](https://getdbt.slack.com/archives/C02CCBBBR1D). Or reach out to your dbt Cloud account representative.
- Resources for upgrading &mdash;Refer to some additional info and resources to help you upgrade your dbt version:
- [Upgrade version in dbt Cloud](/docs/dbt-versions/upgrade-core-in-cloud)
- [Version migration guides](/docs/dbt-versions/core-upgrade)
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,13 @@ meta:
api_name: dbt Semantic Layer APIs
---

<VersionBlock firstVersion="1.6">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know exactly how this works, but wouldn't removing this make it so our available integrations to the new SL appear before version 1.6 of the docs? We still don't support version < 1.6 of dbt Core, so I think we still want to keep this absent when users are browsing the version of docs that are < 1.6.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @DevonFulcher ! that's definitely a great point and i intentionally removed it because the prerequisites do let users know they should be on dbt v1.6 and higher to use the SL or metricflow. also, is it a bad thing to have the revamped SL presented to users who are not on dbt v1.6 or higher? it might be a helpful motivator to upgrade their version?

i do think the initial PR didn't include a callout letting ppl know about the deprecation but i just added it so that users know the legacy SL and dbt metrics was removed and if they'd like to use the SL or metricflow, they can upgrade if they choose -- what do you think about it?

Screenshot 2023-12-12 at 07 44 45

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ya, that sounds great! Thank you!

<VersionBlock lastVersion="1.5">

import DeprecationNotice from '/snippets/_sl-deprecation-notice.md';

<DeprecationNotice />

</VersionBlock>

There are a number of data applications that seamlessly integrate with the dbt Semantic Layer, powered by MetricFlow, from business intelligence tools to notebooks, spreadsheets, data catalogs, and more. These integrations allow you to query and unlock valuable insights from your data ecosystem.

Expand All @@ -34,25 +39,3 @@ import AvailIntegrations from '/snippets/_sl-partner-links.md';
- [dbt Semantic Layer API query syntax](/docs/dbt-cloud-apis/sl-jdbc#querying-the-api-for-metric-metadata)
- [Hex dbt Semantic Layer cells](https://learn.hex.tech/docs/logic-cell-types/transform-cells/dbt-metrics-cells) to set up SQL cells in Hex.
- [Resolve 'Failed APN'](/faqs/Troubleshooting/sl-alpn-error) error when connecting to the dbt Semantic Layer.

</VersionBlock>

<VersionBlock lastVersion="1.5">

import DeprecationNotice from '/snippets/_sl-deprecation-notice.md';

<DeprecationNotice />

A wide variety of data applications across the modern data stack natively integrate with the dbt Semantic Layer and dbt metrics &mdash; from Business Intelligence tools to notebooks, data catalogs, and more.

The dbt Semantic Layer integrations are capable of querying dbt metrics, importing definitions, surfacing the underlying data in partner tools, and leveraging the dbt Server.

For information on the partner integrations, their documentation, and more &mdash; refer to the [dbt Semantic Layer integrations](https://www.getdbt.com/product/semantic-layer-integrations) page.

<Lightbox src="/img/docs/dbt-cloud/semantic-layer/sl_architecture.png" width="75%" title="The universal dbt Semantic Layer connecting to integration tools."/>

## Related docs

- [About the dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl)

</VersionBlock>
Loading
Loading