nastra commented on a change in pull request #3425:
URL: https://github.com/apache/iceberg/pull/3425#discussion_r742143147
##########
File path: site/docs/snapshot-tag-branch.md
##########
@@ -0,0 +1,148 @@
+# Snapshot Tagging and Branching
+
+Iceberg snapshot tagging and branching feature offers user a Git-like
experience in manging table snapshots.
Review comment:
I agree that the `git-like experience` part could confuse users as to
what that really means.
I believe in some version of the design doc you named it `Named Snapshots`
(or something similar) as to me that's what this feature really is. Those are
named snapshots where the `type` can be either a `branch` (moves forward with
changes) or a `tag` (does not move forward) and I would probably rather explain
this feature from this perspective
##########
File path: site/docs/spec.md
##########
@@ -548,6 +548,21 @@ Notes:
1. An alternative, *strict projection*, creates a partition predicate that
will match a file if all of the rows in the file must match the scan predicate.
These projections are used to calculate the residual predicates for each file
in a scan.
2. For example, if `file_a` has rows with `id` between 1 and 10 and a delete
file contains rows with `id` between 1 and 4, a scan for `id = 9` may ignore
the delete file because none of the deletes can match a row that will be
selected.
+#### Snapshot Reference
+
+Snapshot reference allows users to perform tagging and branching within an
Iceberg table. The detailed user experience is described in [Iceberg Tagging
and Branching](../snapshot-tag-branch).
+
+The snapshot reference object records all the user-defined information of a
snapshot including name, reference type and retention policy configurations.
+
+| v2 | Field name | Type | Description |
+| ---------- |------------------------------|-----------|-------------|
+| _required_ | **`snapshot-id`** | `long` | The ID of the
snapshot referenced |
+| _required_ | **`name`** | `string` | The name of the
reference |
+| _required_ | **`type`** | `string` | Type of the
reference, `tag` or `branch` |
+| _optional_ | **`min-snapshots-to-keep`** | `int` | For `branch` type
only, the minimum number of snapshots to keep in a branch |
+| _required_ | **`max-snapshot-age-ms`** | `long` | The duration before
a snapshot tagged or in a branch could be expired by any automatic snapshot
expiration process |
Review comment:
maybe change to `The duration before a snapshot reference can be expired
by any automatic snapshot expiration process`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
