org.apache.hudi.config

Class HoodieIndexConfig

java.lang.Object

org.apache.hudi.common.config.HoodieConfig

org.apache.hudi.config.HoodieIndexConfig

All Implemented Interfaces:

Serializable

@Immutable
public class HoodieIndexConfig
extends HoodieConfig

Indexing related config.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HoodieIndexConfig.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOOM_FILTER_FPP Deprecated. Use BLOOM_FILTER_FPP_VALUE and its methods instead
static ConfigProperty<String>	BLOOM_FILTER_FPP_VALUE
static String	BLOOM_FILTER_NUM_ENTRIES Deprecated. Use BLOOM_FILTER_NUM_ENTRIES_VALUE and its methods instead
static ConfigProperty<String>	BLOOM_FILTER_NUM_ENTRIES_VALUE
static ConfigProperty<String>	BLOOM_FILTER_TYPE
static ConfigProperty<String>	BLOOM_INDEX_BUCKETIZED_CHECKING
static String	BLOOM_INDEX_BUCKETIZED_CHECKING_PROP Deprecated. Use BLOOM_INDEX_BUCKETIZED_CHECKING and its methods instead
static ConfigProperty<String>	BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES
static String	BLOOM_INDEX_FILTER_TYPE Deprecated. Use BLOOM_FILTER_TYPE and its methods instead
static String	BLOOM_INDEX_INPUT_STORAGE_LEVEL Deprecated. Use BLOOM_INDEX_INPUT_STORAGE_LEVEL_VALUE and its methods instead
static ConfigProperty<String>	BLOOM_INDEX_INPUT_STORAGE_LEVEL_VALUE
static ConfigProperty<String>	BLOOM_INDEX_KEYS_PER_BUCKET
static String	BLOOM_INDEX_KEYS_PER_BUCKET_PROP Deprecated. Use BLOOM_INDEX_KEYS_PER_BUCKET and its methods instead
static ConfigProperty<String>	BLOOM_INDEX_PARALLELISM
static String	BLOOM_INDEX_PARALLELISM_PROP Deprecated. Use BLOOM_INDEX_PARALLELISM and its methods instead
static ConfigProperty<String>	BLOOM_INDEX_PRUNE_BY_RANGES
static String	BLOOM_INDEX_PRUNE_BY_RANGES_PROP Deprecated. Use BLOOM_INDEX_PRUNE_BY_RANGES and its methods instead
static ConfigProperty<String>	BLOOM_INDEX_TREE_BASED_FILTER
static String	BLOOM_INDEX_TREE_BASED_FILTER_PROP Deprecated. Use BLOOM_INDEX_TREE_BASED_FILTER and its methods instead
static String	BLOOM_INDEX_UPDATE_PARTITION_PATH Deprecated. Use BLOOM_INDEX_UPDATE_PARTITION_PATH_ENABLE and its methods instead
static ConfigProperty<String>	BLOOM_INDEX_UPDATE_PARTITION_PATH_ENABLE Only applies if index type is GLOBAL_BLOOM.
static ConfigProperty<String>	BLOOM_INDEX_USE_CACHING
static String	BLOOM_INDEX_USE_CACHING_PROP Deprecated. Use BLOOM_INDEX_USE_CACHING and its methods instead
static ConfigProperty<Boolean>	BLOOM_INDEX_USE_METADATA
static ConfigProperty<String>	BUCKET_INDEX_HASH_FIELD
static ConfigProperty<Integer>	BUCKET_INDEX_NUM_BUCKETS ***** Bucket Index Configs ***** Bucket Index is targeted to locate the record fast by hash in big data scenarios.
static String	DEFAULT_BLOOM_FILTER_FPP Deprecated. Use BLOOM_FILTER_FPP_VALUE and its methods instead
static String	DEFAULT_BLOOM_FILTER_NUM_ENTRIES Deprecated. Use BLOOM_FILTER_NUM_ENTRIES_VALUE and its methods instead
static String	DEFAULT_BLOOM_INDEX_BUCKETIZED_CHECKING Deprecated. Use BLOOM_INDEX_BUCKETIZED_CHECKING and its methods instead
static String	DEFAULT_BLOOM_INDEX_FILTER_TYPE Deprecated. Use BLOOM_FILTER_TYPE and its methods instead
static String	DEFAULT_BLOOM_INDEX_INPUT_STORAGE_LEVEL Deprecated. Use BLOOM_INDEX_INPUT_STORAGE_LEVEL_VALUE and its methods instead
static String	DEFAULT_BLOOM_INDEX_KEYS_PER_BUCKET Deprecated. Use BLOOM_INDEX_KEYS_PER_BUCKET and its methods instead
static String	DEFAULT_BLOOM_INDEX_PARALLELISM Deprecated. Use BLOOM_INDEX_PARALLELISM and its methods instead
static String	DEFAULT_BLOOM_INDEX_PRUNE_BY_RANGES Deprecated. Use BLOOM_INDEX_PRUNE_BY_RANGES and its methods instead
static String	DEFAULT_BLOOM_INDEX_TREE_BASED_FILTER Deprecated. Use BLOOM_INDEX_TREE_BASED_FILTER and its methods instead
static String	DEFAULT_BLOOM_INDEX_UPDATE_PARTITION_PATH Deprecated. Use BLOOM_INDEX_UPDATE_PARTITION_PATH_ENABLE and its methods instead
static String	DEFAULT_BLOOM_INDEX_USE_CACHING Deprecated. Use BLOOM_INDEX_USE_CACHING and its methods instead
static String	DEFAULT_GLOBAL_SIMPLE_INDEX_PARALLELISM Deprecated. Use GLOBAL_SIMPLE_INDEX_PARALLELISM and its methods instead
static String	DEFAULT_HBASE_BATCH_SIZE Deprecated.
static String	DEFAULT_HOODIE_BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES Deprecated. Use BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES and its methods instead
static String	DEFAULT_INDEX_CLASS Deprecated. Use INDEX_CLASS_NAME and its methods instead
static String	DEFAULT_SIMPLE_INDEX_INPUT_STORAGE_LEVEL Deprecated. Use SIMPLE_INDEX_INPUT_STORAGE_LEVEL_VALUE and its methods instead
static String	DEFAULT_SIMPLE_INDEX_PARALLELISM Deprecated. Use SIMPLE_INDEX_PARALLELISM and its methods instead
static String	DEFAULT_SIMPLE_INDEX_UPDATE_PARTITION_PATH Deprecated. Use SIMPLE_INDEX_UPDATE_PARTITION_PATH_ENABLE and its methods instead
static String	DEFAULT_SIMPLE_INDEX_USE_CACHING Deprecated. Use SIMPLE_INDEX_USE_CACHING and its methods instead
static ConfigProperty<String>	GLOBAL_SIMPLE_INDEX_PARALLELISM
static String	GLOBAL_SIMPLE_INDEX_PARALLELISM_PROP Deprecated. Use GLOBAL_SIMPLE_INDEX_PARALLELISM and its methods instead
static String	HBASE_GET_BATCH_SIZE_PROP Deprecated.
static String	HBASE_PUT_BATCH_SIZE_PROP Deprecated.
static String	HBASE_TABLENAME_PROP Deprecated.
static String	HBASE_ZK_ZNODEPARENT Deprecated.
static String	HBASE_ZKPORT_PROP Deprecated.
static String	HBASE_ZKQUORUM_PROP Deprecated.
static String	HOODIE_BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES Deprecated. Use BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES and its methods instead
static ConfigProperty<String>	INDEX_CLASS_NAME
static String	INDEX_CLASS_PROP Deprecated. Use INDEX_CLASS_NAME and its methods instead
static ConfigProperty<String>	INDEX_TYPE
static String	INDEX_TYPE_PROP Deprecated. Use INDEX_TYPE and its methods instead
static String	SIMPLE_INDEX_INPUT_STORAGE_LEVEL Deprecated. Use SIMPLE_INDEX_INPUT_STORAGE_LEVEL_VALUE and its methods instead
static ConfigProperty<String>	SIMPLE_INDEX_INPUT_STORAGE_LEVEL_VALUE
static ConfigProperty<String>	SIMPLE_INDEX_PARALLELISM
static String	SIMPLE_INDEX_PARALLELISM_PROP Deprecated. Use SIMPLE_INDEX_PARALLELISM and its methods instead
static String	SIMPLE_INDEX_UPDATE_PARTITION_PATH Deprecated. Use SIMPLE_INDEX_UPDATE_PARTITION_PATH_ENABLE and its methods instead
static ConfigProperty<String>	SIMPLE_INDEX_UPDATE_PARTITION_PATH_ENABLE
static ConfigProperty<String>	SIMPLE_INDEX_USE_CACHING
static String	SIMPLE_INDEX_USE_CACHING_PROP Deprecated. Use SIMPLE_INDEX_USE_CACHING and its methods instead

