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] Add documentation for Row Tracking #2939

Merged
merged 4 commits into from
Jun 18, 2024

Conversation

tomvanbussel
Copy link
Contributor

Which Delta project/connector is this regarding?

  • Spark
  • Standalone
  • Flink
  • Kernel
  • Other (Docs)

Description

This PR adds documentation for the new Row Tracking table feature that is releasing in Delta 3.2.0

How was this patch tested?

N/A

Does this PR introduce any user-facing changes?

N/A

Copy link
Collaborator

@johanl-db johanl-db left a comment

Choose a reason for hiding this comment

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

I don't know if this should target master, branch-3.2 or both. Probably both to have a current and historic version of the doc

docs/source/delta-row-tracking.md Outdated Show resolved Hide resolved
Comment on lines +10 to +12
- **Row IDs** provide rows with an identifier that is unique within the table. A row keeps the same ID whenever it is modified using a `MERGE` or `UPDATE` statement.

- **Row commit versions** record the last version of the table in which the row was modified. A row is assigned a new version whenever it is modified using a `MERGE` or `UPDATE` statement.
Copy link
Collaborator

Choose a reason for hiding this comment

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

It could be worth quickly highlighting here that these can be accessed via _metadata.row_id and _metadata.row_commit_version` even if there's more detail about it below

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm trying to keep this first section a little bit more high-level.

docs/source/delta-row-tracking.md Outdated Show resolved Hide resolved
docs/source/delta-row-tracking.md Show resolved Hide resolved
Copy link
Collaborator

@johanl-db johanl-db left a comment

Choose a reason for hiding this comment

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

LGTM!
I deployed the change locally, rendering looks good

@allisonport-db allisonport-db merged commit 12efca4 into delta-io:master Jun 18, 2024
10 checks passed
tomvanbussel added a commit to tomvanbussel/delta that referenced this pull request Jun 24, 2024
<!--
Thanks for sending a pull request!  Here are some tips for you:
1. If this is your first time, please read our contributor guidelines:
https://github.com/delta-io/delta/blob/master/CONTRIBUTING.md
2. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP]
Your PR title ...'.
  3. Be sure to keep the PR description updated to reflect all changes.
  4. Please write your PR title to summarize what this PR proposes.
5. If possible, provide a concise example to reproduce the issue for a
faster review.
6. If applicable, include the corresponding issue number in the PR title
and link it in the body.
-->

#### Which Delta project/connector is this regarding?
<!--
Please add the component selected below to the beginning of the pull
request title
For example: [Spark] Title of my pull request
-->

- [ ] Spark
- [ ] Standalone
- [ ] Flink
- [ ] Kernel
- [x] Other (Docs)

## Description

This PR adds documentation for the new Row Tracking table feature that
is releasing in Delta 3.2.0

## How was this patch tested?

N/A

## Does this PR introduce _any_ user-facing changes?

N/A
vkorukanti pushed a commit that referenced this pull request Jun 24, 2024
## Description

This PR adds documentation for the new Row Tracking table feature that
is releasing in Delta 3.2.0. This is a cherry-pick of
#2939 to branch-3.2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants