org.apache.paimon.table

Enum BucketMode

java.lang.Object

java.lang.Enum<BucketMode>

org.apache.paimon.table.BucketMode

All Implemented Interfaces:

Serializable, Comparable<BucketMode>

@Experimental
public enum BucketMode
extends Enum<BucketMode>

Bucket mode of the table, it affects the writing process and also affects the bucket skipping in reading.

Since:

0.9

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUCKET_UNAWARE Ignoring bucket concept, although all data is written to bucket-0, the parallelism of reads and writes is unrestricted.
CROSS_PARTITION The cross partition mode is for cross partition upsert (primary keys not contain all partition fields).
HASH_DYNAMIC The dynamic bucket mode records which bucket the key corresponds to through the index files.
HASH_FIXED The fixed number of buckets configured by the user can only be modified through offline commands.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNAWARE_BUCKET

Method Summary

Modifier and Type	Method and Description
static BucketMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static BucketMode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HASH_FIXED

public static final BucketMode HASH_FIXED

The fixed number of buckets configured by the user can only be modified through offline commands. The data is distributed to the corresponding buckets according to the hash value of bucket key (default is primary key), and the reading end can perform bucket skipping based on the filtering conditions of the bucket key.

HASH_DYNAMIC

public static final BucketMode HASH_DYNAMIC

The dynamic bucket mode records which bucket the key corresponds to through the index files. The index records the correspondence between the hash value of the primary-key and the bucket. This mode cannot support multiple concurrent writes or bucket skipping for reading filter conditions. This mode only works for changelog table.

CROSS_PARTITION

public static final BucketMode CROSS_PARTITION

The cross partition mode is for cross partition upsert (primary keys not contain all partition fields). It directly maintains the mapping of primary keys to partition and bucket, uses local disks, and initializes indexes by reading all existing keys in the table when starting stream write job.

BUCKET_UNAWARE

public static final BucketMode BUCKET_UNAWARE

Ignoring bucket concept, although all data is written to bucket-0, the parallelism of reads and writes is unrestricted. This mode only works for append-only table.

Field Detail

UNAWARE_BUCKET

public static final int UNAWARE_BUCKET

See Also:

Constant Field Values

Method Detail

values

public static BucketMode[] 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 (BucketMode c : BucketMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static BucketMode 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