How to update custom overrides of collect_freshness macro for 1.5
#3331
Assignees
Labels
content
Improvements or additions to content
dbt-core v1.5
Docs impact for the v1.5 release (Apr 2023)
improvement
Use this when an area of the docs needs improvement as it's currently unclear
Milestone
Comments
dbeatty10
added
content
2 tasks
6 tasks
2 tasks
nghi-ly
added a commit
that referenced
this issue
Jul 21, 2023
## What are you changing in this pull request and why? In v1.5, the collect_freshness macro returns a `response` object instead of just a `table` result. This affects anyone who's overriding this macro. Add this behavioral change to the 1.5 migration guide: https://docs.getdbt.com/guides/migration/versions/upgrading-to-v1.5 Resolves #3331 ## Checklist - [x] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) and [About versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) so my content adheres to these guidelines. - [ ] Needs review from product team
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Contributions
Link to the page on docs.getdbt.com requiring updates
https://docs.getdbt.com/guides/migration/versions/upgrading-to-v1.5
What part(s) of the page would you like to see updated?
There is a change in dbt 1.5 to
collect_freshness(changed in 17014bf).This requires overrides for this macro to have a different return statement for <1.4 and >=1.5.
<1.4:
{{ return(load_result('collect_freshness').table) }}>1.5:
{{ return(load_result('collect_freshness')) }}This can affect both dbt package maintainers and end-users that have an override of
collect_freshness.See dbt-labs/dbt-core#7489 (comment)
More discussion and detail here:
https://getdbt.slack.com/archives/C03SAHKKG2Z/p1683135194734689?thread_ts=1683127164.993329&cid=C03SAHKKG2Z
Additional information
Ideally, we can provide an example of logic that will switch the return statement depending upon the version of dbt that is being executed.
The text was updated successfully, but these errors were encountered: