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

dbt-star #304

Merged
merged 4 commits into from
Jan 24, 2024
Merged

dbt-star #304

merged 4 commits into from
Jan 24, 2024

Conversation

AxelThevenot
Copy link
Contributor

Description

A dbt package to SELECT * without SELECT *!

🎯 Selective Column Inclusion:
Generate exhaustive SELECT expressions for models and sources removing your old SELECT * from your queries, improving readability when compiled.

🚫 Configurable:
Use the optional except argument to tailor the output by excluding specific columns.
Enhance query clarity with the alias argument, especially useful for multiple model instances.

🌐 Cross-Platform Compatibility: Supports all data platforms, ensuring flexibility in your data stack.

Link to your package's repository: https://github.com/AxelThevenot/dbt-star

Checklist

This checklist is a cut down version of the best practices that we have identified as the package hub has grown. Although meeting these checklist items is not a prerequisite to being added to the Hub, we have found that packages which don't conform provide a worse user experience.

First run experience

  • The package includes a README which explains how to get started with the package and customise its behaviour
  • The README indicates which data warehouses/platforms are expected to work with this package

Customisability

  • The package uses ref or source, instead of hard-coding table references.

Packages for data transformation (delete if not relevant):

  • provide a mechanism (such as variables) to customise the location of source tables.
  • do not assume database/schema names in sources.

Dependencies

Dependencies on dbt Core

  • The package has set a supported require-dbt-version range in dbt_project.yml. Example: A package which depends on functionality added in dbt Core 1.2 should set its require-dbt-version property to [">=1.2.0", "<2.0.0"].

Dependencies on other packages defined in packages.yml:

  • Dependencies are imported from the dbt Package Hub when available, as opposed to a git installation.
  • Dependencies contain the widest possible range of supported versions, to minimise issues in dependency resolution.
  • In particular, dependencies are not pinned to a patch version unless there is a known incompatibility.

Interoperability

  • The package does not override dbt Core behaviour in such a way as to impact other dbt resources (models, tests, etc) not provided by the package.
  • The package uses the cross-database macros built into dbt Core where available, such as {{ dbt.except() }} and {{ dbt.type_string() }}.
  • The package disambiguates its resource names to avoid clashes with nodes that are likely to already exist in a project. For example, packages should not provide a model simply called users.

Versioning

  • (Required): The package's git tags validates against the regex defined in version.py
  • The package's version follows the guidance of Semantic Versioning 2.0.0. (Note in particular the recommendation for production-ready packages to be version 1.0.0 or above)

Copy link
Contributor

@joellabes joellabes left a comment

Choose a reason for hiding this comment

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

Thanks @AxelThevenot! Do you know about dbt_utils.star?

It does a similar thing, but instead of reading from the yaml files it reads the columns from the information schema directly.

@joellabes joellabes merged commit 1fb1c6b into dbt-labs:main Jan 24, 2024
3 checks passed
@AxelThevenot
Copy link
Contributor Author

Yes I saw it but I highly prefer a more declarative approach 🙏
And it forces having a good documentation 😇

Thank you for merging it

And I probably will re-inspire myself of this package to add some new optional arguments

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

Successfully merging this pull request may close these issues.

2 participants