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.

Sign up for GitHub

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

Jump to bottom

add guidance to using underscores or dots for dbt model naming #4750

Merged
merged 16 commits into from
Jan 25, 2024
Merged

add guidance to using underscores or dots for dbt model naming #4750

merged 16 commits into from
Jan 25, 2024

Conversation

mirnawong1
Copy link
Contributor

@mirnawong1 mirnawong1 commented Jan 15, 2024 •
edited
Loading

this pr adds explicit guidance on how to name dbt models. it adds :

  • we recommend using underscores and not dots
  • dots are supported, however come with complexity.
  • adds guidance to models doc, style doc, and links to style doc.

this stemmed from user confusion and slack thread

@mirnawong1 mirnawong1 requested a review from a team as a code owner January 15, 2024 11:31
@vercel Vercel
Copy link

vercel bot commented Jan 15, 2024 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 25, 2024 10:23am

@github-actions github-actions bot added content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address labels Jan 15, 2024
@mirnawong1 mirnawong1 changed the title add context add guidance to using underscores or dots for dbt model naming Jan 17, 2024
@sophiad96
Copy link
Contributor

@mirnawong1 I'm a bit worried about saying "dots are supported but with complexity". I'm happy to hear other perspectives on this, but I'm not sure we should state that dbt supports dots in model names if we don't suggest it as a best practice. Also, the customer that mentioned this was confused by the very fact that we didn't state that we don't officially support dots in model names in the documentation.

@mirnawong1
Copy link
Contributor Author

asked tech review here

sophiad96
sophiad96 approved these changes Jan 19, 2024
View reviewed changes
Copy link
Contributor

@sophiad96 sophiad96 left a comment

Choose a reason for hiding this comment

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

Looks great, thank you @mirnawong1 !!

@mirnawong1 mirnawong1 enabled auto-merge January 24, 2024 12:04
@mirnawong1
Copy link
Contributor Author

hey @joellabes ! thnks again for your. help and can you rereview please? folded in your comments 🙏

@mirnawong1
Copy link
Contributor Author

going to dismiss your review since i've addressed your feedback @joellabes - thank you again and will merge now!

https://docs-getdbt-90n3rdc79-dbt-labs.vercel.app/best-practices/how-we-style/1-how-we-style-our-dbt-models

@mirnawong1 mirnawong1 dismissed joellabes’s stale review January 25, 2024 10:19

addressed changes in pr

@mirnawong1 mirnawong1 merged commit 5dfbff3 into current Jan 25, 2024
7 checks passed
@mirnawong1 mirnawong1 deleted the mwong-model-names branch January 25, 2024 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joellabes joellabes joellabes left review comments

@sophiad96 sophiad96 sophiad96 approved these changes

Assignees
No one assigned
Labels
content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs January-2024 size: medium This change will take up to a week to address
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mirnawong1 @sophiad96 @joellabes @runleonarun