Package io.deephaven.iceberg.util

Class IcebergReadInstructions

java.lang.Object
io.deephaven.iceberg.util.IcebergReadInstructions
@Immutable public abstract class IcebergReadInstructions extends Object
This class provides instructions intended for reading Iceberg catalogs and tables. The default values documented in this class may change in the future. As such, callers may wish to explicitly set the values.

  • Field Details

  • Constructor Details

    • IcebergReadInstructions

      public IcebergReadInstructions()

  • Method Details

    • builder

      public static IcebergReadInstructions.Builder builder()

    • tableDefinition

      @Deprecated public final Optional<TableDefinition> tableDefinition()
      Deprecated.
      The TableDefinition to use when reading Iceberg data files.

    • dataInstructions

      public abstract Optional<Object> dataInstructions()
      The data instructions to use for reading the Iceberg data files (might be S3Instructions or other cloud provider-specific instructions). If not provided, data instructions will be derived from the properties of the catalog.

    • columnRenames

      @Deprecated public final Map<String,String> columnRenames()
      Deprecated.
      A map of rename instructions from Iceberg to Deephaven column names to use when reading the Iceberg data files.

    • withColumnRenames

      @Deprecated public final IcebergReadInstructions withColumnRenames(Map<String,? extends String> entries)
      Deprecated.
      Return a copy of this instructions object with the column renames replaced by entries.

    • updateMode

      @Default public IcebergUpdateMode updateMode()
      The IcebergUpdateMode mode to use when reading the Iceberg data files. Default is IcebergUpdateMode.staticMode().

    • snapshotId

      public abstract OptionalLong snapshotId()
      The identifier of the snapshot to load for reading. If both this and snapshot() are provided, the Snapshot.snapshotId() should match this. Otherwise, only one of them should be provided. If neither is provided, the latest snapshot will be loaded.

    • withSnapshotId

      public abstract IcebergReadInstructions withSnapshotId(long value)
      Return a copy of this instructions object with the snapshot ID replaced by value.

    • snapshot

      public abstract Optional<org.apache.iceberg.Snapshot> snapshot()
      The snapshot to load for reading. If both this and snapshotId() are provided, the Snapshot.snapshotId() should match the snapshotId(). Otherwise, only one of them should be provided. If neither is provided, the latest snapshot will be loaded.

    • withSnapshot

      public abstract IcebergReadInstructions withSnapshot(org.apache.iceberg.Snapshot value)
      Return a copy of this instructions object with the snapshot replaced by value.

    • ignoreResolvingErrors

      @Default public boolean ignoreResolvingErrors()
      Controls whether to ignore unexpected resolving errors by silently returning null data for columns that can't be resolved in DataFile where they should be present. These errors may be a sign of an incorrect Resolver or NameMapping; or an Iceberg metadata / data issue. By default, is false.