org.apache.hudi.configuration

Class OptionsResolver

java.lang.Object

org.apache.hudi.configuration.OptionsResolver

public class OptionsResolver
extends Object

Tool helping to resolve the flink options FlinkOptions.

Constructor Summary

Constructors

Constructor and Description
OptionsResolver()

Method Summary

Modifier and Type	Method and Description
static List<org.apache.flink.configuration.ConfigOption<?>>	allOptions(Class<?> clazz) Returns all the config options with the given class clazz.
static boolean	allowCommitOnEmptyBatch(org.apache.flink.configuration.Configuration conf) Returns whether to commit even when current batch has no data, for flink defaults false
static boolean	emitChangelog(org.apache.flink.configuration.Configuration conf) Returns whether the source should emit changelog.
static HoodieIndex.BucketIndexEngineType	getBucketEngineType(org.apache.flink.configuration.Configuration conf)
static HoodieCDCSupplementalLoggingMode	getCDCSupplementalLoggingMode(org.apache.flink.configuration.Configuration conf) Returns the supplemental logging mode.
static ConflictResolutionStrategy	getConflictResolutionStrategy(org.apache.flink.configuration.Configuration conf) Returns the conflict resolution strategy.
static String	getDefaultPlanStrategyClassName(org.apache.flink.configuration.Configuration conf) Returns the default plan strategy class.
static String	getIndexKeyField(org.apache.flink.configuration.Configuration conf) Returns the index key field.
static String[]	getIndexKeys(org.apache.flink.configuration.Configuration conf) Returns the index key field values.
static HoodieIndex.IndexType	getIndexType(org.apache.flink.configuration.Configuration conf) Returns the index type.
static String	getPreCombineField(org.apache.flink.configuration.Configuration conf) Returns the preCombine field or null if the value is set as FlinkOptions.NO_PRE_COMBINE.
static boolean	hasNoSpecificReadCommits(org.apache.flink.configuration.Configuration conf) Returns true if there are no explicit start and end commits.
static boolean	insertClustering(org.apache.flink.configuration.Configuration conf) Returns whether insert clustering is allowed with given configuration conf.
static boolean	isAppendMode(org.apache.flink.configuration.Configuration conf) Returns whether the insert is clustering disabled with given configuration conf.
static boolean	isBucketIndexType(org.apache.flink.configuration.Configuration conf)
static boolean	isBulkInsertOperation(org.apache.flink.configuration.Configuration conf) Returns whether the table operation is 'bulk_insert'.
static boolean	isConsistentHashingBucketIndexType(org.apache.flink.configuration.Configuration conf) Returns whether the table index is consistent bucket index.
static boolean	isConsistentLogicalTimestampEnabled(org.apache.flink.configuration.Configuration conf) Returns whether consistent value will be generated for a logical timestamp type column.
static boolean	isCowTable(org.apache.flink.configuration.Configuration conf) Returns whether it is a COPY_ON_WRITE table.
static boolean	isDefaultHoodieRecordPayloadClazz(org.apache.flink.configuration.Configuration conf) Returns whether the payload clazz is DefaultHoodieRecordPayload.
static boolean	isDeltaTimeCompaction(org.apache.flink.configuration.Configuration conf) Returns whether the compaction strategy is based on elapsed delta time.
static boolean	isIncrementalQuery(org.apache.flink.configuration.Configuration conf) Returns whether the query is incremental.
static boolean	isInsertOperation(org.apache.flink.configuration.Configuration conf) Returns whether the table operation is 'insert'.
static boolean	isInsertOverwrite(org.apache.flink.configuration.Configuration conf) Returns whether the operation is INSERT OVERWRITE (table or partition).
static boolean	isLazyFailedWritesCleanPolicy(org.apache.flink.configuration.Configuration conf)
static boolean	isLockRequired(org.apache.flink.configuration.Configuration conf) Returns whether the writer txn should be guarded by lock.
static boolean	isMorTable(org.apache.flink.configuration.Configuration conf) Returns whether it is a MERGE_ON_READ table.
static boolean	isMorTable(Map<String,String> options) Returns whether it is a MERGE_ON_READ table.
static boolean	isOptimisticConcurrencyControl(org.apache.flink.configuration.Configuration conf) Returns whether OCC is enabled.
static boolean	isPartitionedTable(org.apache.flink.configuration.Configuration conf) Returns whether the table is partitioned.
static boolean	isReadByTxnCompletionTime(org.apache.flink.configuration.Configuration conf) Returns whether to read the instants using completion time.
static boolean	isSchemaEvolutionEnabled(org.apache.flink.configuration.Configuration conf) Returns whether comprehensive schema evolution enabled.
static boolean	isSpecificStartCommit(org.apache.flink.configuration.Configuration conf) Returns whether the read start commit is specific commit timestamp.
static boolean	needsAsyncClustering(org.apache.flink.configuration.Configuration conf) Returns whether there is need to schedule the async clustering.
static boolean	needsAsyncCompaction(org.apache.flink.configuration.Configuration conf) Returns whether there is need to schedule the async compaction.
static boolean	needsScheduleClustering(org.apache.flink.configuration.Configuration conf) Returns whether there is need to schedule the clustering plan.
static boolean	needsScheduleCompaction(org.apache.flink.configuration.Configuration conf) Returns whether there is need to schedule the compaction plan.
static boolean	overwriteDynamicPartition(org.apache.flink.configuration.Configuration conf) Returns whether the operation is INSERT OVERWRITE dynamic partition.
static boolean	sortClusteringEnabled(org.apache.flink.configuration.Configuration conf) Returns whether the clustering sort is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionsResolver

