Skip to content

Commit 8abb5b5

Browse files
committed
Correct the cherry-pick docs to match the implementation
The Write-Audit-Publish section described the earlier draft, where a pick was fast-forwarded when the table had not moved. Appends are always replayed, so the wap trail is recorded either way; fast-forward is the fallback for non-appends whose parent is current. Signed-off-by: 1fanwang <1fannnw@gmail.com>
1 parent 05ae65d commit 8abb5b5

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

mkdocs/docs/api.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1511,9 +1511,10 @@ table.manage_snapshots().cherry_pick_snapshot(staged).commit()
15111511
The published snapshot records `source-snapshot-id`, and `published-wap-id` when the staged
15121512
snapshot carried a `wap.id`. A given `wap.id` can only be published once.
15131513

1514-
If the table has not changed since the branch was cut, the branch is fast-forwarded rather than
1515-
replayed. Picking a snapshot that is already an ancestor of the current state does nothing. Only
1516-
append snapshots can be replayed; anything else raises.
1514+
Append snapshots are always replayed, so the wap trail is recorded even when the table has not
1515+
changed since the branch was cut. A snapshot with any other operation is fast-forwarded to when
1516+
its parent is already the current snapshot, and raises otherwise. Picking a snapshot that is
1517+
already an ancestor of the current state does nothing.
15171518

15181519
## Table Maintenance
15191520

0 commit comments

Comments
 (0)