Package org.apache.iceberg

Interface SnapshotUpdate<ThisT>

Type Parameters:
ThisT - the child Java API class, returned by method chaining.
All Superinterfaces:
PendingUpdate<Snapshot>
All Known Subinterfaces:
AppendFiles, DeleteFiles, OverwriteFiles, ReplacePartitions, RewriteFiles, RewriteManifests, RowDelta
All Known Implementing Classes:
BaseOverwriteFiles, BaseReplacePartitions, BaseRewriteManifests, StreamingDelete
public interface SnapshotUpdate<ThisT> extends PendingUpdate<Snapshot>
API for table changes that produce snapshots. This interface contains common methods for all updates that create a new table Snapshot.

  • Method Details

    • set

      ThisT set(String property, String value)
      Set a summary property in the snapshot produced by this update.
      Parameters:
      property - a String property name
      value - a String property value
      Returns:
      this for method chaining

    • deleteWith

      ThisT deleteWith(Consumer<String> deleteFunc)
      Set a callback to delete files instead of the table's default.
      Parameters:
      deleteFunc - a String consumer used to delete locations.
      Returns:
      this for method chaining

    • stageOnly

      ThisT stageOnly()
      Called to stage a snapshot in table metadata, but not update the current snapshot id.
      Returns:
      this for method chaining

    • scanManifestsWith

      ThisT scanManifestsWith(ExecutorService executorService)
      Use a particular executor to scan manifests. The default worker pool will be used by default.
      Parameters:
      executorService - the provided executor
      Returns:
      this for method chaining

    • toBranch

      default ThisT toBranch(String branch)
      Perform operations on a particular branch
      Parameters:
      branch - which is name of SnapshotRef of type branch.