Package io.deephaven.enterprise.merge

Class BaseMergeOptions

java.lang.Object

io.deephaven.enterprise.merge.BaseMergeOptions

@Immutable(copy=false)
public abstract class BaseMergeOptions
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BaseMergeOptions.Builder

Constructor Summary

Constructors

Constructor	Description
BaseMergeOptions()

Method Summary

Modifier and Type	Method	Description
boolean	allowEmptyInput()	If the merge request is permitted to execute with an empty input.
static BaseMergeOptions.Builder	builder()
abstract Optional<String>	codecName()	Get an optional compression codec name for this merge request.
abstract String	namespace()	Get the target namespace to merge data into.
Optional<String>	partitionValue()	Get the column-partition value to read from for this merge request.
abstract Optional<PartitionValueProvider>	partitionValueProvider()	Get the partition value provider.
abstract List<SortDirective>	sortDirectives()	Directives used to sort.
Table	sourceTable()	The source Table to merge into the target, resolved according to sourceTableProvider().
abstract String	tableName()	Get the target table name to merge into.

Methods inherited from class java.lang.Object

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

Constructor Details

BaseMergeOptions

public BaseMergeOptions()

Method Details

builder

public static BaseMergeOptions.Builder builder()

namespace

public abstract String namespace()

Get the target namespace to merge data into.

Returns:

the namespace.

tableName

public abstract String tableName()

Get the target table name to merge into.

Returns:

the table name to merge into.

allowEmptyInput

@Default
public boolean allowEmptyInput()

If the merge request is permitted to execute with an empty input.

Returns:

true, if we may run with an empty input, else false.

sortDirectives

@VisibleForTesting
public abstract List<SortDirective> sortDirectives()

Directives used to sort. Please note that sorting is defined per internal partition.

Returns:

the sort directives.

codecName

public abstract Optional<String> codecName()

Get an optional compression codec name for this merge request. This is used when writing to DeephavenMergeOptions.StorageFormat.Parquet or to an Iceberg table.

Returns:

the desired codec name.

sourceTable

@VisibleForTesting
@Lazy
public Table sourceTable()

The source Table to merge into the target, resolved according to sourceTableProvider().

Returns:

the source table.

partitionValueProvider

@InternalUseOnly
public abstract Optional<PartitionValueProvider> partitionValueProvider()

Get the partition value provider.

Returns:

the partition value provider, if set.

partitionValue

@Lazy
public Optional<String> partitionValue()

Get the column-partition value to read from for this merge request. In the case of Deephaven Layout tables, this is also the partition value to write to.

Returns:

the partition value