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

Improve snapshots docs examples and dbt_updates_at field description #3242

Closed
1 task done
runleonarun opened this issue Apr 21, 2023 · 1 comment · Fixed by #3251
Closed
1 task done

Improve snapshots docs examples and dbt_updates_at field description #3242

runleonarun opened this issue Apr 21, 2023 · 1 comment · Fixed by #3251
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear priority: medium Fix or enhancement to existing information that’s creating some requests from customers

Comments

@runleonarun
Copy link
Collaborator

Contributions

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

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

Examples like this: https://docs.getdbt.com/docs/build/snapshots#hard-deletes-opt-in

dbt_updated_at description:
https://docs.getdbt.com/docs/build/snapshots#snapshot-meta-fields

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

For the examples

Update examples to match filenames to match the name of the snapshot. In this example, we need to change hard_delete_example.sql to orders_snapshot_hard_delete
From @graciegoheen

It’s our best practice for the name of the files to match the name of the snapshot, but our examples have names that differ from the snapshot name (this confused a customer i’m working with who was trying to copy the examples to test out the functionality)

Update the dbt_updated_at_timestamp description to account for different strategies as described by Grace in the following quote. We might need to consult @dbt-labs/devex on these nuances.

the dbt_updated_at field is described as “The updated_at timestamp of the source record when this snapshot row was inserted.” But if you have a snapshot using the check_cols strategy, your source record won’t have an updated_at timestamp. Does this field depend on the strategy that you’re using? Looks like it’s the current_timestamp if you’re using check_cols.

Additional information

No response

@runleonarun runleonarun added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear priority: medium Fix or enhancement to existing information that’s creating some requests from customers references-project references-project-v2 and removed references-project references-project-v2 labels Apr 21, 2023
@dbeatty10
Copy link
Contributor

dbeatty10 commented Apr 24, 2023

It feels like there's two different things here, both related to snapshots:

  1. Filename vs. snapshot name
  2. Documentation related to dbt_updated_at

I'd suggest splitting them into two different issues and two different PRs.

Filename vs. snapshot name

This one seems really easy to address and can be knocked out with a quick PR.

Edit: I opened #3251 to address this portion.

Documentation related to dbt_updated_at

This one has way more complication and nuance and will take more intense focus to get all the details right. And it seems like it would be covered by one or more of these issues:

Maybe @graciegoheen's comments related to updated_at could be added to one of those other issues instead?

dbeatty10 added a commit that referenced this issue Apr 27, 2023
resolves #3242

[Preview > Snapshots > Hard deletes
(opt-in)](https://deploy-preview-3251--docs-getdbt-com.netlify.app/docs/build/snapshots#hard-deletes-opt-in)

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

## 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.

Co-authored-by: mirnawong1 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear priority: medium Fix or enhancement to existing information that’s creating some requests from customers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants