Skip to content

Commit

Permalink
[core] add doc for asynchronous expiration.
Browse files Browse the repository at this point in the history
  • Loading branch information
liming30 committed Sep 15, 2023
1 parent b3f1031 commit 950e188
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/content/maintenance/manage-snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,20 @@ Snapshot expiration is controlled by the following table properties.
<td>Integer</td>
<td>The maximum number of completed snapshots to retain. Should be greater than or equal to the minimum number.</td>
</tr>
<tr>
<td><h5>snapshot.expire.execution-mode</h5></td>
<td>No</td>
<td style="word-wrap: break-word;">sync</td>
<td>Enum</td>
<td>Specifies the execution mode of expire.</td>
</tr>
<tr>
<td><h5>snapshot.expire.limit</h5></td>
<td>No</td>
<td style="word-wrap: break-word;">10</td>
<td>Integer</td>
<td>The maximum number of snapshots allowed to expire at a time.</td>
</tr>
</tbody>
</table>

Expand Down Expand Up @@ -207,6 +221,11 @@ Please note that too short retain time or too small retain number may result in:
[Consumer Id]({{< ref "how-to/querying-tables#consumer-id" >}}) to protect streaming reading
in a small retain time of snapshot expiration).

By default, paimon will delete expired snapshots synchronously. When there are too
many files that need to be deleted, they may not be deleted quickly and back-pressured
to the upstream operator. To avoid this situation, users can use asynchronous expiration
mode by setting `snapshot.expire.execution-mode` to `async`.

## Rollback to Snapshot

Rollback a table to a specific snapshot ID.
Expand Down

0 comments on commit 950e188

Please sign in to comment.