dbt retry command #3556

matthewshaver · 2023-06-16T18:30:10Z

resolves #3422

What are you changing in this pull request and why?

Documenting the dbt retry command new in v1.6

Checklist

Uncomment if you're publishing docs for a prerelease version of dbt (delete if not applicable):

Add versioning components, as described in Versioning Docs
Add a note to the prerelease version Migration Guide
Review the Content style guide and About versioning so my content adheres to these guidelines.
Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

Adding new pages (delete if not applicable):

Add page to website/sidebars.js
Provide a unique filename for the new page

netlify · 2023-06-16T18:30:16Z

✅ Deploy Preview for docs-getdbt-com ready!

Name	Link
🔨 Latest commit	`414bbe2`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-getdbt-com/deploys/6499fb338969ae00082cb64b
😎 Deploy Preview	https://deploy-preview-3556--docs-getdbt-com.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

runleonarun

Hey @matthewshaver just a few questions/suggestions!

runleonarun · 2023-06-16T19:37:23Z

website/docs/reference/commands/retry.md

+id: "retry"
+---
+
+`dbt retry` re-executes the last `dbt` command from the node point of failure. If the previously executed `dbt` command was successful, `retry` will finish as a no op. 


What is a "no op?" If it stands for something we might want to write it out. Or ink to docs about it?

I spelled it out since it wasn't apparent to me, either.

Sorry, no-op is no-operation (i.e., do nothing).

https://en.wikipedia.org/wiki/NOP_(code)

runleonarun · 2023-06-16T19:46:37Z

website/docs/reference/commands/retry.md

+- [`run`](/reference/commands/run)
+- [`run-operation`](/reference/commands/run-operation)
+
+`dbt retry` will execute from the node failures recorded in the run_results.json. Executing `dbt retry` without correcting the previous failures will garner idempotent results.


Might be a good place to add a glossary entry for idempotent. https://docs.getdbt.com/terms/idempotent which I think would be:
<Term id="idempotent" />

dbt retry will execute from the node failures recorded in the run_results.json

What is the advice here? Are we asking people to make sure they check run_resuts.json and fix any failures?

They're not expected to do anything with the file itself, we just wanted to give a behind the curtains look at how the feature works. It references that json to determine where to start the retry. Does adding the parenthesis help?

@runleonarun Users should not edit run_results.json themselves, but its output is used by retry.

website/docs/reference/commands/retry.md

runleonarun

@matthewshaver This is definitely more helpful! I have a couple non-blocking questions that came up when I was reading this page. Please don't let these hold you up if you need to ship, but they might be helpful to customers.

runleonarun · 2023-06-21T16:55:55Z

website/docs/reference/commands/retry.md

+id: "retry"
+---
+
+`dbt retry` re-executes the last `dbt` command from the node point of failure. If the previously executed `dbt` command was successful, `retry` will finish as `no operation`. 


Does this mean if you run a dbt retry when the previous dbt command succeeded, then nothing happens?

Yes, correct.
It'll show a message like “no nodes selected”.

runleonarun · 2023-06-21T16:56:20Z

website/docs/reference/commands/retry.md

+- [`run`](/reference/commands/run)
+- [`run-operation`](/reference/commands/run-operation)
+
+`dbt retry` references **run_results.json** to determine where to start. Executing `dbt retry` without correcting the previous failures will garner <Term id="idempotent" /> results.


This is much clearer, thank you!

runleonarun · 2023-06-21T16:58:44Z

website/docs/reference/commands/retry.md

+
+`dbt retry` references **run_results.json** to determine where to start. Executing `dbt retry` without correcting the previous failures will garner <Term id="idempotent" /> results.
+
+`dbt retry` reuses the selectors from the previously executed command.


Should we link to the Methods page or YAML selectors page to provide more info in case they need it?

aranke

Can we add an example to the docs? Something like:

$ dbt build
...
ERROR node_a

$ dbt retry
ERROR node_a

# Fix node_a

$ dbt retry
PASS node_a

$ dbt retry
Nothing to do.

aranke · 2023-06-21T21:49:30Z

website/docs/reference/commands/retry.md

+id: "retry"
+---
+
+`dbt retry` re-executes the last `dbt` command from the node point of failure. If the previously executed `dbt` command was successful, `retry` will finish as `no operation`. 


Yes, correct.
It'll show a message like “no nodes selected”.

aranke · 2023-06-21T21:50:32Z

