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.

Sign up for GitHub

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

Add run-operation command to run_results.json #3472

Merged
merged 9 commits into from
Jun 7, 2023
Merged

Add run-operation command to run_results.json #3472

Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
62635aa
Add `run-operation` command to `run_results.json`
aranke Jun 5, 2023
737c0b6
Add version blocks
aranke Jun 5, 2023
7c41afd
Move version block inline
aranke Jun 5, 2023
e041a6e
Unindent `VersionBlock`
aranke Jun 5, 2023
a40dc83
Try multi-line
aranke Jun 5, 2023
c870b4a
Merge branch 'current' into run_results_run_operation
mirnawong1 Jun 6, 2023
b649000
Update run-results-json.md
mirnawong1 Jun 7, 2023
0c392a0
Merge branch 'current' into run_results_run_operation
mirnawong1 Jun 7, 2023
b6af189
fix versioning
mirnawong1 Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion website/docs/reference/artifacts/run-results-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,28 @@ sidebar_label: "Run results"

**Current schema**: [`v4`](https://schemas.getdbt.com/dbt/run-results/v4/index.html)

**Produced by:** [`build`](/reference/commands/build) [`compile`](/reference/commands/compile) [`docs generate`](/reference/commands/cmd-docs) [`seed`](/reference/commands/seed) [`snapshot`](/reference/commands/snapshot) [`test`](/reference/commands/test) [`run`](/reference/commands/run)
<VersionBlock lastVersion="1.6">
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hey @aranke I wonder if this should be 1.5? Otherwise both blocks might show up?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also, I wonder if you could version only the new command for 1.6 like this (which might make the code easier to read):

**Produced by:**
  [`build`](/reference/commands/build)
  [`compile`](/reference/commands/compile)
  [`docs generate`](/reference/commands/cmd-docs)
  [`run`](/reference/commands/run)
 <VersionBlock firstVersion="1.6"> [`run-operation`](/reference/commands/run-operation)</VersionBlock>
  [`seed`](/reference/commands/seed)
  [`snapshot`](/reference/commands/snapshot)
  [`test`](/reference/commands/test)

Copy link
Member Author

Choose a reason for hiding this comment

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

Done, thanks!

Copy link
Contributor

@mirnawong1 mirnawong1 Jun 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

going to fix this as it's looking like this and snapshots, test, seeds don't appear correctly in v1.5 and lower.

Screenshot 2023-06-07 at 12 02 33

**Produced by:**
[`build`](/reference/commands/build)
[`compile`](/reference/commands/compile)
[`docs generate`](/reference/commands/cmd-docs)
[`run`](/reference/commands/run)
[`seed`](/reference/commands/seed)
[`snapshot`](/reference/commands/snapshot)
[`test`](/reference/commands/test)
</VersionBlock>

<VersionBlock firstVersion="1.6">
**Produced by:**
[`build`](/reference/commands/build)
[`compile`](/reference/commands/compile)
[`docs generate`](/reference/commands/cmd-docs)
[`run`](/reference/commands/run)
[`run-operation`](/reference/commands/run-operation)
[`seed`](/reference/commands/seed)
[`snapshot`](/reference/commands/snapshot)
[`test`](/reference/commands/test)
</VersionBlock>

This file contains information about a completed invocation of dbt, including timing and status info for each node (model, test, etc) that was executed. In aggregate, many `run_results.json` can be combined to calculate average model runtime, test failure rates, the number of record changes captured by snapshots, etc.

Expand Down