public OptionsResolver()

Method Detail

insertClustering

public static boolean insertClustering(org.apache.flink.configuration.Configuration conf)

Returns whether insert clustering is allowed with given configuration conf.

isAppendMode

public static boolean isAppendMode(org.apache.flink.configuration.Configuration conf)

Returns whether the insert is clustering disabled with given configuration conf.

isInsertOperation

public static boolean isInsertOperation(org.apache.flink.configuration.Configuration conf)

Returns whether the table operation is 'insert'.

isBulkInsertOperation

public static boolean isBulkInsertOperation(org.apache.flink.configuration.Configuration conf)

Returns whether the table operation is 'bulk_insert'.

isMorTable

public static boolean isMorTable(org.apache.flink.configuration.Configuration conf)

Returns whether it is a MERGE_ON_READ table.

isMorTable

public static boolean isMorTable(Map<String,String> options)

Returns whether it is a MERGE_ON_READ table.

isCowTable

public static boolean isCowTable(org.apache.flink.configuration.Configuration conf)

Returns whether it is a COPY_ON_WRITE table.

isDefaultHoodieRecordPayloadClazz

public static boolean isDefaultHoodieRecordPayloadClazz(org.apache.flink.configuration.Configuration conf)

Returns whether the payload clazz is DefaultHoodieRecordPayload.

getPreCombineField

public static String getPreCombineField(org.apache.flink.configuration.Configuration conf)

Returns the preCombine field or null if the value is set as FlinkOptions.NO_PRE_COMBINE.

isDeltaTimeCompaction

public static boolean isDeltaTimeCompaction(org.apache.flink.configuration.Configuration conf)

Returns whether the compaction strategy is based on elapsed delta time.

isPartitionedTable

public static boolean isPartitionedTable(org.apache.flink.configuration.Configuration conf)

Returns whether the table is partitioned.

isBucketIndexType

public static boolean isBucketIndexType(org.apache.flink.configuration.Configuration conf)

getBucketEngineType

public static HoodieIndex.BucketIndexEngineType getBucketEngineType(org.apache.flink.configuration.Configuration conf)

isConsistentHashingBucketIndexType

public static boolean isConsistentHashingBucketIndexType(org.apache.flink.configuration.Configuration conf)

Returns whether the table index is consistent bucket index.

getDefaultPlanStrategyClassName

public static String getDefaultPlanStrategyClassName(org.apache.flink.configuration.Configuration conf)

Returns the default plan strategy class.

emitChangelog

public static boolean emitChangelog(org.apache.flink.configuration.Configuration conf)

Returns whether the source should emit changelog.

Returns:

true if the source is read as streaming with changelog mode enabled

needsAsyncCompaction

