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

feat: add column comment #9230

Closed
wants to merge 5 commits into from

Conversation

yassun7010
Copy link

@yassun7010 yassun7010 commented Dec 6, 2023

resolves #9198

Problem

In migration to dbt, we use dbt-osmosis.
I would like to retrieve comment information for a column in schema.yml from an existing table, but the current dbt-core does not have column comment field.

Solution

Add optional comment field to Column.
In existing usage, the comment is simply set to None.

I have confirmed from the column class definition information for several database adapters that adding comment information does not break backward compatibility.

Checklist

  • I have read the contributing guide and understand what's expected of me
  • I have run this code in development and it appears to resolve the stated issue
  • This PR includes tests, or tests are not required/relevant for this PR
  • This PR has no interface changes (e.g. macros, cli, logs, json artifacts, config files, adapter interface, etc) or this PR has already received feedback and approval from Product or DX
  • This PR includes type annotations for new and modified functions

@yassun7010 yassun7010 requested a review from a team as a code owner December 6, 2023 02:53
Copy link

cla-bot bot commented Dec 6, 2023

Thanks for your pull request, and welcome to our community! We require contributors to sign our Contributor License Agreement and we don't seem to have your signature on file. Check out this article for more information on why we have a CLA.

In order for us to review and merge your code, please submit the Individual Contributor License Agreement form attached above above. If you have questions about the CLA, or if you believe you've received this message in error, please reach out through a comment on this PR.

CLA has not been signed by users: @yassun7010

Copy link
Contributor

github-actions bot commented Dec 6, 2023

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

@cla-bot cla-bot bot added the cla:yes label Dec 9, 2023
@yassun7010 yassun7010 requested a review from a team as a code owner December 9, 2023 15:57
@yassun7010 yassun7010 requested a review from aranke December 9, 2023 15:57
@yassun7010
Copy link
Author

yassun7010 commented Dec 17, 2023

@aranke

Is there anything I should do to promote this PR?

I look forward to your comments ;)

See also dbt-osmosis feature suggestions. z3z1ma/dbt-osmosis#120

@dbeatty10
Copy link
Contributor

Similarly to #9198 and dbt-labs/dbt-codegen#119, closing this per #9198 (comment).

@dbeatty10 dbeatty10 closed this Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CT-3446] [Feature] support comment in Column class
2 participants