Package io.deephaven.enterprise.merge

Interface BaseMergeOptions.Builder

Enclosing class:

BaseMergeOptions

public static interface BaseMergeOptions.Builder

Method Summary

Modifier and Type	Method	Description
default BaseMergeOptions.Builder	addAllSortColumns(@NotNull Iterable<? extends SortColumn> sortColumns)	Set the sort-columns for the merge.
BaseMergeOptions.Builder	addAllSortDirectives(@NotNull Iterable<? extends SortDirective> directives)	Set the sort-directives for the merge.
default BaseMergeOptions.Builder	addAllSortOrder(@NotNull Iterable<String> sortOrder)	Set the sort-order for the merge.
default BaseMergeOptions.Builder	addSortColumns(@NotNull SortColumn... sortColumns)	Set the sort-columns for the merge.
BaseMergeOptions.Builder	addSortDirectives(@NotNull SortDirective... directives)	Set the sort-directives for the merge.
default BaseMergeOptions.Builder	addSortOrder(@NotNull String... sortOrder)	Set the sort-order for the merge.
BaseMergeOptions.Builder	allowEmptyInput(boolean allowEmptyInput)	Specifies if this merge request may be performed using an empty dataset.
BaseMergeOptions	build()	Generates the BaseMergeOptions based on the inputs to this BaseMergeOptions.Builder instance.
BaseMergeOptions.Builder	codecName(@NotNull String codecName)	Set an optional compression codec name for this merge request.
BaseMergeOptions.Builder	namespace(@NotNull String namespace)	Set the namespace to merge into.
default BaseMergeOptions.Builder	partitionFormula(@NotNull String partitionFormula)	Set a valid java formula, which is used to generate a column-partition value to read from for this merge request.
default BaseMergeOptions.Builder	partitionValue(@NotNull String partitionValue)	Set the column-partition value to read from for this merge request.
BaseMergeOptions.Builder	partitionValueProvider(@NotNull PartitionValueProvider provider)	Set the partition value provider.
default BaseMergeOptions.Builder	sourceFromDb(@NotNull Database db)	Use the provided Database along with the target BaseMergeOptions.namespace()/BaseMergeOptions.tableName() to resolve the source table.
default BaseMergeOptions.Builder	sourceFromNamed(@NotNull Database db, @NotNull String sourceNamespace, @NotNull String sourceTableName)	Use the provided Database, namespace and tableName to resolve the source table.
default BaseMergeOptions.Builder	sourceTable(@NotNull Table table)	Set the source table directly.
BaseMergeOptions.Builder	sourceTableProvider(@NotNull SourceTableProvider provider)	Set the source table provider.
BaseMergeOptions.Builder	tableName(@NotNull String tableName)	Set the tableName to merge into.

Method Details

namespace

@ScriptApi
BaseMergeOptions.Builder namespace(@NotNull
 @NotNull String namespace)

Set the namespace to merge into.

Parameters:

namespace - the namespace.

Returns:

this BaseMergeOptions.Builder

tableName

@ScriptApi
BaseMergeOptions.Builder tableName(@NotNull
 @NotNull String tableName)

Set the tableName to merge into.

Parameters:

tableName - the namespace.

Returns:

this BaseMergeOptions.Builder

sourceTableProvider

@InternalUseOnly
BaseMergeOptions.Builder sourceTableProvider(@NotNull
 @NotNull SourceTableProvider provider)

Set the source table provider.

Parameters:

provider - the source table provider.

Returns:

this BaseMergeOptions.Builder

sourceTable

@ScriptApi
default BaseMergeOptions.Builder sourceTable(@NotNull
 @NotNull Table table)

Set the source table directly.

Parameters:

table - the source table.

Returns:

this BaseMergeOptions.Builder

sourceFromDb

@ScriptApi
default BaseMergeOptions.Builder sourceFromDb(@NotNull
 @NotNull Database db)

Use the provided Database along with the target BaseMergeOptions.namespace()/BaseMergeOptions.tableName() to resolve the source table.

Parameters:

db - the database to use to resolve the source table.

Returns:

this BaseMergeOptions.Builder

sourceFromNamed

@ScriptApi
default BaseMergeOptions.Builder sourceFromNamed(@NotNull
 @NotNull Database db,
 @NotNull
 @NotNull String sourceNamespace,
 @NotNull
 @NotNull String sourceTableName)

