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

Make config names all use underscores #9235

Open
1 task done
emmyoop opened this issue Dec 6, 2023 · 2 comments
Open
1 task done

Make config names all use underscores #9235

emmyoop opened this issue Dec 6, 2023 · 2 comments
Labels
user docs [docs.getdbt.com] Needs better documentation

Comments

@emmyoop
Copy link
Member

emmyoop commented Dec 6, 2023

Housekeeping

  • I am a maintainer of dbt-core

Short description

dbt is not consistent with config names.

dbt_project.yml not dbt_project.yml match
pre-hook pre_hook
post-hook post_hook
semantic-models semantic_models
full_refresh full_refresh
persist_docs persist_docs

This may not be a complete list. Part of this ticket will be determining the list.

Acceptance criteria

You can consistently use the underscore version of configs no matter what file you're in. The dash version is still allowed but throws a deprecation warning.

Impact to Other Teams

Possibly adapters? Unlikely. Cloud config may be affected as well?

Will backports be required?

Nope!

Context

This is a papercut for users to have to know what format to enter a config name based on what file they are working in.

@emmyoop emmyoop added the user docs [docs.getdbt.com] Needs better documentation label Dec 6, 2023
@github-actions github-actions bot changed the title [<project>] <title> [CT-3466] [<project>] <title> Dec 6, 2023
@emmyoop emmyoop changed the title [CT-3466] [<project>] <title> Make config names all use underscores Dec 6, 2023
@graciegoheen
Copy link
Contributor

@jtcohen6 do you have any historical insight as to why there are inconsistencies here?

@gshank
Copy link
Contributor

gshank commented Dec 6, 2023

Right now we use mashumaro aliases to enforce conversion from dashes to underscores when serializing and deserializing. We might need to have special pre and post serialization methods to normalize to underscores.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
user docs [docs.getdbt.com] Needs better documentation
Projects
None yet
Development

No branches or pull requests

3 participants