Package com.illumon.iris.importers.util

Interface MergeParameters.Builder

Enclosing interface:

MergeParameters

public static interface MergeParameters.Builder

A Builder for constructing a MergeParameters

Method Summary

Modifier and Type	Method	Description
MergeParameters.Builder	allowEmptyInput(boolean allowEmptyInput)	Set if the input table is allowed to be empty.
MergeParameters	build()	Construct a new MergeParameters from this builder state.
MergeParameters.Builder	codecName(String codecName)	Set the compression codec name to be used when merging into Database.StorageFormat.Parquet.
MergeParameters.Builder	db(Database db)	Set the database to use.
MergeParameters.Builder	force(boolean force)	Sets if the merge should overwrite existing data.
MergeParameters.Builder	lateCleanup(boolean lateCleanup)	Set if late cleanup should be used.
MergeParameters.Builder	logger(com.fishlib.io.logger.Logger logger)	Set a logger to use.
MergeParameters.Builder	lowHeapUsage(boolean lowHeapUsage)	Set low heap usage mode.
MergeParameters.Builder	maximumConcurrentColumns(int maxConcurrentColumns)	Set the maximum number of columns that may be concurrently written.
MergeParameters.Builder	namespace(String namespace)	Set the namespace to merge into.
default MergeParameters.Builder	parseArgs(String[] args)
MergeParameters.Builder	partitionColumnFormula(String partitionColumnFormula)	Set the partition formula.
MergeParameters.Builder	partitionColumnValue(String partitionColumnValue)	Set the partition value.
MergeParameters.Builder	sortColumnFormula(String sortColumnFormula)	Set the sorting column formula.
MergeParameters.Builder	sourceTable(Table table)	Set the source table of the data.
MergeParameters.Builder	storageFormat(Database.StorageFormat storageFormat)	Set the Database.StorageFormat to merge to.
default MergeParameters.Builder	storageFormat(String formatName)	Set the Database.StorageFormat to merge to.
MergeParameters.Builder	syncMode(SyncMode syncMode)	Set the SyncMode.
default MergeParameters.Builder	syncMode(String modeName)	Set the SyncMode.
MergeParameters.Builder	tableName(String tableName)	The name of the table to merge into.
MergeParameters.Builder	tdsName(String tdsName)	Set the Table data service name to use for fetching data.
MergeParameters.Builder	threadPoolSize(int size)	The thread pool size for the merge.

Method Details

build

MergeParameters build()

Construct a new MergeParameters from this builder state.

Returns:

a new MergeParameters

logger

@NotNull
MergeParameters.Builder logger(@NotNull
 com.fishlib.io.logger.Logger logger)

Set a logger to use. This may be omitted to use the default logger.

Parameters:

logger - the logger

Returns:

this MergeParameters.Builder

db

@NotNull
MergeParameters.Builder db(@NotNull
 Database db)

Set the database to use. This may be omitted for certain types of merges.

Parameters:

db - the database

Returns:

this MergeParameters.Builder

tdsName

@NotNull
MergeParameters.Builder tdsName(@NotNull
 String tdsName)

Set the Table data service name to use for fetching data.

Parameters:

tdsName - the tds name

Returns:

this MergeParameters.Builder

namespace

@NotNull
MergeParameters.Builder namespace(@NotNull
 String namespace)

Set the namespace to merge into. If no source table is supplied this is also the namespace of the source Table.

Parameters:

namespace - the namespace.

Returns:

this MergeParameters.Builder

tableName

@NotNull
MergeParameters.Builder tableName(@NotNull
 String tableName)

The name of the table to merge into. If no source table is specified this is also the table name of the source Table. 9

Parameters:

tableName - the table name

Returns:

this MergeParameters.Builder

partitionColumnValue

@NotNull
MergeParameters.Builder partitionColumnValue(@NotNull
 String partitionColumnValue)

Set the partition value. Only one of this or partitionColumnFormula(String) may be called. 9

Parameters:

partitionColumnValue - the partition column value

Returns:

