Package org.apache.flink.table.catalog

Class TableDistribution

java.lang.Object

org.apache.flink.table.catalog.TableDistribution

@PublicEvolving
public class TableDistribution
extends Object

Defines whether the given table is distributed across buckets using a specified algorithm and given columns. It represents the DISTRIBUTED BY clause in SQL.

See Also:

• SupportsBucketing

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TableDistribution.Kind	Distribution kind.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Optional<Integer>	getBucketCount()
List<String>	getBucketKeys()
TableDistribution.Kind	getKind()
int	hashCode()
static TableDistribution	of(TableDistribution.Kind kind, Integer bucketCount, List<String> bucketKeys)	Distribution of the given kind over the given keys with a declared number of buckets.
static TableDistribution	ofHash(List<String> bucketKeys, Integer bucketCount)	Hash distribution over the given keys among the declared number of buckets.
static TableDistribution	ofRange(List<String> bucketKeys, Integer bucketCount)	Range distribution over the given keys among the declared number of buckets.
static TableDistribution	ofUnknown(int bucketCount)	Connector-dependent distribution with a declared number of buckets.
static TableDistribution	ofUnknown(List<String> bucketKeys, Integer bucketCount)	Connector-dependent distribution with a declared number of buckets.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

of

public static TableDistribution of(TableDistribution.Kind kind,
 @Nullable
 Integer bucketCount,
 List<String> bucketKeys)

Distribution of the given kind over the given keys with a declared number of buckets.

ofUnknown

public static TableDistribution ofUnknown(int bucketCount)

Connector-dependent distribution with a declared number of buckets.

ofUnknown

public static TableDistribution ofUnknown(List<String> bucketKeys,
 @Nullable
 Integer bucketCount)

Connector-dependent distribution with a declared number of buckets.

ofHash

public static TableDistribution ofHash(List<String> bucketKeys,
 @Nullable
 Integer bucketCount)

Hash distribution over the given keys among the declared number of buckets.

ofRange

public static TableDistribution ofRange(List<String> bucketKeys,
 @Nullable
 Integer bucketCount)

Range distribution over the given keys among the declared number of buckets.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getKind

public TableDistribution.Kind getKind()

getBucketKeys

public List<String> getBucketKeys()

getBucketCount

public Optional<Integer> getBucketCount()

toString

public String toString()

Overrides:

toString in class Object