Package io.deephaven.iceberg.util

Class IcebergWriteInstructions

java.lang.Object

io.deephaven.iceberg.util.IcebergWriteInstructions

@Immutable
public abstract class IcebergWriteInstructions
extends Object

This class provides instructions intended for writing deephaven tables as partitions to Iceberg tables.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IcebergWriteInstructions.Builder

Constructor Summary

Constructors

Constructor	Description
IcebergWriteInstructions()

Method Summary

Modifier and Type	Method	Description
static IcebergWriteInstructions.Builder	builder()
abstract List<String>	partitionPaths()	The partition paths where each table will be written.
abstract List<Table>	tables()	The Deephaven tables to be written.

Methods inherited from class java.lang.Object

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

Constructor Details

IcebergWriteInstructions

public IcebergWriteInstructions()

Method Details

builder

public static IcebergWriteInstructions.Builder builder()

tables

public abstract List<Table> tables()

The Deephaven tables to be written.

All tables must have the same table definition as definition for non-partitioning columns specified in the IcebergTableWriter. For example, if an iceberg table is partitioned by "year" and "month" and has a non-partitioning column "data," then IcebergTableWriter should be configured with a definition that includes all three columns: "year," "month," and "data." But, the tables provided here should only include the non-partitioning column, such as "data."

partitionPaths

public abstract List<String> partitionPaths()

The partition paths where each table will be written. For example, if the table is partitioned by "year" and "month", the partition path could be "year=2021/month=01".

If writing to a partitioned iceberg table, users must provide partition path for each table in tables() in the same order. Else, this should be an empty list.