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

New attributes in run_results.json #4974

Merged
merged 9 commits into from
Feb 29, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,14 @@ dbt Labs is committed to providing backward compatibility for all versions 1.x,

## New and changed features and functionality

Coming soon!
### Additional attributes in run_results.json

There are three attributes related to the `applied` state in the run_results.json (to complement unique_id):
runleonarun marked this conversation as resolved.
Show resolved Hide resolved
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved

- `compiled`: Boolean entry of the node compilation status (`False` after parsing, but `True` after compiling).
- `compiled_code`: rendered string of the code that was compiled (empty after parsing, but full string after compiling).
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
- `relation_name`: the fully-qualified name of the object that was (or will be) created/updated within the database.
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved


## Quick hits

Expand Down
11 changes: 10 additions & 1 deletion website/docs/reference/artifacts/run-results-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,20 @@ Each entry in `results` is a [`Result` object](/reference/dbt-classes#result-obj
- `execution_time`: Total time spent executing this node
- `timing`: Array that breaks down execution time into steps (often `compile` + `execute`)
- `message`: How dbt will report this result on the CLI, based on information returned from the database

import RowsAffected from '/snippets/_run-result.md';

<RowsAffected/>

<!-- this partial comes from https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/snippets/_run-result-->

<VersionBlock firstVersion="1.8">

There are three attributes related to the `applied` state in the run_results.json (to complement unique_id):
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved

- `compiled`: Boolean entry of the node compilation status (`False` after parsing, but `True` after compiling).
- `compiled_code`: rendered string of the code that was compiled (empty after parsing, but full string after compiling).
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
- `relation_name`: the fully-qualified name of the object that was (or will be) created/updated within the database.
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved

Any additional information about the `logical` state of nodes should continue to be looked up in the full node object in manifest.json via the unique_id.
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved

matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
</VersionBlock>
Loading