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

Column API: list all properties available #3198

Closed
1 task done
dbeatty10 opened this issue Apr 17, 2023 · 0 comments · Fixed by #6545
Closed
1 task done

Column API: list all properties available #3198

dbeatty10 opened this issue Apr 17, 2023 · 0 comments · Fixed by #6545
Assignees
Labels
content Improvements or additions to content Hackathon improvement Use this when an area of the docs needs improvement as it's currently unclear size: x-small This change will take under 3 hours to fix.

Comments

@dbeatty10
Copy link
Contributor

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

https://docs.getdbt.com/reference/dbt-classes#column-api

What part(s) of the page would you like to see updated?

The docs should include all the methods decorated with @property as well as the explicit properties listed here.

Decorated properties:

  • name
  • quoted
  • data_type

Explicit properties:

  • column
  • dtype
  • char_size
  • numeric_precision
  • numeric_scale

The unified list is:

  • column: Returns the name of the column
  • name: Returns the name of the column (alias for column)
  • quoted: Returns the name of the column wrapped in quotes
  • data_type: Returns the data type of the column (with size/precision/scale included)
  • dtype: Returns the data type of the column (without any size/precision/scale included)
  • char_size: Returns the maximum size for character varying columns
  • numeric_precision: Returns the maximum precision for fixed decimal columns
  • numeric_scale: Returns the maximum scale for fixed decimal columns

Additional information

Instigating context: in discussing options within dbt-labs/dbt-codegen#122, there weren't sufficient docs to describe all the options and their differences.

@dbeatty10 dbeatty10 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Apr 17, 2023
@runleonarun runleonarun added Hackathon priority: high Technical inaccuracy, missing/incorrect information, or broken links. Negatively affects workflows size: x-small This change will take under 3 hours to fix. labels Aug 17, 2023
@runleonarun runleonarun removed the priority: high Technical inaccuracy, missing/incorrect information, or broken links. Negatively affects workflows label Jan 2, 2024
@mirnawong1 mirnawong1 self-assigned this Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content Hackathon improvement Use this when an area of the docs needs improvement as it's currently unclear size: x-small This change will take under 3 hours to fix.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants