org.apache.iceberg.actions

Interface SnapshotTable

All Superinterfaces:

Action<SnapshotTable,SnapshotTable.Result>

All Known Implementing Classes:

BaseSnapshotTableSparkAction

public interface SnapshotTable
extends Action<SnapshotTable,SnapshotTable.Result>

An action that creates an independent snapshot of an existing table.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SnapshotTable.Result The action result that contains a summary of the execution.

Method Summary

Modifier and Type	Method and Description
SnapshotTable	as(java.lang.String destTableIdent) Sets the table identifier for the newly created Iceberg table.
SnapshotTable	tableLocation(java.lang.String location) Sets the table location for the newly created Iceberg table.
SnapshotTable	tableProperties(java.util.Map<java.lang.String,java.lang.String> properties) Sets table properties in the newly created Iceberg table.
SnapshotTable	tableProperty(java.lang.String key, java.lang.String value) Sets a table property in the newly created Iceberg table.

Methods inherited from interface org.apache.iceberg.actions.Action

execute, option, options

Method Detail

as

SnapshotTable as(java.lang.String destTableIdent)

Sets the table identifier for the newly created Iceberg table.

Parameters:

destTableIdent - the destination table identifier

Returns:

this for method chaining

tableLocation

SnapshotTable tableLocation(java.lang.String location)

Sets the table location for the newly created Iceberg table.

Parameters:

location - a table location

Returns:

this for method chaining

tableProperties

SnapshotTable tableProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Sets table properties in the newly created Iceberg table. Any properties with the same key name will be overwritten.

Parameters:

properties - a map of properties to be included

Returns:

this for method chaining

tableProperty

SnapshotTable tableProperty(java.lang.String key,
                            java.lang.String value)

Sets a table property in the newly created Iceberg table. Any properties with the same key name will be overwritten.

Parameters:

key - the key of the property to add

value - the value of the property to add

Returns:

this for method chaining