website/docs/reference/commands/retry.md

+- [`run`](/reference/commands/run)
+- [`run-operation`](/reference/commands/run-operation)
+
+`dbt retry` references **run_results.json** to determine where to start. Executing `dbt retry` without correcting the previous failures will garner <Term id="idempotent" /> results.


Probably worth mentioning here that it looks in the target/ directory by default, but a different directory can be passed in with the --state flag.

website/docs/reference/commands/retry.md

runleonarun

This looks great! Let's follow up later with a more detailed example from @aranke as suggested here.

dbt retry command

823d543

matthewshaver requested a review from a team as a code owner June 16, 2023 18:30

matthewshaver mentioned this pull request Jun 16, 2023

New command dbt retry #3546

Closed

6 tasks

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 labels Jun 16, 2023

runleonarun reviewed Jun 16, 2023

View reviewed changes

matthewshaver requested a review from runleonarun June 16, 2023 20:05

matthewshaver commented Jun 16, 2023

View reviewed changes

website/docs/reference/commands/retry.md Outdated Show resolved Hide resolved

Update website/docs/reference/commands/retry.md

e016bea

matthewshaver commented Jun 16, 2023

View reviewed changes

website/docs/reference/commands/retry.md Outdated Show resolved Hide resolved

Update website/docs/reference/commands/retry.md

8cb066e

matthewshaver commented Jun 16, 2023

View reviewed changes

website/docs/reference/commands/retry.md Outdated Show resolved Hide resolved

matthewshaver added 2 commits June 16, 2023 16:16

Update website/docs/reference/commands/retry.md

08450b8

Merge branch 'current' into dbt-retry

743d47d

matthewshaver commented Jun 21, 2023

View reviewed changes

website/docs/reference/commands/retry.md Outdated Show resolved Hide resolved

Update website/docs/reference/commands/retry.md

b25fa4a

aranke self-requested a review June 21, 2023 16:23

runleonarun reviewed Jun 21, 2023

View reviewed changes

matthewshaver requested a review from runleonarun June 21, 2023 17:12

aranke reviewed Jun 21, 2023

View reviewed changes

matthewshaver requested a review from aranke June 26, 2023 19:57

matthewshaver commented Jun 26, 2023

View reviewed changes

website/docs/reference/commands/retry.md Outdated Show resolved Hide resolved

Update website/docs/reference/commands/retry.md

76d2493

matthewshaver commented Jun 26, 2023

View reviewed changes

website/docs/reference/commands/retry.md Outdated Show resolved Hide resolved

Update website/docs/reference/commands/retry.md

c8b789e

runleonarun approved these changes Jun 26, 2023

View reviewed changes

Merge branch 'current' into dbt-retry

414bbe2

matthewshaver merged commit 574cd3d into current Jun 26, 2023

matthewshaver deleted the dbt-retry branch June 26, 2023 21:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dbt retry command #3556

dbt retry command #3556

matthewshaver commented Jun 16, 2023 •

edited by jtcohen6

Loading

netlify bot commented Jun 16, 2023 •

edited

Loading

runleonarun left a comment

runleonarun Jun 16, 2023

matthewshaver Jun 16, 2023

aranke Jun 21, 2023

runleonarun Jun 16, 2023

runleonarun Jun 16, 2023

matthewshaver Jun 16, 2023

aranke Jun 21, 2023

runleonarun left a comment

runleonarun Jun 21, 2023

aranke Jun 21, 2023

runleonarun Jun 21, 2023

runleonarun Jun 21, 2023

aranke left a comment

aranke Jun 21, 2023

aranke Jun 21, 2023

runleonarun left a comment


		`dbt retry` references run_results.json to determine where to start. Executing `dbt retry` without correcting the previous failures will garner <Term id="idempotent" /> results.

		`dbt retry` reuses the selectors from the previously executed command.

dbt retry command #3556

dbt retry command #3556

Conversation

matthewshaver commented Jun 16, 2023 • edited by jtcohen6 Loading

What are you changing in this pull request and why?

Checklist

netlify bot commented Jun 16, 2023 • edited Loading

✅ Deploy Preview for docs-getdbt-com ready!

runleonarun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

runleonarun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aranke left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

runleonarun left a comment

Choose a reason for hiding this comment

matthewshaver commented Jun 16, 2023 •

edited by jtcohen6

Loading

netlify bot commented Jun 16, 2023 •

edited

Loading