Package io.deephaven.enterprise.merge.impl.deephaven

Interface DeephavenMergeOptions.Builder

Enclosing class:

DeephavenMergeOptions

public static interface DeephavenMergeOptions.Builder

Method Summary

Modifier and Type	Method	Description
DeephavenMergeOptions.Builder	baseOptions(@NotNull BaseMergeOptions baseOptions)	Set the base options for this merge request.
DeephavenMergeOptions	build()	Generates the DeephavenMergeOptions based on the inputs to this DeephavenMergeOptions.Builder instance.
DeephavenMergeOptions.Builder	force(boolean force)	Specify whether this merge request to overwrite a pre-existing partition on disk.
DeephavenMergeOptions.Builder	lowHeapMode(boolean lowHeap)	Specify whether this merge request should attempt to run in low-heap mode.
DeephavenMergeOptions.Builder	mergeRoot(@NotNull String mergeRoot)	Set an alternative destination for this merge request.
DeephavenMergeOptions.Builder	metadataIndexType(@NotNull DeephavenMergeOptions.IndexOptions indexType)	Set the DeephavenMergeOptions.IndexOptions for this merge request.
DeephavenMergeOptions.Builder	storageFormat(@NotNull DeephavenMergeOptions.StorageFormat storageFormat)	Define the desired DeephavenMergeOptions.StorageFormat for the output.
DeephavenMergeOptions.Builder	writablePartitionFilter(@NotNull WritablePartitionFilter writablePartitionFilter)	Allows the removal of specific target internal-partitions.
DeephavenMergeOptions.Builder	writeThreadPoolSize(int threads)	Set the number of write threads to use for merge.

Method Details

baseOptions

@ScriptApi
DeephavenMergeOptions.Builder baseOptions(@NotNull
 @NotNull BaseMergeOptions baseOptions)

Set the base options for this merge request.

Parameters:

baseOptions - the base options for this merge request.

Returns:

this DeephavenMergeOptions.Builder

storageFormat

@ScriptApi
DeephavenMergeOptions.Builder storageFormat(@NotNull
 @NotNull DeephavenMergeOptions.StorageFormat storageFormat)

Define the desired DeephavenMergeOptions.StorageFormat for the output.

Parameters:

storageFormat - the desired StorageFormat, which may override the schema-defined format.

Returns:

this DeephavenMergeOptions.Builder

mergeRoot

@ScriptApi
DeephavenMergeOptions.Builder mergeRoot(@NotNull
 @NotNull String mergeRoot)

Set an alternative destination for this merge request.

Parameters:

mergeRoot - the desired target for this merge request.

Returns:

this DeephavenMergeOptions.Builder

metadataIndexType

@ScriptApi
DeephavenMergeOptions.Builder metadataIndexType(@NotNull
 @NotNull DeephavenMergeOptions.IndexOptions indexType)

Set the DeephavenMergeOptions.IndexOptions for this merge request. Defaults to DeephavenMergeOptions.IndexOptions.ADDITIVE.

Parameters:

indexType - the desired IndexOptions

Returns:

this DeephavenMergeOptions.Builder

writablePartitionFilter

@ScriptApi
DeephavenMergeOptions.Builder writablePartitionFilter(@NotNull
 @NotNull WritablePartitionFilter writablePartitionFilter)

Allows the removal of specific target internal-partitions.

Parameters:

writablePartitionFilter - an instantiated implementation of WritablePartitionFilter.

Returns:

this DeephavenMergeOptions.Builder

lowHeapMode

@ScriptApi
DeephavenMergeOptions.Builder lowHeapMode(boolean lowHeap)

Specify whether this merge request should attempt to run in low-heap mode.

Parameters:

lowHeap - whether or not this merge request should attempt to run in low-heap mode.

Returns:

this DeephavenMergeOptions.Builder

writeThreadPoolSize

@ScriptApi
DeephavenMergeOptions.Builder writeThreadPoolSize(int threads)

Set the number of write threads to use for merge. Defaults to the value of the property `MergeParameters.defaultThreadPoolSize` or `iris.concurrentWriteThreads`, which default to 1

Parameters:

threads - the number of threads to concurrently write column-data

Returns:

this DeephavenMergeOptions.Builder

force

@ScriptApi
DeephavenMergeOptions.Builder force(boolean force)

Specify whether this merge request to overwrite a pre-existing partition on disk. False by default.

Parameters:

force - whether or not this merge request may overwrite a pre-existing partition.

Returns:

this DeephavenMergeOptions.Builder

build

DeephavenMergeOptions build()

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

Returns:

an immutable instance of DeephavenMergeOptions