Package io.deephaven.iceberg.util

Class IcebergTableAdapter

java.lang.Object
io.deephaven.iceberg.util.IcebergTableAdapter
public final class IcebergTableAdapter extends Object
This class manages an Iceberg table and provides methods to interact with it.

  • Constructor Details

    • IcebergTableAdapter

      public IcebergTableAdapter(org.apache.iceberg.catalog.Catalog catalog, org.apache.iceberg.catalog.TableIdentifier tableIdentifier, org.apache.iceberg.Table table, DataInstructionsProviderLoader dataInstructionsProviderLoader, Resolver resolver, org.apache.iceberg.mapping.NameMapping nameMapping)

  • Method Details

    • catalog

      public org.apache.iceberg.catalog.Catalog catalog()
      Catalog used to access this table.

    • tableIdentifier

      public org.apache.iceberg.catalog.TableIdentifier tableIdentifier()
      Get the Iceberg table identifier.

    • resolver

      public Resolver resolver()
      The resolver.

    • currentSnapshot

      public org.apache.iceberg.Snapshot currentSnapshot()
      Get the current snapshot of a given Iceberg table or null if there are no snapshots.
      Returns:
      The current snapshot of the table or null if there are no snapshots.

    • listSnapshots

      public List<org.apache.iceberg.Snapshot> listSnapshots()
      Get the current list of all snapshots of the Iceberg table.
      Returns:
      A list of all snapshots of the given table.

    • snapshots

      public Table snapshots()
      List all snapshots of a given Iceberg table as a Deephaven table. The resulting table will be static and contain the following columns:
      Column Name Description
      Id The snapshot identifier (can be used for updating the table or loading a specific snapshot)
      Timestamp The timestamp of the snapshot
      Operation The data operation that created this snapshot
      Summary Additional information about the snapshot from the Iceberg metadata
      SnapshotObject A Java object containing the Iceberg API snapshot
      Returns:
      A Table containing a list of all tables in the given namespace.

    • currentSchema

      public org.apache.iceberg.Schema currentSchema()
      Retrieve the current schema of an Iceberg table.

    • schemas

      public Map<Integer,org.apache.iceberg.Schema> schemas()
      Retrieve the current schema of an Iceberg table.

    • schema

      public Optional<org.apache.iceberg.Schema> schema(int schemaId)
      Retrieve a specific schema of an Iceberg table.
      Parameters:
      schemaId - The identifier of the schema to load.

    • getSnapshot

      @InternalUseOnly @Nullable public @Nullable org.apache.iceberg.Snapshot getSnapshot(@NotNull @NotNull IcebergReadInstructions readInstructions)
      Retrieves the appropriate Snapshot based on the provided IcebergReadInstructions, or null if no snapshot or snapshotId is provided.

    • definition

      public TableDefinition definition()
      The Table definition for this Iceberg table.
      Returns:
      The table definition

    • definition

      @Deprecated public TableDefinition definition(@NotNull @NotNull IcebergReadInstructions readInstructions)
      Deprecated.
      use definition()
      The Table definition for this Iceberg table.
      Parameters:
      readInstructions - The instructions for customizations while reading the table.
      Returns:
      The table definition

    • definitionTable

      public Table definitionTable()
      The metadata Table for this Iceberg table.
      Returns:
      The table definition as a Deephaven table
      See Also:

    • definitionTable

      @Deprecated public Table definitionTable(IcebergReadInstructions readInstructions)
      Deprecated.
      use definitionTable()
      The metadata Table for this Iceberg table.
      Parameters:
      readInstructions - The instructions for customizations while reading the table.
      Returns:
      The table definition as a Deephaven table

    • table

      public IcebergTable table()
      Read the latest snapshot of this Iceberg table from the Iceberg catalog as a Deephaven table using default read instructions.

      Equivalent to table(IcebergReadInstructions.DEFAULT).

      Returns:
      The loaded table
      See Also:

    • table

      public IcebergTable table(@NotNull @NotNull IcebergReadInstructions readInstructions)
      Read this Iceberg table from the Iceberg catalog as a Deephaven table using readInstructions.
      Parameters:
      readInstructions - The instructions for customizations while reading the table.
      Returns:
      The loaded table

    • refresh

      public void refresh()
      Refresh the table with the latest information from the Iceberg catalog, including new snapshots and schema.

    • icebergTable

      public org.apache.iceberg.Table icebergTable()
      Return the underlying Iceberg table.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • tableWriter

      public IcebergTableWriter tableWriter(TableWriterOptions tableWriterOptions)
      Create a new IcebergTableWriter for this Iceberg table using the provided TableWriterOptions.

      This method will perform schema validation to ensure that the provided TableWriterOptions.tableDefinition() is compatible with the Iceberg table schema. All further writes performed by the returned writer will not be validated against the table's schema, and thus will be faster.

      Parameters:
      tableWriterOptions - The options to configure the table writer.
      Returns:
      A new instance of IcebergTableWriter configured with the provided options.

    • locationUri

      public URI locationUri()
      Get the location URI of the Iceberg table.

    • table

      @InternalUseOnly public IcebergTable table(@NotNull @NotNull TableKey tableKey, @NotNull @NotNull IcebergReadInstructions readInstructions)

    • provider

      @InternalUseOnly public IcebergTableLocationProviderBase<TableKey,IcebergTableLocationKey> provider(@NotNull @NotNull TableKey tableKey, @NotNull @NotNull IcebergReadInstructions readInstructions)