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 debug --connection flag #3731

Merged
merged 11 commits into from
Jul 15, 2023
Merged

dbt debug --connection flag #3731

merged 11 commits into from
Jul 15, 2023

Conversation

mirnawong1
Copy link
Contributor

Adds dbt debug --connection flag to test connection only in 1.6.

Resolves #3725

Not sure if i did this correctly @jtcohen6

@mirnawong1 mirnawong1 requested a review from a team as a code owner July 13, 2023 15:18
@netlify
Copy link

netlify bot commented Jul 13, 2023

Deploy Preview for docs-getdbt-com ready!

Name Link
🔨 Latest commit 883a14c
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/64b1e2afb714c20008133b3a
😎 Deploy Preview https://deploy-preview-3731--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 configuration.

@github-actions github-actions bot added the content Improvements or additions to content label Jul 13, 2023
@github-actions github-actions bot added size: small This change will take 1 to 2 days to address Docs team Authored by the Docs team @dbt Labs labels Jul 13, 2023
@mirnawong1 mirnawong1 mentioned this pull request Jul 14, 2023
1 task

To test the data platform connection _only_, add the `--connection` flag at the end of the command. For example, `dbt debug --connection` will only test the connection to the data platform and skip the other checks `dbt debug` looks for.

*Note: Not to be confused with [debug-level logging](/reference/global-configs/about-global-configs#debug-level-logging) via the `--debug` option which increases verbosity.
Copy link
Contributor

Choose a reason for hiding this comment

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

This part is harder to understand when it's further down like this:

https://deploy-preview-3731--docs-getdbt-com.netlify.app/reference/commands/debug?version=1.6

image

I wonder if it could be moved somewhere else or updated in some other way?

Copy link
Contributor

Choose a reason for hiding this comment

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

I committed some attempts to separate out the examples from the main description.

Sorry if I butchered your PR @mirnawong1

Copy link
Contributor Author

@mirnawong1 mirnawong1 Jul 15, 2023

Choose a reason for hiding this comment

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

I LOVE this! So much easier to understand and thank you so much for editing it @dbeatty10 ! I didn't realize there was more than two options so this looks perfect 🤩

@dbeatty10
Copy link
Contributor

@mirnawong1 I committed an attempt at splitting the content into three sections (which made the versioning a little easier) -- feel free to revert it if you want:

https://deploy-preview-3731--docs-getdbt-com.netlify.app/reference/commands/debug?version=1.6

image

Copy link
Contributor

@nghi-ly nghi-ly left a comment

Choose a reason for hiding this comment

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

we're not using Changelog anymore

website/docs/reference/commands/debug.md Outdated Show resolved Hide resolved
website/docs/reference/commands/debug.md Outdated Show resolved Hide resolved
website/docs/reference/commands/debug.md Outdated Show resolved Hide resolved
Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com>
@dbeatty10 dbeatty10 merged commit e3d6c47 into current Jul 15, 2023
@dbeatty10 dbeatty10 deleted the mwong-dbt-debug branch July 15, 2023 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto update 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.

dbt debug --connection
3 participants