io.delta.kernel

Interface Table

@Evolving
public interface Table

Represents the Delta Lake table for a given path.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
void	checkpoint(Engine engine, long version) Checkpoint the table at given version.
TransactionBuilder	createTransactionBuilder(Engine engine, String engineInfo, Operation operation) Create a TransactionBuilder which can create a Transaction object to mutate the table.
static Table	forPath(Engine engine, String path) Instantiate a table object for the Delta Lake table at the given path.
Snapshot	getLatestSnapshot(Engine engine) Get the latest snapshot of the table.
String	getPath(Engine engine) The fully qualified path of this Table instance.
Snapshot	getSnapshotAsOfTimestamp(Engine engine, long millisSinceEpochUTC) Get the snapshot of the table at the given timestamp.
Snapshot	getSnapshotAsOfVersion(Engine engine, long versionId) Get the snapshot at the given versionId.

Method Detail

forPath

static Table forPath(Engine engine,
                     String path)

Instantiate a table object for the Delta Lake table at the given path.

• Behavior when the table location doesn't exist:
  • Reads will fail with a TableNotFoundException
  • Writes will create the location
• Behavior when the table location exists (with contents or not) but not a Delta table:
  • Reads will fail with a TableNotFoundException
  • Writes will create a Delta table at the given location. If there are any existing files in the location that are not already part of the Delta table, they will remain excluded from the Delta table.

Parameters:

engine - Engine instance to use in Delta Kernel.

path - location of the table. Path is resolved to fully qualified path using the given engine.

Returns:

an instance of Table representing the Delta table at the given path

getPath

String getPath(Engine engine)

The fully qualified path of this Table instance.

Parameters:

engine - Engine instance.

Returns:

the table path.

Since:

3.2.0

getLatestSnapshot

Snapshot getLatestSnapshot(Engine engine)
                    throws TableNotFoundException

Get the latest snapshot of the table.

Parameters:

engine - Engine instance to use in Delta Kernel.

Returns:

an instance of Snapshot

Throws:

TableNotFoundException - if the table is not found

getSnapshotAsOfVersion

Snapshot getSnapshotAsOfVersion(Engine engine,
                                long versionId)
                         throws TableNotFoundException

Get the snapshot at the given versionId.

Parameters:

engine - Engine instance to use in Delta Kernel.

versionId - snapshot version to retrieve

Returns:

an instance of Snapshot

Throws:

TableNotFoundException - if the table is not found

KernelException - if the provided version is less than the first available version or greater than the last available version

Since:

3.2.0

getSnapshotAsOfTimestamp

Snapshot getSnapshotAsOfTimestamp(Engine engine,
                                  long millisSinceEpochUTC)
                           throws TableNotFoundException

Get the snapshot of the table at the given timestamp. This is the latest version of the table that was committed before or at timestamp.

Specifically:

• If a commit version exactly matches the provided timestamp, we return the table snapshot at that version.
• Else, we return the latest commit version with a timestamp less than the provided one.
• If the provided timestamp is less than the timestamp of any committed version, we throw an error.
• If the provided timestamp is after (strictly greater than) the timestamp of the latest version of the table, we throw an error

.

Parameters:

engine - Engine instance to use in Delta Kernel.

millisSinceEpochUTC - timestamp to fetch the snapshot for in milliseconds since the unix epoch

Returns:

an instance of Snapshot

Throws:

TableNotFoundException - if the table is not found

KernelException - if the provided timestamp is before the earliest available version or after the latest available version

Since:

3.2.0

createTransactionBuilder

TransactionBuilder createTransactionBuilder(Engine engine,
                                            String engineInfo,
                                            Operation operation)

Create a TransactionBuilder which can create a Transaction object to mutate the table.

Parameters:

engine - Engine instance to use.

engineInfo - information about the engine that is making the updates.

operation - metadata of operation that is being performed. E.g. "insert", "delete".

Returns:

TransactionBuilder instance to build the transaction.

Since:

3.2.0

checkpoint

void checkpoint(Engine engine,
                long version)
         throws TableNotFoundException,
                CheckpointAlreadyExistsException,
                java.io.IOException

Checkpoint the table at given version. It writes a single checkpoint file.

Parameters:

engine - Engine instance to use.

version - Version to checkpoint.

Throws:

TableNotFoundException - if the table is not found

CheckpointAlreadyExistsException - if a checkpoint already exists at the given version

java.io.IOException - for any I/O error.

Since:

3.2.0