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

Clarify full_refresh=true behavior #6698

Open
1 task done
mirnawong1 opened this issue Dec 20, 2024 · 0 comments · May be fixed by #6700
Open
1 task done

Clarify full_refresh=true behavior #6698

mirnawong1 opened this issue Dec 20, 2024 · 0 comments · May be fixed by #6700
Labels
community Contributions from the dbt community content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear size: small This change will take 1 to 2 days to address

Comments

@mirnawong1
Copy link
Contributor

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

https://docs.getdbt.com/reference/resource-configs/full_refresh

What part(s) of the page would you like to see updated?

in the dbt community slack, a community member raised that the full_refresh doc doesn't explicitly detail what happens when you use the full_refresh:true config and what it does.

we should make it clearer that:
-full_refresh=true always refreshes,

  • clarify its not just a boolean string,
  • that it overrides the --full-refresh command flag.

User's feedback:

Hi! I've spotted this doc which I feel could be a little clearer: https://docs.getdbt.com/reference/resource-configs/full_refresh
The full_refresh config effectively acts like an override for the --full-refesh tag in the run command, so when you set to:
False: It prevents all full refreshes - this is clearly documented and we understood this behaviour
True: It always full refreshes - this was the unexpected behaviour
The way that the doc is currently written only focuses on the case where full_refresh=false, and only on careful reading or looking at the source code is it clear what will happen if full_refresh=true vs when it is omitted.
It would be very helpful to update this doc to explicitly state what happens when full_refresh=true and to make it more obvious that this config is not a boolean setting, but rather is an override for the --full-refesh tag.

Additional information

No response

@mirnawong1 mirnawong1 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear community Contributions from the dbt community size: small This change will take 1 to 2 days to address and removed community Contributions from the dbt community labels Dec 20, 2024
@mirnawong1 mirnawong1 linked a pull request Dec 20, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Contributions from the dbt community content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant