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

Deprecated environment variables for state and defer #6784

Merged
merged 5 commits into from
Jan 17, 2025

Conversation

dbeatty10
Copy link
Contributor

@dbeatty10 dbeatty10 commented Jan 16, 2025

What are you changing in this pull request and why?

In dbt v1.5, we deprecated the original syntax for state and defer:

  • DBT_ARTIFACT_STATE_PATH -> DBT_STATE
  • DBT_DEFER_TO_STATE -> DBT_DEFER

We want to make that deprecation clear without reducing the readability of the current syntax, so:

  1. Moved the deprecation warning call out a little lower within the section
  2. Removed duplicated line items
  3. Replaced remaining reference to DBT_ARTIFACT_STATE_PATH with DBT_STATE

Noticed these while responding to dbt-labs/dbt-core#11216.

Checklist


🚀 Deployment available! Here are the direct links to the updated files:

@dbeatty10 dbeatty10 requested a review from a team as a code owner January 16, 2025 16:58
Copy link

vercel bot commented Jan 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Jan 17, 2025 9:30am

@github-actions github-actions bot added content Improvements or additions to content size: x-small This change will take under 3 hours to fix. labels Jan 16, 2025
@github-actions github-actions bot added size: small This change will take 1 to 2 days to address and removed size: x-small This change will take under 3 hours to fix. labels Jan 16, 2025
Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

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

hey @dbeatty10 ! great catches and thank you for opening this up to clarify it further!

@mirnawong1 mirnawong1 enabled auto-merge January 17, 2025 09:23
@@ -157,6 +148,12 @@ If both the flag and env var are provided, the flag takes precedence.
- The `--state` artifacts must be of schema versions that are compatible with the currently running dbt version.
- These are powerful, complex features. Read about [known caveats and limitations](/reference/node-selection/state-comparison-caveats) to state comparison.

:::warning Syntax deprecated

In [dbt v1.5](/docs/dbt-versions/core-upgrade/upgrading-to-v1.5#behavior-changes), we deprecated the original syntax for state (`DBT_ARTIFACT_STATE_PATH`) and defer (`DBT_DEFER_TO_STATE`). Although dbt supports backward compatibility with the old syntax, we will remove it in a future release that we have not yet determined.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[custom.Typos] Oops there's a typo -- did you really mean 'v1.5'?

@mirnawong1 mirnawong1 merged commit 1680a0c into current Jan 17, 2025
8 checks passed
@mirnawong1 mirnawong1 deleted the dbeatty10-patch-1 branch January 17, 2025 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants