[core] Document Table.newExpireSnapshots

lmagic233 · Jan 31, 2024 · 89e908d · 89e908d
1 parent ca26bd0
commit 89e908d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/paimon-core/src/main/java/org/apache/paimon/table/ExpireSnapshots.java b/paimon-core/src/main/java/org/apache/paimon/table/ExpireSnapshots.java
@@ -29,5 +29,6 @@ public interface ExpireSnapshots {
 
     ExpireSnapshots maxDeletes(int maxDeletes);
 
+    /** @return How many snapshots have been expired. */
     int expire();
 }
diff --git a/paimon-core/src/main/java/org/apache/paimon/table/Table.java b/paimon-core/src/main/java/org/apache/paimon/table/Table.java
@@ -96,6 +96,8 @@ public interface Table extends Serializable {
     @Experimental
     void deleteBranch(String branchName);
 
+    /** Manually expire snapshots, parameters can be controlled independently of table options. */
+    @Experimental
     ExpireSnapshots newExpireSnapshots();
 
     // =============== Read & Write Operations ==================