org.apache.iceberg

Class BaseRewriteManifests

java.lang.Object

org.apache.iceberg.BaseRewriteManifests

All Implemented Interfaces:

PendingUpdate<Snapshot>, RewriteManifests, SnapshotUpdate<RewriteManifests>

public class BaseRewriteManifests
extends java.lang.Object
implements RewriteManifests

Method Summary

Modifier and Type	Method and Description
Snapshot	apply() Apply the pending changes and return the uncommitted changes for validation.
java.util.List<ManifestFile>	apply(TableMetadata base) Apply the update's changes to the base table metadata and return the new manifest list.
protected void	cleanAll()
protected void	cleanUncommitted(java.util.Set<ManifestFile> committed) Clean up any uncommitted manifests that were created.
RewriteManifests	clusterBy(java.util.function.Function<DataFile,java.lang.Object> func) Groups an existing DataFile by a cluster key produced by a function.
void	commit() Apply the pending changes and commit.
protected void	deleteFile(java.lang.String path)
ThisT	deleteWith(java.util.function.Consumer<java.lang.String> deleteCallback) Set a callback to delete files instead of the table's default.
protected OutputFile	manifestListPath()
protected OutputFile	manifestPath(int manifestNumber)
protected java.lang.String	operation() A string that describes the action that produced the new snapshot.
RewriteManifests	rewriteIf(java.util.function.Predicate<ManifestFile> pred) Determines which existing ManifestFile for the table should be rewritten.
protected RewriteManifests	self()
RewriteManifests	set(java.lang.String property, java.lang.String value) Set a summary property in the snapshot produced by this update.
protected long	snapshotId()
ThisT	stageOnly() Called to stage a snapshot in table metadata, but not update the current snapshot id.
protected java.util.Map<java.lang.String,java.lang.String>	summary()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.iceberg.SnapshotUpdate

deleteWith, stageOnly

Methods inherited from interface org.apache.iceberg.PendingUpdate

apply, commit

Method Detail

self

protected RewriteManifests self()

operation

protected java.lang.String operation()

A string that describes the action that produced the new snapshot.

Returns:

a string operation

set

public RewriteManifests set(java.lang.String property,
                            java.lang.String value)

Description copied from interface: SnapshotUpdate

Set a summary property in the snapshot produced by this update.

Specified by:

set in interface SnapshotUpdate<RewriteManifests>

Parameters:

property - a String property name

value - a String property value

Returns:

this for method chaining

summary

protected java.util.Map<java.lang.String,java.lang.String> summary()

clusterBy

public RewriteManifests clusterBy(java.util.function.Function<DataFile,java.lang.Object> func)

Description copied from interface: RewriteManifests

Groups an existing DataFile by a cluster key produced by a function. The cluster key will determine which data file will be associated with a particular manifest. All data files with the same cluster key will be written to the same manifest (unless the file is large and split into multiple files).

Specified by:

clusterBy in interface RewriteManifests

Parameters:

func - Function used to cluster data files to manifests.

Returns:

this for method chaining

rewriteIf

public RewriteManifests rewriteIf(java.util.function.Predicate<ManifestFile> pred)

Description copied from interface: RewriteManifests

Determines which existing ManifestFile for the table should be rewritten. Manifests that do not match the predicate are kept as-is. If this is not called and no predicate is set, then all manifests will be rewritten.

Specified by:

rewriteIf in interface RewriteManifests

Parameters:

pred - Predicate used to determine which manifests to rewrite. If true then the manifest file will be included for rewrite. If false then then manifest is kept as-is.

Returns:

this for method chaining

apply

public java.util.List<ManifestFile> apply(TableMetadata base)

Apply the update's changes to the base table metadata and return the new manifest list.

Parameters:

base - the base table metadata to apply changes to

Returns:

a manifest list for the new snapshot.

cleanUncommitted

protected void cleanUncommitted(java.util.Set<ManifestFile> committed)

Clean up any uncommitted manifests that were created.

Manifests may not be committed if apply is called more because a commit conflict has occurred. Implementations may keep around manifests because the same changes will be made by both apply calls. This method instructs the implementation to clean up those manifests and passes the paths of the manifests that were actually committed.

Parameters:

committed - a set of manifest paths that were actually committed

stageOnly

public ThisT stageOnly()

Description copied from interface: SnapshotUpdate

Called to stage a snapshot in table metadata, but not update the current snapshot id.

Specified by:

stageOnly in interface SnapshotUpdate<ThisT>

Returns:

this for method chaining

deleteWith

public ThisT deleteWith(java.util.function.Consumer<java.lang.String> deleteCallback)

Description copied from interface: SnapshotUpdate

Set a callback to delete files instead of the table's default.

Specified by:

deleteWith in interface SnapshotUpdate<ThisT>

Parameters:

deleteCallback - a String consumer used to delete locations.

Returns:

this for method chaining

apply

public Snapshot apply()

Description copied from interface: PendingUpdate

Apply the pending changes and return the uncommitted changes for validation.

This does not result in a permanent update.

Specified by:

apply in interface PendingUpdate<Snapshot>

Returns:

the uncommitted changes that would be committed by calling PendingUpdate.commit()

commit

public void commit()

Description copied from interface: PendingUpdate

Apply the pending changes and commit.

Changes are committed by calling the underlying table's commit method.

Once the commit is successful, the updated table will be refreshed.

Specified by:

commit in interface PendingUpdate<Snapshot>

cleanAll

protected void cleanAll()

deleteFile

protected void deleteFile(java.lang.String path)

manifestListPath

protected OutputFile manifestListPath()

manifestPath

protected OutputFile manifestPath(int manifestNumber)

snapshotId

protected long snapshotId()