Use the provided Database, namespace and tableName to resolve the source table.

Parameters:

db - the database to use to resolve the source table.

sourceNamespace - the namespace of the source table.

sourceTableName - the tableName of the source table.

Returns:

this BaseMergeOptions.Builder

allowEmptyInput

@ScriptApi
BaseMergeOptions.Builder allowEmptyInput(boolean allowEmptyInput)

Specifies if this merge request may be performed using an empty dataset. False by default.

Parameters:

allowEmptyInput - whether or not this merge request may use an empty dataset.

Returns:

this BaseMergeOptions.Builder

addAllSortOrder

@ScriptApi
default BaseMergeOptions.Builder addAllSortOrder(@NotNull
 @NotNull Iterable<String> sortOrder)

Set the sort-order for the merge. Columns may include grouping-columns, but please note that ordering is done per internal-partition. Each column included in this call will be appended as an ascending-order sort.

Parameters:

sortOrder - the desired sort-ordering for the merge.

Returns:

this BaseMergeOptions.Builder

addSortOrder

@ScriptApi
default BaseMergeOptions.Builder addSortOrder(@NotNull
 @NotNull String... sortOrder)

Set the sort-order for the merge. Columns may include grouping-columns, but please note that ordering is done per internal-partition. Each column included in this call will be appended as an ascending-order sort.

Parameters:

sortOrder - the desired sort-ordering for the merge.

Returns:

this BaseMergeOptions.Builder

addAllSortColumns

@ScriptApi
default BaseMergeOptions.Builder addAllSortColumns(@NotNull
 @NotNull Iterable<? extends SortColumn> sortColumns)

Set the sort-columns for the merge. Columns may include grouping-columns, but please note that ordering is done per internal-partition.

Parameters:

sortColumns - the desired sort-ordering for the merge.

Returns:

this BaseMergeOptions.Builder

addSortColumns

@ScriptApi
default BaseMergeOptions.Builder addSortColumns(@NotNull
 @NotNull SortColumn... sortColumns)

Set the sort-columns for the merge. Columns may include grouping-columns, but please note that ordering is done per internal-partition.

Parameters:

sortColumns - the desired sort-ordering for the merge.

Returns:

this BaseMergeOptions.Builder

addSortDirectives

@ScriptApi
BaseMergeOptions.Builder addSortDirectives(@NotNull
 @NotNull SortDirective... directives)

Set the sort-directives for the merge. Please note that ordering is done per internal-partition.

Parameters:

directives - the desired sort-directives for the merge.

Returns:

this BaseMergeOptions.Builder

addAllSortDirectives

@ScriptApi
BaseMergeOptions.Builder addAllSortDirectives(@NotNull
 @NotNull Iterable<? extends SortDirective> directives)

Set the sort-directives for the merge. Please note that ordering is done per internal-partition.

Parameters:

directives - the desired sort-directives for the merge.

Returns:

this BaseMergeOptions.Builder

codecName

@ScriptApi
BaseMergeOptions.Builder codecName(@NotNull
 @NotNull String codecName)

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

Parameters:

codecName - the name of the desired codec.

Returns:

this BaseMergeOptions.Builder

partitionValueProvider

@InternalUseOnly
BaseMergeOptions.Builder partitionValueProvider(@NotNull
 @NotNull PartitionValueProvider provider)

Set the partition value provider.

Parameters:

provider - the partition table provider.

Returns:

this BaseMergeOptions.Builder

partitionValue

@ScriptApi
default BaseMergeOptions.Builder partitionValue(@NotNull
 @NotNull String partitionValue)

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

Parameters:

partitionValue - the value to use as the partition.

Returns:

this BaseMergeOptions.Builder

partitionFormula

@ScriptApi
default BaseMergeOptions.Builder partitionFormula(@NotNull
 @NotNull String partitionFormula)

Set a valid java formula, which is used to generate a 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.

Parameters:

partitionFormula - the java formula used to generate the partition value.

Returns:

this BaseMergeOptions.Builder

build

BaseMergeOptions build()

Generates the BaseMergeOptions based on the inputs to this BaseMergeOptions.Builder instance.

Returns:

an immutable instance of BaseMergeOptions