Skip to content

Commit

Permalink
[Docs][3.3] Update documentation for Row Tracking to include Row Trac…
Browse files Browse the repository at this point in the history
…king Backfill introduced in Delta 3.3 (#3969)

<!--
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
- Cherry-pick #3968 into Delta
3.3.
<!--
- Describe what this PR changes.
- Describe why we need the change.
 
If this PR resolves an issue be sure to include "Resolves #XXX" to
correctly link and close the issue upon merge.
-->

## How was this patch tested?
N/A
<!--
If tests were added, say they were added here. Please make sure to test
the changes thoroughly including negative and positive cases if
possible.
If the changes were tested in any way other than unit tests, please
clarify how you tested step by step (ideally copy and paste-able, so
that other reviewers can test and check, and descendants can verify in
the future).
If the changes were not tested, please explain why.
-->

## Does this PR introduce _any_ user-facing changes?
N/A
<!--
If yes, please clarify the previous behavior and the change this PR
proposes - provide the console output, description and/or an example to
show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change
compared to the released Delta Lake versions or within the unreleased
branches such as master.
If no, write 'No'.
-->
  • Loading branch information
longvu-db authored Dec 13, 2024
1 parent d0be1d7 commit 259751b
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/source/delta-row-tracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Row tracking allows <Delta> to track row-level lineage in a <Delta> table. When

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

.. note:: This feature is available in <Delta> 3.2.0 and above. This feature is in experimental support mode with [_](#limitations).
.. note:: This feature is available in <Delta> 3.2.0 and above. Enabling this feature on existing non-empty tables is available in <Delta> 3.3.0 and above.

## Enable row tracking

Expand All @@ -37,7 +37,7 @@ You must explicitly enable row tracking using one of the following methods:
CREATE TABLE graduate CLONE student;
```

- **Existing table**: Set the table property `'delta.enableRowTracking' = 'true'` in the `ALTER TABLE` command.
- **Existing table**: Available from Delta 3.3 and above, set the table property `'delta.enableRowTracking' = 'true'` in the `ALTER TABLE` command.

```sql
ALTER TABLE grade SET TBLPROPERTIES ('delta.enableRowTracking' = 'true');
Expand Down Expand Up @@ -108,7 +108,6 @@ ALTER TABLE table_name SET TBLPROPERTIES (delta.enableRowTracking = false);
The following limitations exist:

- The row ids and row commit versions metadata fields cannot be accessed while reading the [Change data feed](/delta/delta-change-data-feed.md).
- Row Tracking can currently only be enabled when creating the table or when the table is empty. Enabling row tracking on a non-empty table is currently not supported.
- Once the Row Tracking feature is added to the table it cannot be removed without recreating the table.

.. <Delta> replace:: Delta Lake
Expand Down

0 comments on commit 259751b

Please sign in to comment.