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

Add exposure naming convention to style guide #71

Open
epapineau opened this issue Nov 17, 2022 · 6 comments
Open

Add exposure naming convention to style guide #71

epapineau opened this issue Nov 17, 2022 · 6 comments

Comments

@epapineau
Copy link
Contributor

There is no opinion put forth in the dbt style guide about how to name exposures.

@ian-fahey
Copy link
Contributor

Some initial thoughts, which may be obvious, but I think stating the obvious has value.

  • It doesn't need to have exposure in the name - exposures appear differently in graphs
  • We should design for the functionality of exposures. I've only ever used them visually in the docs graph. What are other use cases at present?

@epapineau
Copy link
Contributor Author

@ian-fahey-dbt Not sure I understand your first point. To your second point, my biggest 😍 for exposures is the ability to run dbt run -s +exposure:exposure_name. Need to instantly refresh everything for a specific dashboard? Done.

@ian-fahey
Copy link
Contributor

@ian-fahey-dbt Not sure I understand your first point. To your second point, my biggest 😍 for exposures is the ability to run dbt run -s +exposure:exposure_name. Need to instantly refresh everything for a specific dashboard? Done.

I think I was just questioning whether exposure_ in the name was necessary. Is there a navigation reason this is best?

@epapineau
Copy link
Contributor Author

@ian-fahey-dbt what convention did we land from the New Year, New Us effort?

@ian-fahey
Copy link
Contributor

I believe we did keep exposure in it, but also a few other conventions shown here

@lbenezra-FA
Copy link

just like the rest of our model conventions, I would name an exposure with a prefix, like exp__, and then i would name it the name of the report / dashboard it represents. That way, when setting up jobs, and using that functionality that @epapineau mentioned, it's really clear what is building. Also, if you were to provide your BI team with the docs, they'd be able to know what's relevant to their dashboard without needing to ask.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants