Package io.deephaven.iceberg.util

Class IcebergInstructions

java.lang.Object

io.deephaven.iceberg.util.IcebergInstructions

@Immutable
public abstract class IcebergInstructions
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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IcebergInstructions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final IcebergInstructions	DEFAULT	The default IcebergInstructions to use when reading Iceberg data files.

Constructor Summary

Constructors

Constructor	Description
IcebergInstructions()

Method Summary

Modifier and Type	Method	Description
static IcebergInstructions.Builder	builder()
abstract Map<String,String>	columnRenames()	A map of rename instructions from Iceberg to Deephaven column names to use when reading the Iceberg data files.
abstract Optional<Object>	dataInstructions()	The data instructions to use for reading the Iceberg data files (might be S3Instructions or other cloud provider-specific instructions).
abstract Optional<TableDefinition>	tableDefinition()	The TableDefinition to use when reading Iceberg data files.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final IcebergInstructions DEFAULT

The default IcebergInstructions to use when reading Iceberg data files. Providing this will use system defaults for cloud provider-specific parameters

Constructor Details

IcebergInstructions

public IcebergInstructions()

Method Details

builder

public static IcebergInstructions.Builder builder()

tableDefinition

public abstract Optional<TableDefinition> tableDefinition()

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).

columnRenames

public abstract Map<String,String> columnRenames()

A map of rename instructions from Iceberg to Deephaven column names to use when reading the Iceberg data files.