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

Jump to bottom

Page that explains and enumerates all the node / resource types #4314

Open
1 task done
dbeatty10 opened this issue Oct 23, 2023 · 1 comment
Open
1 task done

Page that explains and enumerates all the node / resource types #4314

dbeatty10 opened this issue Oct 23, 2023 · 1 comment
Assignees
@mirnawong1
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@dbeatty10
Copy link
Contributor

dbeatty10 commented Oct 23, 2023 •
edited
Loading

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

We can add more detail here:
https://docs.getdbt.com/reference/global-configs/resource-type

Alternatively, we could create a new stand-alone page.

What part(s) of the page would you like to see updated?

The closest documentation to enumerating the valid resource types within dbt is this.

Without a single page that enumerates all the resource types, it makes it harder to do documentation like is needed for #4313.

It would be nice if our documentation also makes the distinction between the types that can be versioned, ref'd, and/or executed

dbt project containing "all" resource types

Here's a simple dbt project that has quite a few different resource types (but probably not all): #4492 (comment)

Main resource types

    Model = "model"  # executable / refable / versioned
    Seed = "seed"  # executable / refable
    Snapshot = "snapshot"  # executable / refable
    Analysis = "analysis"  # executable
    Source = "source"

Testing-related resource types

    Test = "test"  # executable
    Unit = "unit_test"
    Fixture = "fixture"

Semantic layer resource types

    SemanticModel = "semantic_model"
    Metric = "metric"
    SavedQuery = "saved_query"

Other resource types

    Exposure = "exposure"
    Macro = "macro"
    Group = "group"
    Operation = "operation"  # executable
    RPCCall = "rpc"  # executable
    SqlOperation = "sql_operation"  # executable
    Documentation = "doc"  # executable

Potential table

See below for a re-imagining of the table here.

Warning

The following information hasn't been verified for completeness or correctness!

Node Executed in DAG Exists in database Created by execution Upstream lineage Downstream lineage
Source ✅ →
Snapshot ✅ ✅ ✅ ← →
Model - incremental ✅ ✅ ✅ ← →
Model - materialized view ✅ ✅ ✅ ← →
Model - view ✅ ✅ ✅ ← →
Model - table ✅ ✅ ✅ ← →
Seed ✅ ✅ ✅ →
Model - ephemeral ✅ ← →
Analysis ✅ ←
Semantic model ← →
Metric ← →
Saved query ←
Export ✅ ←
Exposure ←
Data test ✅ ☑️ ☑️ ←
Unit test ←
Fixture →
Group →
Macro ✅

Additional information

Implementing this would unlock or enhance the following:
@dbeatty10 dbeatty10 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Oct 23, 2023
@dbeatty10 dbeatty10 mentioned this issue Oct 30, 2023
Merged
2 tasks
dbeatty10 added a commit that referenced this issue Oct 30, 2023
@dbeatty10 @matthewshaver
More clearly delineate the two points of time for the `graph_summary.…
2a31c2f 
…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]>
This was referenced Nov 2, 2023
Open
Merged
@mirnawong1 mirnawong1 self-assigned this Nov 9, 2023
@mirnawong1 mirnawong1 mentioned this issue Nov 14, 2023
Closed
@mirnawong1
Copy link
Contributor

hey @dbeatty10 , working on this now and created this pr here - just need to double check the supported properties/configs table though: #4466

This was referenced Feb 9, 2024
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mirnawong1 mirnawong1

Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add new resource list page dbt-labs/docs.getdbt.com
2 participants
@dbeatty10 @mirnawong1