Package org.apache.flink.table.planner.plan.nodes.exec

Class InputProperty

java.lang.Object

org.apache.flink.table.planner.plan.nodes.exec.InputProperty

@Internal
public class InputProperty
extends Object

The InputProperty describes the input information of the ExecNode.

The input concept is not corresponding to the execution edge, but rather to the Input.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InputProperty.Builder	Builder of the InputProperty.
static enum	InputProperty.DamBehavior	Enumeration which describes how an input record may trigger the output behavior of the target ExecNode.
static enum	InputProperty.DistributionType	Enumeration which describes the type of the input data distribution.
static class	InputProperty.HashDistribution	The input will read the records whose keys hash to a particular hash value.
static class	InputProperty.KeepInputAsIsDistribution	A special distribution which indicators the data distribution is the same as its input. '
static class	InputProperty.RequiredDistribution	The required input data distribution for records when they are read in.

Field Summary

Fields

Modifier and Type	Field	Description
static final InputProperty.RequiredDistribution	ANY_DISTRIBUTION	The input does not require any specific data distribution.
static final InputProperty.RequiredDistribution	BROADCAST_DISTRIBUTION	The input will read all records for each parallelism of the target node.
static final InputProperty	DEFAULT
static final String	FIELD_NAME_DAM_BEHAVIOR
static final String	FIELD_NAME_PRIORITY
static final String	FIELD_NAME_REQUIRED_DISTRIBUTION
static final InputProperty.RequiredDistribution	SINGLETON_DISTRIBUTION	The input will read all records, and the parallelism of the target node must be 1.
static final InputProperty.RequiredDistribution	UNKNOWN_DISTRIBUTION	Returns a place-holder required distribution.

Constructor Summary

Constructors

Constructor	Description
InputProperty(InputProperty.RequiredDistribution requiredDistribution, InputProperty.DamBehavior damBehavior, int priority)

Method Summary

Modifier and Type	Method	Description
static InputProperty.Builder	builder()
boolean	equals(Object o)
InputProperty.DamBehavior	getDamBehavior()
int	getPriority()
InputProperty.RequiredDistribution	getRequiredDistribution()
int	hashCode()
static InputProperty.HashDistribution	hashDistribution(int[] keys)	The input will read the records whose keys hash to a particular hash value.
static InputProperty.KeepInputAsIsDistribution	keepInputAsIsDistribution(InputProperty.RequiredDistribution inputDistribution, boolean strict)	A special distribution which indicators the data distribution is the same as its input.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ANY_DISTRIBUTION

public static final InputProperty.RequiredDistribution ANY_DISTRIBUTION

The input does not require any specific data distribution.

BROADCAST_DISTRIBUTION

public static final InputProperty.RequiredDistribution BROADCAST_DISTRIBUTION

The input will read all records for each parallelism of the target node. All records appear in each parallelism.

SINGLETON_DISTRIBUTION

public static final InputProperty.RequiredDistribution SINGLETON_DISTRIBUTION

The input will read all records, and the parallelism of the target node must be 1.

UNKNOWN_DISTRIBUTION

public static final InputProperty.RequiredDistribution UNKNOWN_DISTRIBUTION

Returns a place-holder required distribution.

Currently InputProperty is only used for deadlock breakup and multi-input in batch mode, so for ExecNodes not affecting the algorithm we use this place-holder.

We should fill out the detailed InputProperty for each sub-class of ExecNode in the future.

DEFAULT

public static final InputProperty DEFAULT

FIELD_NAME_REQUIRED_DISTRIBUTION

public static final String FIELD_NAME_REQUIRED_DISTRIBUTION

See Also:

• Constant Field Values

FIELD_NAME_DAM_BEHAVIOR

public static final String FIELD_NAME_DAM_BEHAVIOR

See Also:

• Constant Field Values

FIELD_NAME_PRIORITY

public static final String FIELD_NAME_PRIORITY

See Also:

• Constant Field Values

Constructor Details

InputProperty

public InputProperty(InputProperty.RequiredDistribution requiredDistribution,
 InputProperty.DamBehavior damBehavior,
 int priority)

Method Details

getRequiredDistribution

public InputProperty.RequiredDistribution getRequiredDistribution()

getDamBehavior

public InputProperty.DamBehavior getDamBehavior()

getPriority

public int getPriority()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static InputProperty.Builder builder()

hashDistribution

public static InputProperty.HashDistribution hashDistribution(int[] keys)

The input will read the records whose keys hash to a particular hash value.

Parameters:

keys - hash keys

keepInputAsIsDistribution

public static InputProperty.KeepInputAsIsDistribution keepInputAsIsDistribution(InputProperty.RequiredDistribution inputDistribution,
 boolean strict)

A special distribution which indicators the data distribution is the same as its input.

Parameters:

inputDistribution - the input distribution

strict - whether the input distribution is strictly guaranteed