org.apache.flink.connector.mongodb.source.enumerator.splitter

Enum PartitionStrategy

java.lang.Object

java.lang.Enum<PartitionStrategy>

org.apache.flink.connector.mongodb.source.enumerator.splitter.PartitionStrategy

All Implemented Interfaces:

Serializable, Comparable<PartitionStrategy>, org.apache.flink.configuration.DescribedEnum

@PublicEvolving
public enum PartitionStrategy
extends Enum<PartitionStrategy>
implements org.apache.flink.configuration.DescribedEnum

Partition strategies that can be chosen. Available strategies are single, sample, split-vector, sharded and default.

• single: treats the entire collection as a single partition.
• sample: samples the collection and generate partitions which is fast but possibly uneven.
• split-vector: uses the splitVector command to generate partitions for non-sharded collections which is fast and even. The splitVector permission is required.
• sharded: reads config.chunks (MongoDB splits a sharded collection into chunks, and the range of the chunks are stored within the collection) as the partitions directly. The sharded strategy only used for sharded collection which is fast and even. Read permission of config database is required.
• default: uses sharded strategy for sharded collections otherwise using split vector strategy.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT
PAGINATION
SAMPLE
SHARDED
SINGLE
SPLIT_VECTOR

Method Summary

Modifier and Type	Method and Description
org.apache.flink.configuration.description.InlineElement	getDescription()
String	toString()
static PartitionStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static PartitionStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SINGLE

public static final PartitionStrategy SINGLE

SAMPLE

public static final PartitionStrategy SAMPLE

SPLIT_VECTOR

public static final PartitionStrategy SPLIT_VECTOR

SHARDED

public static final PartitionStrategy SHARDED

PAGINATION

public static final PartitionStrategy PAGINATION

DEFAULT

public static final PartitionStrategy DEFAULT

Method Detail

values

public static PartitionStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PartitionStrategy c : PartitionStrategy.values())
    System.out.println(c);

Returns:

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

valueOf

public static PartitionStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getDescription

public org.apache.flink.configuration.description.InlineElement getDescription()

Specified by:

getDescription in interface org.apache.flink.configuration.DescribedEnum

toString

public String toString()

Overrides:

toString in class Enum<PartitionStrategy>