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

[CT-2115] In-repo documentation: glossary of terms #6970

Open
Tracked by #6706
jtcohen6 opened this issue Feb 14, 2023 · 0 comments
Open
Tracked by #6706

[CT-2115] In-repo documentation: glossary of terms #6970

jtcohen6 opened this issue Feb 14, 2023 · 0 comments
Labels
enhancement New feature or request python_api Issues related to dbtRunner Python entry point Team:Adapters Issues designated for the adapter area of the code

Comments

@jtcohen6
Copy link
Contributor

jtcohen6 commented Feb 14, 2023

These words all have specific meanings, whether referring to an internal process or object of importance to dbt-core:

  • parsing
    • rendering, contexts, macro_manifest
    • which contexts are available where
    • "late-rendering" of certain configs (pre/post-hook)
    • node parsing / construction
    • resolution (references)
  • compilation
    • "introspective" queries
  • execution / materialization
    • "mutative" queries
  • manifest
    • files / partial parsing
  • graph
  • node (manifest object)
  • catalog
  • results
  • adapter
  • relation
  • cache

Let's develop a single place where we maintain up-to-date definitions of all these terms. These are all API objects, so I think this codebase is the right place to maintain the glossary (versus end-user documentation at docs.getdbt.com). The target audience is dbt-core developers, contributors, and anyone curious enough to wade into the technical details. Not relevant to the vast majority of end users. Other potential names for this: "field notes," "practitioner's guide," ...

Potential inspiration:

@github-actions github-actions bot changed the title In-repo documentation: glossary of terms [CT-2115] In-repo documentation: glossary of terms Feb 14, 2023
@jtcohen6 jtcohen6 added python_api Issues related to dbtRunner Python entry point Team:Execution Team:Adapters Issues designated for the adapter area of the code labels Feb 14, 2023
@mikealfare mikealfare added the enhancement New feature or request label Feb 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request python_api Issues related to dbtRunner Python entry point Team:Adapters Issues designated for the adapter area of the code
Projects
None yet
Development

No branches or pull requests

2 participants