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

Interactive Compile #3179

Merged
merged 5 commits into from
Apr 13, 2023
Merged

Interactive Compile #3179

merged 5 commits into from
Apr 13, 2023

Conversation

matthewshaver
Copy link
Contributor

@matthewshaver matthewshaver commented Apr 12, 2023

What are you changing in this pull request and why?

Updating the compile documents to reflect enhancements made in dbt Core v1.5

Checklist

resolves #2994

@matthewshaver matthewshaver requested a review from a team as a code owner April 12, 2023 20:03
@matthewshaver matthewshaver requested a review from aranke April 12, 2023 20:03
@netlify
Copy link

netlify bot commented Apr 12, 2023

Deploy Preview for docs-getdbt-com ready!

Name Link
🔨 Latest commit 61f7ffa
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/6438287d16c998000863e17d
😎 Deploy Preview https://deploy-preview-3179--docs-getdbt-com.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions github-actions bot added content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: small This change will take 1 to 2 days to address and removed Docs team Authored by the Docs team @dbt Labs labels Apr 12, 2023
It is _not_ a pre-requisite of `dbt run`.
<VersionBlock firstVersion="1.5">

Starting in dbt v1.5, `compile` becomes interactive in the CLI using the selection syntaxt `--select` or `--inline` to target specic models or Jinja references, respectively. This will return the compiled SQL in the CLI (in addition to the `target/` directory).
Copy link
Member

@aranke aranke Apr 12, 2023

Choose a reason for hiding this comment

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

Nit: syntaxtsyntax
specicspecific
return the compiled SQL in the CLIdisplay the compiled SQL inline in the terminal.

@@ -11,4 +11,22 @@ The `compile` command is useful for:
2. Manually running compiled SQL. While debugging a model or schema test, it's often useful to execute the underlying `select` statement to find the source of the bug.
3. Compiling `analysis` files. Read more about analysis files [here](/docs/build/analyses).

It is _not_ a pre-requisite of `dbt run`.
<VersionBlock firstVersion="1.5">
Copy link
Member

Choose a reason for hiding this comment

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

What's the convention around what to put in the version block? I'd assume it was only highlighting that this is net new behavior, and documenting below outside the version block.

Copy link
Contributor Author

@matthewshaver matthewshaver Apr 12, 2023

Choose a reason for hiding this comment

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

We deprecated the use of changelogs in favor of version blocks to help reign in the amount of information displayed on the screen. Since we version the docs themselves, this makes a generally more pleasing UX, and gives us a nice way to dynamically change the content (where appropriate) for different product versions.

@github-actions github-actions bot added the Docs team Authored by the Docs team @dbt Labs label Apr 12, 2023
aranke
aranke previously approved these changes Apr 12, 2023
Copy link
Member

@aranke aranke left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@aranke aranke left a comment

Choose a reason for hiding this comment

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

LGTM!

@matthewshaver matthewshaver enabled auto-merge April 13, 2023 16:06
@matthewshaver matthewshaver merged commit 2e9605e into current Apr 13, 2023
@matthewshaver matthewshaver deleted the interactive-compile branch April 13, 2023 16:10
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 Docs team Authored by the Docs team @dbt Labs size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document interactive compile
2 participants