public static boolean needsAsyncCompaction(org.apache.flink.configuration.Configuration conf)

Returns whether there is need to schedule the async compaction.

Parameters:

conf - The flink configuration.

needsScheduleCompaction

public static boolean needsScheduleCompaction(org.apache.flink.configuration.Configuration conf)

Returns whether there is need to schedule the compaction plan.

Parameters:

conf - The flink configuration.

needsAsyncClustering

public static boolean needsAsyncClustering(org.apache.flink.configuration.Configuration conf)

Returns whether there is need to schedule the async clustering.

Parameters:

conf - The flink configuration.

needsScheduleClustering

public static boolean needsScheduleClustering(org.apache.flink.configuration.Configuration conf)

Returns whether there is need to schedule the clustering plan.

Parameters:

conf - The flink configuration.

sortClusteringEnabled

public static boolean sortClusteringEnabled(org.apache.flink.configuration.Configuration conf)

Returns whether the clustering sort is enabled.

isInsertOverwrite

public static boolean isInsertOverwrite(org.apache.flink.configuration.Configuration conf)

Returns whether the operation is INSERT OVERWRITE (table or partition).

overwriteDynamicPartition

public static boolean overwriteDynamicPartition(org.apache.flink.configuration.Configuration conf)

Returns whether the operation is INSERT OVERWRITE dynamic partition.

isSpecificStartCommit

public static boolean isSpecificStartCommit(org.apache.flink.configuration.Configuration conf)

Returns whether the read start commit is specific commit timestamp.

hasNoSpecificReadCommits

public static boolean hasNoSpecificReadCommits(org.apache.flink.configuration.Configuration conf)

Returns true if there are no explicit start and end commits.

getCDCSupplementalLoggingMode

public static HoodieCDCSupplementalLoggingMode getCDCSupplementalLoggingMode(org.apache.flink.configuration.Configuration conf)

Returns the supplemental logging mode.

isSchemaEvolutionEnabled

public static boolean isSchemaEvolutionEnabled(org.apache.flink.configuration.Configuration conf)

Returns whether comprehensive schema evolution enabled.

isIncrementalQuery

public static boolean isIncrementalQuery(org.apache.flink.configuration.Configuration conf)

Returns whether the query is incremental.

isConsistentLogicalTimestampEnabled

public static boolean isConsistentLogicalTimestampEnabled(org.apache.flink.configuration.Configuration conf)

Returns whether consistent value will be generated for a logical timestamp type column.

isLockRequired

public static boolean isLockRequired(org.apache.flink.configuration.Configuration conf)

Returns whether the writer txn should be guarded by lock.

isOptimisticConcurrencyControl

public static boolean isOptimisticConcurrencyControl(org.apache.flink.configuration.Configuration conf)

Returns whether OCC is enabled.

isReadByTxnCompletionTime

public static boolean isReadByTxnCompletionTime(org.apache.flink.configuration.Configuration conf)

Returns whether to read the instants using completion time.

A Hudi instant contains both the txn start time and completion time, for incremental subscription of the source reader, using completion time to filter the candidate instants can avoid data loss in scenarios like multiple writers.

getIndexType

public static HoodieIndex.IndexType getIndexType(org.apache.flink.configuration.Configuration conf)

Returns the index type.

getIndexKeyField

public static String getIndexKeyField(org.apache.flink.configuration.Configuration conf)

Returns the index key field.

getIndexKeys

public static String[] getIndexKeys(org.apache.flink.configuration.Configuration conf)

Returns the index key field values.

getConflictResolutionStrategy

public static ConflictResolutionStrategy getConflictResolutionStrategy(org.apache.flink.configuration.Configuration conf)

Returns the conflict resolution strategy.

allowCommitOnEmptyBatch

public static boolean allowCommitOnEmptyBatch(org.apache.flink.configuration.Configuration conf)

Returns whether to commit even when current batch has no data, for flink defaults false

isLazyFailedWritesCleanPolicy

public static boolean isLazyFailedWritesCleanPolicy(org.apache.flink.configuration.Configuration conf)

allOptions

public static List<org.apache.flink.configuration.ConfigOption<?>> allOptions(Class<?> clazz)

Returns all the config options with the given class clazz.