Package io.deephaven.enterprise.merge.impl

Enum Class PartitioningFormulaHelpers.FormulaSubstitutions

java.lang.Object

java.lang.Enum<PartitioningFormulaHelpers.FormulaSubstitutions>

io.deephaven.enterprise.merge.impl.PartitioningFormulaHelpers.FormulaSubstitutions

All Implemented Interfaces:

Serializable, Comparable<PartitioningFormulaHelpers.FormulaSubstitutions>, java.lang.constant.Constable

Enclosing class:

PartitioningFormulaHelpers

public static enum PartitioningFormulaHelpers.FormulaSubstitutions
extends Enum<PartitioningFormulaHelpers.FormulaSubstitutions>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_GROUPING_COLUMNS	An array of strings representing the names of the grouping columns (i.e., column definitions with the attribute `columnType="Grouping"`).
AUTOBALANCE_BY_ALL_GROUPING_COLUMNS	A complete formula that uses all grouping columns (if there are any) in order to spread data across all available partitions, attempting to achieve balanced partition usage over long time horizons.
AUTOBALANCE_BY_FIRST_GROUPING_COLUMN	A complete formula that uses the first grouping column (if there is one) in order to spread data across all available partitions, attempting to achieve balanced partition usage over long time horizons.
AUTOBALANCE_SINGLE	A complete formula that chooses a single partition for all input data, attempting to achieve balanced partition usage over long time horizons.
FIRST_GROUPING_COLUMN	A string representing the name of the first grouping column (i.e., the first column definition with the attribute `columnType="Grouping"`).

Method Summary

Modifier and Type	Method	Description
static String	applyAll(String partitioningFormula, @NotNull String[] groupingColumnNames)
String	getFormulaToken()
static PartitioningFormulaHelpers.FormulaSubstitutions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PartitioningFormulaHelpers.FormulaSubstitutions[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTOBALANCE_SINGLE

public static final PartitioningFormulaHelpers.FormulaSubstitutions AUTOBALANCE_SINGLE

A complete formula that chooses a single partition for all input data, attempting to achieve balanced partition usage over long time horizons. The preferred way to write a formula that only refers to the `__PARTITION_AUTOBALANCE_SINGLE__` query scope parameter.

AUTOBALANCE_BY_FIRST_GROUPING_COLUMN

public static final PartitioningFormulaHelpers.FormulaSubstitutions AUTOBALANCE_BY_FIRST_GROUPING_COLUMN

A complete formula that uses the first grouping column (if there is one) in order to spread data across all available partitions, attempting to achieve balanced partition usage over long time horizons. Assuming the first grouping column is the most significant, keeps all grouped data together. Falls back to the same behavior as `${autobalance_single}` if there are no grouping columns.

AUTOBALANCE_BY_ALL_GROUPING_COLUMNS

public static final PartitioningFormulaHelpers.FormulaSubstitutions AUTOBALANCE_BY_ALL_GROUPING_COLUMNS

A complete formula that uses all grouping columns (if there are any) in order to spread data across all available partitions, attempting to achieve balanced partition usage over long time horizons. Effectively spreads grouped data across multiple partitions, which may be useful for queries. Falls back to the same behavior as `${autobalance_single}` if there are no grouping columns.

FIRST_GROUPING_COLUMN

public static final PartitioningFormulaHelpers.FormulaSubstitutions FIRST_GROUPING_COLUMN

A string representing the name of the first grouping column (i.e., the first column definition with the attribute `columnType="Grouping"`). Only available if there are grouping columns.

ALL_GROUPING_COLUMNS

public static final PartitioningFormulaHelpers.FormulaSubstitutions ALL_GROUPING_COLUMNS

An array of strings representing the names of the grouping columns (i.e., column definitions with the attribute `columnType="Grouping"`). Only available if there are grouping columns.

Method Details

values

public static PartitioningFormulaHelpers.FormulaSubstitutions[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PartitioningFormulaHelpers.FormulaSubstitutions valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

applyAll

public static String applyAll(String partitioningFormula,
 @NotNull
 @NotNull String[] groupingColumnNames)

getFormulaToken

public String getFormulaToken()