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

Define column names #6140

Closed
wants to merge 7 commits into from
Closed

Define column names #6140

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
06fa231
Updated Snapshot meta-fields section to highlight new config allows u…
nataliefiann Sep 25, 2024
ea5ac0e
Update website/docs/docs/build/snapshots.md
nataliefiann Sep 25, 2024
d2e4fe7
Update website/docs/docs/build/snapshots.md
nataliefiann Sep 25, 2024
ab92660
Update website/docs/docs/build/snapshots.md
nataliefiann Sep 25, 2024
6ca212f
Update website/docs/docs/build/snapshots.md
nataliefiann Sep 30, 2024
392e724
Update website/docs/docs/build/snapshots.md
nataliefiann Sep 30, 2024
9f8f9b2
Update website/docs/docs/build/snapshots.md
nataliefiann Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions website/docs/docs/build/snapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,16 @@ Snapshot results:

</details>

<VersionBlock firstVersion="1.9">

### Define column names in snapshot table
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is the correct language.. something more like "customize the names of the dbt-generated meta fields in your snapshot tables"

nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small sugg that's not a blocker: maybe have the header outside the versionblock and tell users on 1.8 and lower that this feature is only avail in 1.9 and higher or versionless so they know?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

++ we need to do this for all new features!

In dbt Cloud, there's a config which will now allow you to define the names of the columns that are created in the [snapshot table](/docs/build/snapshots#snapshot-meta-fields). Users can now set this config to use different names.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm a little confused -- is this only for dbt cloud? i thought this was something avail to both cloud and core users since it relates to snapshots? maybe the diff is it's available to versionless users now and 1.9 users when 1.9 is launched?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry - that was a force if habit. I'll update this. Thanks for this

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In dbt Cloud, there's a config which will now allow you to define the names of the columns that are created in the [snapshot table](/docs/build/snapshots#snapshot-meta-fields). Users can now set this config to use different names.
Define the names of the columns created in the [snapshot table](/docs/build/snapshots#snapshot-meta-fields) using custom configurations. The original columns were named `dbt_valid_to`, `dbt_valid_from`, `dbt_scd_id`, and `dbt_updated_at`, however, users can now customize these names as needed.

nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

If a user renames the columns for a snapshot without updating an existing table, they will get an error. The recommendation is to use these settings for new snapshots, or to arrange to update your existing tables prior to committing a column name change.
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

nataliefiann marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

@graciegoheen graciegoheen Sep 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add an example

</VersionBlock>


## FAQs
<FAQ path="Runs/run-one-snapshot" />
Expand Down
Loading