Fields inherited from class org.apache.hudi.common.config.HoodieConfig

CONFIG_VALUES_DELIMITER, props

Method Summary

Modifier and Type	Method and Description
static HoodieIndexConfig.Builder	newBuilder()

Methods inherited from class org.apache.hudi.common.config.HoodieConfig

contains, contains, create, getBoolean, getBooleanOrDefault, getDouble, getFloat, getInt, getIntOrDefault, getLong, getProps, getProps, getString, getString, getStringOrDefault, getStringOrDefault, getStringOrThrow, setAll, setDefault, setDefaultOnCondition, setDefaults, setDefaultValue, setDefaultValue, setValue, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INDEX_TYPE

public static final ConfigProperty<String> INDEX_TYPE

INDEX_CLASS_NAME

public static final ConfigProperty<String> INDEX_CLASS_NAME

BLOOM_FILTER_NUM_ENTRIES_VALUE

public static final ConfigProperty<String> BLOOM_FILTER_NUM_ENTRIES_VALUE

BLOOM_FILTER_FPP_VALUE

public static final ConfigProperty<String> BLOOM_FILTER_FPP_VALUE

BLOOM_INDEX_PARALLELISM

public static final ConfigProperty<String> BLOOM_INDEX_PARALLELISM

BLOOM_INDEX_PRUNE_BY_RANGES

public static final ConfigProperty<String> BLOOM_INDEX_PRUNE_BY_RANGES

BLOOM_INDEX_USE_CACHING

public static final ConfigProperty<String> BLOOM_INDEX_USE_CACHING

BLOOM_INDEX_USE_METADATA

public static final ConfigProperty<Boolean> BLOOM_INDEX_USE_METADATA

BLOOM_INDEX_TREE_BASED_FILTER

public static final ConfigProperty<String> BLOOM_INDEX_TREE_BASED_FILTER

BLOOM_INDEX_BUCKETIZED_CHECKING

public static final ConfigProperty<String> BLOOM_INDEX_BUCKETIZED_CHECKING

BLOOM_FILTER_TYPE

public static final ConfigProperty<String> BLOOM_FILTER_TYPE

BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES

public static final ConfigProperty<String> BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES

SIMPLE_INDEX_USE_CACHING

public static final ConfigProperty<String> SIMPLE_INDEX_USE_CACHING

SIMPLE_INDEX_PARALLELISM

public static final ConfigProperty<String> SIMPLE_INDEX_PARALLELISM

GLOBAL_SIMPLE_INDEX_PARALLELISM

public static final ConfigProperty<String> GLOBAL_SIMPLE_INDEX_PARALLELISM

BLOOM_INDEX_KEYS_PER_BUCKET

public static final ConfigProperty<String> BLOOM_INDEX_KEYS_PER_BUCKET

BLOOM_INDEX_INPUT_STORAGE_LEVEL_VALUE

public static final ConfigProperty<String> BLOOM_INDEX_INPUT_STORAGE_LEVEL_VALUE

SIMPLE_INDEX_INPUT_STORAGE_LEVEL_VALUE

public static final ConfigProperty<String> SIMPLE_INDEX_INPUT_STORAGE_LEVEL_VALUE

BLOOM_INDEX_UPDATE_PARTITION_PATH_ENABLE

public static final ConfigProperty<String> BLOOM_INDEX_UPDATE_PARTITION_PATH_ENABLE

Only applies if index type is GLOBAL_BLOOM.

When set to true, an update to a record with a different partition from its existing one will insert the record to the new partition and delete it from the old partition.

When set to false, a record will be updated to the old partition.

SIMPLE_INDEX_UPDATE_PARTITION_PATH_ENABLE

public static final ConfigProperty<String> SIMPLE_INDEX_UPDATE_PARTITION_PATH_ENABLE

BUCKET_INDEX_NUM_BUCKETS

public static final ConfigProperty<Integer> BUCKET_INDEX_NUM_BUCKETS

***** Bucket Index Configs ***** Bucket Index is targeted to locate the record fast by hash in big data scenarios. The current implementation is a basic version, so there are some constraints: 1. Unsupported operation: bulk insert, cluster and so on. 2. Bucket num change requires rewriting the partition. 3. Predict the table size and future data growth well to set a reasonable bucket num. 4. A bucket size is recommended less than 3GB and avoid bing too small. more details and progress see [HUDI-3039].

BUCKET_INDEX_HASH_FIELD

public static final ConfigProperty<String> BUCKET_INDEX_HASH_FIELD

HBASE_ZKQUORUM_PROP

@Deprecated
public static final String HBASE_ZKQUORUM_PROP

Deprecated.

Deprecated configs. These are now part of HoodieHBaseIndexConfig.

HBASE_ZKPORT_PROP

@Deprecated
public static final String HBASE_ZKPORT_PROP

Deprecated.

HBASE_ZK_ZNODEPARENT

@Deprecated
public static final String HBASE_ZK_ZNODEPARENT

Deprecated.

HBASE_TABLENAME_PROP

@Deprecated
public static final String HBASE_TABLENAME_PROP

Deprecated.

HBASE_GET_BATCH_SIZE_PROP

@Deprecated
public static final String HBASE_GET_BATCH_SIZE_PROP

Deprecated.

HBASE_PUT_BATCH_SIZE_PROP

@Deprecated
public static final String HBASE_PUT_BATCH_SIZE_PROP

Deprecated.

DEFAULT_HBASE_BATCH_SIZE

@Deprecated
public static final String DEFAULT_HBASE_BATCH_SIZE

Deprecated.

See Also:

Constant Field Values

INDEX_TYPE_PROP

@Deprecated
public static final String INDEX_TYPE_PROP

Deprecated. Use INDEX_TYPE and its methods instead

INDEX_CLASS_PROP

@Deprecated
public static final String INDEX_CLASS_PROP

Deprecated. Use INDEX_CLASS_NAME and its methods instead

DEFAULT_INDEX_CLASS

@Deprecated
public static final String DEFAULT_INDEX_CLASS

Deprecated. Use INDEX_CLASS_NAME and its methods instead

BLOOM_FILTER_NUM_ENTRIES

@Deprecated
public static final String BLOOM_FILTER_NUM_ENTRIES

Deprecated. Use BLOOM_FILTER_NUM_ENTRIES_VALUE and its methods instead

DEFAULT_BLOOM_FILTER_NUM_ENTRIES

@Deprecated
public static final String DEFAULT_BLOOM_FILTER_NUM_ENTRIES

Deprecated. Use BLOOM_FILTER_NUM_ENTRIES_VALUE and its methods instead

BLOOM_FILTER_FPP

@Deprecated
public static final String BLOOM_FILTER_FPP

Deprecated. Use BLOOM_FILTER_FPP_VALUE and its methods instead

DEFAULT_BLOOM_FILTER_FPP

@Deprecated
public static final String DEFAULT_BLOOM_FILTER_FPP

Deprecated. Use BLOOM_FILTER_FPP_VALUE and its methods instead

BLOOM_INDEX_PARALLELISM_PROP

@Deprecated
public static final String BLOOM_INDEX_PARALLELISM_PROP

Deprecated. Use BLOOM_INDEX_PARALLELISM and its methods instead

DEFAULT_BLOOM_INDEX_PARALLELISM

@Deprecated
public static final String DEFAULT_BLOOM_INDEX_PARALLELISM

Deprecated. Use BLOOM_INDEX_PARALLELISM and its methods instead

BLOOM_INDEX_PRUNE_BY_RANGES_PROP

@Deprecated
public static final String BLOOM_INDEX_PRUNE_BY_RANGES_PROP

Deprecated. Use BLOOM_INDEX_PRUNE_BY_RANGES and its methods instead

DEFAULT_BLOOM_INDEX_PRUNE_BY_RANGES

@Deprecated
public static final String DEFAULT_BLOOM_INDEX_PRUNE_BY_RANGES

Deprecated. Use BLOOM_INDEX_PRUNE_BY_RANGES and its methods instead

BLOOM_INDEX_USE_CACHING_PROP

@Deprecated
public static final String BLOOM_INDEX_USE_CACHING_PROP

Deprecated. Use BLOOM_INDEX_USE_CACHING and its methods instead

DEFAULT_BLOOM_INDEX_USE_CACHING

@Deprecated
public static final String DEFAULT_BLOOM_INDEX_USE_CACHING

Deprecated. Use BLOOM_INDEX_USE_CACHING and its methods instead

BLOOM_INDEX_TREE_BASED_FILTER_PROP

@Deprecated
public static final String BLOOM_INDEX_TREE_BASED_FILTER_PROP

Deprecated. Use BLOOM_INDEX_TREE_BASED_FILTER and its methods instead

DEFAULT_BLOOM_INDEX_TREE_BASED_FILTER

@Deprecated
public static final String DEFAULT_BLOOM_INDEX_TREE_BASED_FILTER

Deprecated. Use BLOOM_INDEX_TREE_BASED_FILTER and its methods instead

BLOOM_INDEX_BUCKETIZED_CHECKING_PROP

@Deprecated
public static final String BLOOM_INDEX_BUCKETIZED_CHECKING_PROP

Deprecated. Use BLOOM_INDEX_BUCKETIZED_CHECKING and its methods instead

DEFAULT_BLOOM_INDEX_BUCKETIZED_CHECKING

@Deprecated
public static final String DEFAULT_BLOOM_INDEX_BUCKETIZED_CHECKING

Deprecated. Use BLOOM_INDEX_BUCKETIZED_CHECKING and its methods instead

BLOOM_INDEX_FILTER_TYPE

@Deprecated
public static final String BLOOM_INDEX_FILTER_TYPE

Deprecated. Use BLOOM_FILTER_TYPE and its methods instead

DEFAULT_BLOOM_INDEX_FILTER_TYPE

@Deprecated
public static final String DEFAULT_BLOOM_INDEX_FILTER_TYPE

Deprecated. Use BLOOM_FILTER_TYPE and its methods instead

HOODIE_BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES

@Deprecated
public static final String HOODIE_BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES

Deprecated. Use BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES and its methods instead

DEFAULT_HOODIE_BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES

@Deprecated
public static final String DEFAULT_HOODIE_BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES

Deprecated. Use BLOOM_INDEX_FILTER_DYNAMIC_MAX_ENTRIES and its methods instead

SIMPLE_INDEX_USE_CACHING_PROP

@Deprecated
public static final String SIMPLE_INDEX_USE_CACHING_PROP

Deprecated. Use SIMPLE_INDEX_USE_CACHING and its methods instead

DEFAULT_SIMPLE_INDEX_USE_CACHING

@Deprecated
public static final String DEFAULT_SIMPLE_INDEX_USE_CACHING

Deprecated. Use SIMPLE_INDEX_USE_CACHING and its methods instead

SIMPLE_INDEX_PARALLELISM_PROP

@Deprecated
public static final String SIMPLE_INDEX_PARALLELISM_PROP

Deprecated. Use SIMPLE_INDEX_PARALLELISM and its methods instead

DEFAULT_SIMPLE_INDEX_PARALLELISM

@Deprecated
public static final String DEFAULT_SIMPLE_INDEX_PARALLELISM

Deprecated. Use SIMPLE_INDEX_PARALLELISM and its methods instead

GLOBAL_SIMPLE_INDEX_PARALLELISM_PROP

@Deprecated
public static final String GLOBAL_SIMPLE_INDEX_PARALLELISM_PROP

Deprecated. Use GLOBAL_SIMPLE_INDEX_PARALLELISM and its methods instead

DEFAULT_GLOBAL_SIMPLE_INDEX_PARALLELISM

@Deprecated
public static final String DEFAULT_GLOBAL_SIMPLE_INDEX_PARALLELISM

Deprecated. Use GLOBAL_SIMPLE_INDEX_PARALLELISM and its methods instead

BLOOM_INDEX_KEYS_PER_BUCKET_PROP

@Deprecated
public static final String BLOOM_INDEX_KEYS_PER_BUCKET_PROP

Deprecated. Use BLOOM_INDEX_KEYS_PER_BUCKET and its methods instead

DEFAULT_BLOOM_INDEX_KEYS_PER_BUCKET

@Deprecated
public static final String DEFAULT_BLOOM_INDEX_KEYS_PER_BUCKET

Deprecated. Use BLOOM_INDEX_KEYS_PER_BUCKET and its methods instead

BLOOM_INDEX_INPUT_STORAGE_LEVEL

@Deprecated
public static final String BLOOM_INDEX_INPUT_STORAGE_LEVEL

Deprecated. Use BLOOM_INDEX_INPUT_STORAGE_LEVEL_VALUE and its methods instead

DEFAULT_BLOOM_INDEX_INPUT_STORAGE_LEVEL

@Deprecated
public static final String DEFAULT_BLOOM_INDEX_INPUT_STORAGE_LEVEL

Deprecated. Use BLOOM_INDEX_INPUT_STORAGE_LEVEL_VALUE and its methods instead

SIMPLE_INDEX_INPUT_STORAGE_LEVEL

@Deprecated
public static final String SIMPLE_INDEX_INPUT_STORAGE_LEVEL

Deprecated. Use SIMPLE_INDEX_INPUT_STORAGE_LEVEL_VALUE and its methods instead

DEFAULT_SIMPLE_INDEX_INPUT_STORAGE_LEVEL

@Deprecated
public static final String DEFAULT_SIMPLE_INDEX_INPUT_STORAGE_LEVEL

Deprecated. Use SIMPLE_INDEX_INPUT_STORAGE_LEVEL_VALUE and its methods instead

BLOOM_INDEX_UPDATE_PARTITION_PATH

@Deprecated
public static final String BLOOM_INDEX_UPDATE_PARTITION_PATH

Deprecated. Use BLOOM_INDEX_UPDATE_PARTITION_PATH_ENABLE and its methods instead

DEFAULT_BLOOM_INDEX_UPDATE_PARTITION_PATH

@Deprecated
public static final String DEFAULT_BLOOM_INDEX_UPDATE_PARTITION_PATH

Deprecated. Use BLOOM_INDEX_UPDATE_PARTITION_PATH_ENABLE and its methods instead

SIMPLE_INDEX_UPDATE_PARTITION_PATH

@Deprecated
public static final String SIMPLE_INDEX_UPDATE_PARTITION_PATH

Deprecated. Use SIMPLE_INDEX_UPDATE_PARTITION_PATH_ENABLE and its methods instead

DEFAULT_SIMPLE_INDEX_UPDATE_PARTITION_PATH

@Deprecated
public static final String DEFAULT_SIMPLE_INDEX_UPDATE_PARTITION_PATH

Deprecated. Use SIMPLE_INDEX_UPDATE_PARTITION_PATH_ENABLE and its methods instead

Method Detail

newBuilder

public static HoodieIndexConfig.Builder newBuilder()