this MergeParameters.Builder

partitionColumnFormula

@NotNull
MergeParameters.Builder partitionColumnFormula(@NotNull
 String partitionColumnFormula)

Set the partition formula. Only one of this or partitionColumnValue(String) (String)} may be called.

Parameters:

partitionColumnFormula - the partition column value

Returns:

this MergeParameters.Builder

maximumConcurrentColumns

@NotNull
MergeParameters.Builder maximumConcurrentColumns(int maxConcurrentColumns)

Set the maximum number of columns that may be concurrently written.

Parameters:

maxConcurrentColumns - the maximum number of concurrently written columns

Returns:

this MergeParameters.Builder

lowHeapUsage

@NotNull
MergeParameters.Builder lowHeapUsage(boolean lowHeapUsage)

Set low heap usage mode. In this mode the merge will be performed on a single thread using as few heap resources as possible.

Parameters:

lowHeapUsage - true if low heap usage mode should be used

Returns:

this MergeParameters.Builder

force

@NotNull
MergeParameters.Builder force(boolean force)

Sets if the merge should overwrite existing data.

Parameters:

force - if existing data should be overwritten

Returns:

this MergeParameters.Builder

lateCleanup

@NotNull
MergeParameters.Builder lateCleanup(boolean lateCleanup)

Set if late cleanup should be used.

Parameters:

lateCleanup - true if late cleanup should be used.

Returns:

this MergeParameters.Builder

allowEmptyInput

@NotNull
MergeParameters.Builder allowEmptyInput(boolean allowEmptyInput)

Set if the input table is allowed to be empty.

Parameters:

allowEmptyInput - true if the input table is allowed to be empty.

Returns:

this MergeParameters.Builder

sortColumnFormula

@NotNull
MergeParameters.Builder sortColumnFormula(@NotNull
 String sortColumnFormula)

Set the sorting column formula.

Parameters:

sortColumnFormula - the sort column formula

Returns:

this MergeParameters.Builder

sourceTable

@NotNull
MergeParameters.Builder sourceTable(Table table)

Set the source table of the data. When set, merge will use this table instead of fetching the data from the values specified by namespace(String) and tableName(String).

Parameters:

table - the source table

Returns:

this MergeParameters.Builder

codecName

@NotNull
MergeParameters.Builder codecName(@NotNull
 String codecName)

Set the compression codec name to be used when merging into Database.StorageFormat.Parquet.

Parameters:

codecName - the compression codec name.

Returns:

this MergeParameters.Builder

threadPoolSize

@NotNull
MergeParameters.Builder threadPoolSize(int size)

The thread pool size for the merge.

Parameters:

size - the thread pool size

Returns:

this MergeParameters.Builder

syncMode

@NotNull
@FinalDefault
default MergeParameters.Builder syncMode(@NotNull
 String modeName)

Set the SyncMode.

Parameters:

modeName - the SyncMode

Returns:

this MergeParameters.Builder

syncMode

@NotNull
MergeParameters.Builder syncMode(SyncMode syncMode)

Set the SyncMode.

Parameters:

syncMode - the SyncMode

Returns:

this MergeParameters.Builder

storageFormat

@NotNull
@FinalDefault
default MergeParameters.Builder storageFormat(@NotNull
 String formatName)

Set the Database.StorageFormat to merge to. This may be omitted to use the system default format.

Parameters:

formatName - name of the storage format, can be either an exact enum member name or null or one of the "friendly" values defined by the command line merge interfaces.

Returns:

this builder

storageFormat

@NotNull
MergeParameters.Builder storageFormat(@Nullable
 Database.StorageFormat storageFormat)

Set the Database.StorageFormat to merge to. This may be omitted to use the system default format.

Parameters:

storageFormat - the storage format.

Returns:

this MergeParameters.Builder

parseArgs

@NotNull
@FinalDefault
default MergeParameters.Builder parseArgs(String[] args)

Parameters:

args - a command-line style argument vector as documented for the MergeData implementation class "main" methods.

Returns:

this Builder