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

Docs updates for Applied Source Metadata #5010

Closed
1 task done
mikealfare opened this issue Feb 28, 2024 · 2 comments · Fixed by #5089
Closed
1 task done

Docs updates for Applied Source Metadata #5010

mikealfare opened this issue Feb 28, 2024 · 2 comments · Fixed by #5089
Assignees
Labels
adapters content Improvements or additions to content external-adapters-team auto labeled issues from the adapter team improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@mikealfare
Copy link
Contributor

mikealfare commented Feb 28, 2024

Contributions

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

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

I'll find this, but it would probably be a page about docs generate that lists what adapters support what features.

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

Add that dbt-redshift supports filtered get_catalog and metadata-based source freshness.

Additional information

No response

@mikealfare mikealfare added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Feb 28, 2024
@runleonarun runleonarun added adapters external-adapters-team auto labeled issues from the adapter team labels Feb 28, 2024
@nghi-ly nghi-ly removed the adapters label Feb 29, 2024
@nghi-ly
Copy link
Contributor

nghi-ly commented Feb 29, 2024

hey @mikealfare : if basically we just want a table that lists what's supported with what, i'm thinking that info can live on this page:

https://docs.getdbt.com/docs/dbt-cloud-apis/project-state

since it's the place where "Applied State" is talked about. thoughts?

for the table, do we want the rows to be adapter names and the columns to be the metadata?

@mikealfare
Copy link
Contributor Author

mikealfare commented Mar 1, 2024

Discovery API sounds right to me. I think that's where we ultimately surface this information anyway. @graciegoheen / @dbeatty10, does that sound right to you too? I think we would want the rows to be adapters as you mention, and then maybe a column for catalog information and a column for source freshness, each indicating the "level" of support for the information. So something like:

| Adapter       | Catalog     | Source Freshness      |
|===============|=============|=======================|
| dbt-snowflake | incremental | metadata-based        |
| dbt-spark     | manual run  | loaded_at field-based |

And then we should have something that explains the "level"s:

Source Freshness can be measured via metadata when the platform and adapter support it. This allows for calculating source freshness without a loaded_at field and without querying the table directly. This is much faster and more flexible. This can also be overridden if desired by providing a loaded_at field in the model config. If the platform/adapter do not support this, then using a loaded_at field is still an option.

The catalog can be built incrementally for adapters that support it. This allows for the catalog to be built along with the model, which eliminates the need to run a lengthy dbt docs generate at the end of a dbt run. For adapters that do not support incremental catalog generation, you will need to run dbt docs generate to build the catalog.

I would want someone else, either @nghi-ly, @graciegoheen, or @dbeatty10 to review the verbiage I'm using here, including the terms (e.g. loaded_at, "manual" vs. "incremental", "metadata-based" vs "field-based", etc.).

nghi-ly added a commit that referenced this issue Mar 27, 2024
## What are you changing in this pull request and why?

Document the improvements to applied state metadata

Closes #5010 

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [x] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [x] Needs review from product team
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adapters content Improvements or additions to content external-adapters-team auto labeled issues from the adapter team improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants