Package io.deephaven.iceberg.util

Class Resolver

java.lang.Object

io.deephaven.iceberg.util.Resolver

@Immutable
public abstract class Resolver
extends Object

The relationship between a Deephaven TableDefinition and an Iceberg Schema.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Resolver.Builder
static class	Resolver.MappingException

Constructor Summary

Constructors

Constructor	Description
Resolver()

Method Summary

Modifier and Type	Method	Description
static Resolver.Builder	builder()
abstract Map<String,ColumnInstructions>	columnInstructions()	The column instructions keyed by Deephaven column name from the definition.
abstract TableDefinition	definition()	The Deephaven table definition.
static Resolver	infer(InferenceInstructions inferenceInstructions)	Infer a resolver based on the inferenceInstructions.
static Resolver	infer(org.apache.iceberg.Schema schema)	Infer a resolver based on the default inference instructions for schema.
final Optional<List<org.apache.iceberg.types.Types.NestedField>>	resolve(String columnName)	Get the field path associated with the Deephaven columnName.
abstract org.apache.iceberg.Schema	schema()	The Iceberg schema.
abstract Optional<org.apache.iceberg.PartitionSpec>	spec()	The Iceberg partition specification.

Methods inherited from class java.lang.Object

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

Constructor Details

Resolver

public Resolver()

Method Details

builder

public static Resolver.Builder builder()

infer

public static Resolver infer(org.apache.iceberg.Schema schema)
                      throws TypeInference.UnsupportedType

Infer a resolver based on the default inference instructions for schema.

Equivalent to infer(InferenceInstructions.of(schema)).

Parameters:

schema - the schema to use for inference

Returns:

the resolver

Throws:

TypeInference.UnsupportedType - if an unsupported type is encountered

See Also:

• infer(InferenceInstructions)

infer

public static Resolver infer(InferenceInstructions inferenceInstructions)
                      throws TypeInference.UnsupportedType

Infer a resolver based on the inferenceInstructions.

Parameters:

inferenceInstructions - the inference instructions

Returns:

the resolver

Throws:

TypeInference.UnsupportedType - if an unsupported type is encountered

definition

public abstract TableDefinition definition()

The Deephaven table definition. Every column of this definition must be mapped via columnInstructions().

Callers should take care and only use Partitioning columns when they know the Iceberg table will always have identity partitions for said columns. In the general case, Iceberg partitions may evolve over time, which can break the assumptions Deephaven makes about partitioning columns.

schema

public abstract org.apache.iceberg.Schema schema()

The Iceberg schema.

spec

public abstract Optional<org.apache.iceberg.PartitionSpec> spec()

The Iceberg partition specification. Only necessary to set when the definition() has ColumnDefinition.ColumnType.Partitioning columns, or columnInstructions() references partition fields.

See Also:

• for related warnings

columnInstructions

public abstract Map<String,ColumnInstructions> columnInstructions()

The column instructions keyed by Deephaven column name from the definition. Normal columns must reference a schema field, schema field name, or be unmapped; and partitioning columns must reference a schema field, schema field name, or partition field.

The definition() and schema() types must be TypeCompatibility.isCompatible(Type, org.apache.iceberg.types.Type).

resolve

public final Optional<List<org.apache.iceberg.types.Types.NestedField>> resolve(String columnName)

Get the field path associated with the Deephaven columnName. Will return empty when the column name is not in columnInstructions(), and a result otherwise.

Parameters:

columnName - the column name

Returns:

the field path