Skip to content

Commit

Permalink
More clearly delineate the two points of time for the `graph_summary.…
Browse files Browse the repository at this point in the history
…json` artifact (#4368)

[Preview](https://docs-getdbt-com-git-dbeatty10-patch-1-dbt-labs.vercel.app/reference/artifacts/other-artifacts#graph_summaryjson)

## What are you changing in this pull request and why?

I was sharing the documentation for
[`graph_summary.json`](https://docs.getdbt.com/reference/artifacts/other-artifacts#graph_summaryjson)
with a colleague and realized it could be more clear.

### Also

It would be good to call out that the `name` within this artifact is the
same as the `unique_id` in
[`manifest.json`](https://docs.getdbt.com/reference/artifacts/manifest-json#resource-details).

It would also be nice to link to a page enumerating the valid resource /
node types, but we'd need
#4314 to do that.

## Example artifacts

<details>

<summary>

#### `dbt list`
</summary>

```json
{
    "_invocation_id": "535f4bc1-16d3-4a0a-96d8-28602ad158b3",
    "linked": {
        "0": {
            "name": "model.jaffle_shop.stg_customers",
            "type": "model"
        },
        "1": {
            "name": "seed.jaffle_shop.my_seed",
            "type": "seed",
            "succ": [
                0
            ]
        },
        "2": {
            "name": "test.jaffle_shop.not_null_stg_customers_id.6bd2c50f02",
            "type": "test"
        }
    }
}
```
</details>


<details>

<summary>

#### `dbt build`
</summary>

```yaml
{
    "_invocation_id": "2ba72f5f-edd8-4fda-8b0a-6e7f7fcf654f",
    "linked": {
        "0": {
            "name": "model.jaffle_shop.stg_customers",
            "type": "model",
            "succ": [
                2
            ]
        },
        "1": {
            "name": "seed.jaffle_shop.my_seed",
            "type": "seed",
            "succ": [
                0
            ]
        },
        "2": {
            "name": "test.jaffle_shop.not_null_stg_customers_id.6bd2c50f02",
            "type": "test"
        }
    },
    "with_test_edges": {
        "0": {
            "name": "model.jaffle_shop.stg_customers",
            "type": "model",
            "succ": [
                2
            ]
        },
        "1": {
            "name": "seed.jaffle_shop.my_seed",
            "type": "seed",
            "succ": [
                0
            ]
        },
        "2": {
            "name": "test.jaffle_shop.not_null_stg_customers_id.6bd2c50f02",
            "type": "test"
        }
    }
}
```

</details>

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
- [x] I have verified the preview looks good

---------

Co-authored-by: Matt Shaver <[email protected]>
  • Loading branch information
dbeatty10 and matthewshaver authored Oct 30, 2023
1 parent 6b64e06 commit 2a31c2f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion website/docs/reference/artifacts/other-artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,8 @@ This file is useful for investigating performance issues in dbt Core's graph alg

It is more anonymized and compact than [`manifest.json`](/reference/artifacts/manifest-json) and [`graph.gpickle`](#graph.gpickle).

It contains only the `name` and `type` of each node along with IDs of its child nodes (`succ`). It includes that information at two separate points in time: immediately after the graph is linked together (`linked`), and after test edges have been added (`with_test_edges`).
It includes that information at two separate points in time:
1. `linked` &mdash; immediately after the graph is linked together, and
2. `with_test_edges` &mdash; after test edges have been added.

Each of those points in time contains the `name` and `type` of each node and `succ` contains the keys of its child nodes.

0 comments on commit 2a31c2f

Please sign in to comment.