CoreOptions (Paimon : 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.paimon.CoreOptions

All Implemented Interfaces:

Serializable
```
public class CoreOptions
extends Object
implements Serializable
```
Core options for paimon.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CoreOptions.ChangelogProducer` Specifies the changelog producer for table.
`static class`	`CoreOptions.ConsumerMode` Specifies the log consistency mode for table.
`static class`	`CoreOptions.ExpireExecutionMode` The execution mode for expire.
`static class`	`CoreOptions.IncrementalBetweenScanMode` Specifies this scan type for incremental scan .
`static class`	`CoreOptions.LogChangelogMode` Specifies the log changelog mode for table.
`static class`	`CoreOptions.LogConsistency` Specifies the log consistency mode for table.
`static class`	`CoreOptions.LookupLocalFileType` Specifies the local file type for lookup.
`static class`	`CoreOptions.MaterializedTableIntervalFreshnessTimeUnit` The time unit of materialized table freshness.
`static class`	`CoreOptions.MaterializedTableRefreshMode` The refresh mode of materialized table.
`static class`	`CoreOptions.MaterializedTableRefreshStatus` The refresh status of materialized table.
`static class`	`CoreOptions.MergeEngine` Specifies the merge engine for table with primary key.
`static class`	`CoreOptions.PartitionExpireStrategy` Specifies the expiration strategy for partition expiration.
`static class`	`CoreOptions.RangeStrategy` Specifies range strategy.
`static class`	`CoreOptions.SortEngine` Specifies the sort engine for table with primary key.
`static class`	`CoreOptions.SortOrder` Specifies the sort order for field sequence id.
`static class`	`CoreOptions.StartupMode` Specifies the startup mode for log consumer.
`static class`	`CoreOptions.StreamingReadMode` Specifies the type for streaming read.
`static class`	`CoreOptions.StreamScanMode` Inner stream scan mode for some internal requirements.
`static class`	`CoreOptions.TagCreationMode` The mode for tag creation.
`static class`	`CoreOptions.TagCreationPeriod` The period for tag creation.
`static class`	`CoreOptions.TagPeriodFormatter` The period format options for tag creation.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AGG_FUNCTION`
`static ConfigOption<Boolean>`	`ASYNC_FILE_WRITE`
`static ConfigOption<Boolean>`	`AUTO_CREATE`
`static ConfigOption<String>`	`BRANCH`
`static ConfigOption<Integer>`	`BUCKET`
`static ConfigOption<String>`	`BUCKET_KEY`
`static ConfigOption<MemorySize>`	`CACHE_PAGE_SIZE`
`static ConfigOption<String>`	`CHANGELOG_FILE_PREFIX`
`static ConfigOption<Integer>`	`CHANGELOG_NUM_RETAINED_MAX`
`static ConfigOption<Integer>`	`CHANGELOG_NUM_RETAINED_MIN`
`static ConfigOption<CoreOptions.ChangelogProducer>`	`CHANGELOG_PRODUCER`
`static ConfigOption<Boolean>`	`CHANGELOG_PRODUCER_ROW_DEDUPLICATE`
`static ConfigOption<String>`	`CHANGELOG_PRODUCER_ROW_DEDUPLICATE_IGNORE_FIELDS`
`static ConfigOption<java.time.Duration>`	`CHANGELOG_TIME_RETAINED`
`static String`	`COLUMNS`
`static ConfigOption<String>`	`COMMIT_CALLBACK_PARAM`
`static ConfigOption<String>`	`COMMIT_CALLBACKS`
`static ConfigOption<Boolean>`	`COMMIT_FORCE_COMPACT`
`static ConfigOption<Boolean>`	`COMMIT_FORCE_CREATE_SNAPSHOT`
`static ConfigOption<Integer>`	`COMMIT_MAX_RETRIES`
`static ConfigOption<String>`	`COMMIT_USER_PREFIX`
`static ConfigOption<Integer>`	`COMPACTION_MAX_FILE_NUM`
`static ConfigOption<Integer>`	`COMPACTION_MAX_SIZE_AMPLIFICATION_PERCENT`
`static ConfigOption<Integer>`	`COMPACTION_MIN_FILE_NUM`
`static ConfigOption<java.time.Duration>`	`COMPACTION_OPTIMIZATION_INTERVAL`
`static ConfigOption<Integer>`	`COMPACTION_SIZE_RATIO`
`static ConfigOption<CoreOptions.ConsumerMode>`	`CONSUMER_CONSISTENCY_MODE`
`static ConfigOption<java.time.Duration>`	`CONSUMER_EXPIRATION_TIME`
`static ConfigOption<String>`	`CONSUMER_ID`
`static ConfigOption<Boolean>`	`CONSUMER_IGNORE_PROGRESS`
`static ConfigOption<java.time.Duration>`	`CONTINUOUS_DISCOVERY_INTERVAL`
`static ConfigOption<Integer>`	`CROSS_PARTITION_UPSERT_BOOTSTRAP_PARALLELISM`
`static ConfigOption<java.time.Duration>`	`CROSS_PARTITION_UPSERT_INDEX_TTL`
`static ConfigOption<String>`	`DATA_FILE_PREFIX`
`static String`	`DEFAULT_AGG_FUNCTION`
`static String`	`DEFAULT_VALUE_SUFFIX`
`static ConfigOption<Integer>`	`DELETE_FILE_THREAD_NUM`
`static ConfigOption<Boolean>`	`DELETION_FORCE_PRODUCE_CHANGELOG`
`static ConfigOption<MemorySize>`	`DELETION_VECTOR_INDEX_FILE_TARGET_SIZE`
`static ConfigOption<Boolean>`	`DELETION_VECTORS_ENABLED`
`static String`	`DISTINCT`
`static ConfigOption<Integer>`	`DYNAMIC_BUCKET_ASSIGNER_PARALLELISM`
`static ConfigOption<Integer>`	`DYNAMIC_BUCKET_INITIAL_BUCKETS`
`static ConfigOption<Long>`	`DYNAMIC_BUCKET_TARGET_ROW_NUM`
`static ConfigOption<Boolean>`	`DYNAMIC_PARTITION_OVERWRITE`
`static ConfigOption<Boolean>`	`END_INPUT_CHECK_PARTITION_EXPIRE`
`static ConfigOption<String>`	`FIELDS_DEFAULT_AGG_FUNC`
`static String`	`FIELDS_PREFIX`
`static String`	`FIELDS_SEPARATOR`
`static ConfigOption<MemorySize>`	`FILE_BLOCK_SIZE`
`static ConfigOption<String>`	`FILE_COMPRESSION`
`static ConfigOption<Map<String,String>>`	`FILE_COMPRESSION_PER_LEVEL`
`static ConfigOption<Integer>`	`FILE_COMPRESSION_ZSTD_LEVEL`
`static ConfigOption<String>`	`FILE_FORMAT`
`static String`	`FILE_FORMAT_AVRO`
`static String`	`FILE_FORMAT_ORC`
`static String`	`FILE_FORMAT_PARQUET`
`static ConfigOption<Map<String,String>>`	`FILE_FORMAT_PER_LEVEL`
`static String`	`FILE_INDEX`
`static ConfigOption<MemorySize>`	`FILE_INDEX_IN_MANIFEST_THRESHOLD`
`static ConfigOption<Boolean>`	`FILE_INDEX_READ_ENABLED`
`static ConfigOption<MemorySize>`	`FILE_READER_ASYNC_THRESHOLD`
`static ConfigOption<Boolean>`	`FILE_SUFFIX_INCLUDE_COMPRESSION`
`static ConfigOption<Boolean>`	`FORCE_LOOKUP`
`static ConfigOption<Integer>`	`FULL_COMPACTION_DELTA_COMMITS`
`static ConfigOption<Boolean>`	`IGNORE_DELETE`
`static String`	`IGNORE_RETRACT`
`static Set<String>`	`IMMUTABLE_OPTIONS`
`static ConfigOption<String>`	`INCREMENTAL_BETWEEN`
`static ConfigOption<CoreOptions.IncrementalBetweenScanMode>`	`INCREMENTAL_BETWEEN_SCAN_MODE`
`static ConfigOption<String>`	`INCREMENTAL_BETWEEN_TIMESTAMP`
`static String`	`LIST_AGG_DELIMITER`
`static ConfigOption<MemorySize>`	`LOCAL_MERGE_BUFFER_SIZE`
`static ConfigOption<Integer>`	`LOCAL_SORT_MAX_NUM_FILE_HANDLES`
`static ConfigOption<CoreOptions.LogChangelogMode>`	`LOG_CHANGELOG_MODE`
`static ConfigOption<CoreOptions.LogConsistency>`	`LOG_CONSISTENCY`
`static ConfigOption<String>`	`LOG_FORMAT`
`static ConfigOption<String>`	`LOG_KEY_FORMAT`
`static ConfigOption<Boolean>`	`LOOKUP_CACHE_BLOOM_FILTER_ENABLED`
`static ConfigOption<Double>`	`LOOKUP_CACHE_BLOOM_FILTER_FPP`
`static ConfigOption<java.time.Duration>`	`LOOKUP_CACHE_FILE_RETENTION`
`static ConfigOption<MemorySize>`	`LOOKUP_CACHE_MAX_DISK_SIZE`
`static ConfigOption<MemorySize>`	`LOOKUP_CACHE_MAX_MEMORY_SIZE`
`static ConfigOption<String>`	`LOOKUP_CACHE_SPILL_COMPRESSION`
`static ConfigOption<Float>`	`LOOKUP_HASH_LOAD_FACTOR`
`static ConfigOption<CoreOptions.LookupLocalFileType>`	`LOOKUP_LOCAL_FILE_TYPE`
`static ConfigOption<Boolean>`	`LOOKUP_WAIT`
`static ConfigOption<String>`	`MANIFEST_COMPRESSION`
`static ConfigOption<String>`	`MANIFEST_FORMAT`
`static ConfigOption<MemorySize>`	`MANIFEST_FULL_COMPACTION_FILE_SIZE`
`static ConfigOption<Integer>`	`MANIFEST_MERGE_MIN_COUNT`
`static ConfigOption<MemorySize>`	`MANIFEST_TARGET_FILE_SIZE`
`static ConfigOption<String>`	`MATERIALIZED_TABLE_DEFINITION_QUERY`
`static ConfigOption<String>`	`MATERIALIZED_TABLE_INTERVAL_FRESHNESS`
`static ConfigOption<CoreOptions.MaterializedTableIntervalFreshnessTimeUnit>`	`MATERIALIZED_TABLE_INTERVAL_FRESHNESS_TIME_UNIT`
`static ConfigOption<CoreOptions.MaterializedTableRefreshMode>`	`MATERIALIZED_TABLE_LOGICAL_REFRESH_MODE`
`static ConfigOption<String>`	`MATERIALIZED_TABLE_REFRESH_HANDLER_BYTES`
`static ConfigOption<String>`	`MATERIALIZED_TABLE_REFRESH_HANDLER_DESCRIPTION`
`static ConfigOption<CoreOptions.MaterializedTableRefreshMode>`	`MATERIALIZED_TABLE_REFRESH_MODE`
`static ConfigOption<CoreOptions.MaterializedTableRefreshStatus>`	`MATERIALIZED_TABLE_REFRESH_STATUS`
`static ConfigOption<CoreOptions.MergeEngine>`	`MERGE_ENGINE`
`static ConfigOption<Boolean>`	`METADATA_STATS_DENSE_STORE`
`static ConfigOption<String>`	`METADATA_STATS_MODE`
`static ConfigOption<Boolean>`	`METASTORE_PARTITIONED_TABLE`
`static ConfigOption<String>`	`METASTORE_TAG_TO_PARTITION`
`static ConfigOption<CoreOptions.TagCreationMode>`	`METASTORE_TAG_TO_PARTITION_PREVIEW`
`static String`	`NESTED_KEY`
`static ConfigOption<Integer>`	`NUM_LEVELS`
`static ConfigOption<Integer>`	`NUM_SORTED_RUNS_COMPACTION_TRIGGER`
`static ConfigOption<Integer>`	`NUM_SORTED_RUNS_STOP_TRIGGER`
`static ConfigOption<MemorySize>`	`PAGE_SIZE`
`static ConfigOption<Integer>`	`PARQUET_ENABLE_DICTIONARY`
`static ConfigOption<Boolean>`	`PARTIAL_UPDATE_REMOVE_RECORD_ON_DELETE`
`static ConfigOption<String>`	`PARTITION`
`static ConfigOption<String>`	`PARTITION_DEFAULT_NAME`
`static ConfigOption<java.time.Duration>`	`PARTITION_EXPIRATION_CHECK_INTERVAL`
`static ConfigOption<CoreOptions.PartitionExpireStrategy>`	`PARTITION_EXPIRATION_STRATEGY`
`static ConfigOption<java.time.Duration>`	`PARTITION_EXPIRATION_TIME`
`static ConfigOption<Boolean>`	`PARTITION_GENERATE_LEGCY_NAME`
`static ConfigOption<String>`	`PARTITION_MARK_DONE_ACTION`
`static ConfigOption<Boolean>`	`PARTITION_MARK_DONE_WHEN_END_INPUT`
`static ConfigOption<String>`	`PARTITION_TIMESTAMP_FORMATTER`
`static ConfigOption<String>`	`PARTITION_TIMESTAMP_PATTERN`
`static ConfigOption<String>`	`PATH`
`static ConfigOption<String>`	`PRIMARY_KEY`
`static ConfigOption<Integer>`	`READ_BATCH_SIZE`
`static ConfigOption<java.time.Duration>`	`RECORD_LEVEL_EXPIRE_TIME`
`static ConfigOption<String>`	`RECORD_LEVEL_TIME_FIELD`
`static ConfigOption<String>`	`ROWKIND_FIELD`
`static ConfigOption<Long>`	`SCAN_BOUNDED_WATERMARK`
`static ConfigOption<String>`	`SCAN_FALLBACK_BRANCH`
`static ConfigOption<Long>`	`SCAN_FILE_CREATION_TIME_MILLIS`
`static ConfigOption<Integer>`	`SCAN_MANIFEST_PARALLELISM`
`static ConfigOption<Integer>`	`SCAN_MAX_SPLITS_PER_TASK`
`static ConfigOption<CoreOptions.StartupMode>`	`SCAN_MODE`
`static ConfigOption<Boolean>`	`SCAN_PLAN_SORT_PARTITION`
`static ConfigOption<Long>`	`SCAN_SNAPSHOT_ID`
`static ConfigOption<String>`	`SCAN_TAG_NAME`
`static ConfigOption<String>`	`SCAN_TIMESTAMP`
`static ConfigOption<Long>`	`SCAN_TIMESTAMP_MILLIS`
`static ConfigOption<String>`	`SCAN_VERSION`
`static ConfigOption<Long>`	`SCAN_WATERMARK`
`static ConfigOption<String>`	`SEQUENCE_FIELD`
`static ConfigOption<CoreOptions.SortOrder>`	`SEQUENCE_FIELD_SORT_ORDER`
`static ConfigOption<String>`	`SINK_WATERMARK_TIME_ZONE`
`static ConfigOption<Boolean>`	`SNAPSHOT_CLEAN_EMPTY_DIRECTORIES`
`static ConfigOption<CoreOptions.ExpireExecutionMode>`	`SNAPSHOT_EXPIRE_EXECUTION_MODE`
`static ConfigOption<Integer>`	`SNAPSHOT_EXPIRE_LIMIT`
`static ConfigOption<Integer>`	`SNAPSHOT_NUM_RETAINED_MAX`
`static ConfigOption<Integer>`	`SNAPSHOT_NUM_RETAINED_MIN`
`static ConfigOption<java.time.Duration>`	`SNAPSHOT_TIME_RETAINED`
`static ConfigOption<java.time.Duration>`	`SNAPSHOT_WATERMARK_IDLE_TIMEOUT`
`static ConfigOption<Integer>`	`SORT_COMPACTION_SAMPLE_MAGNIFICATION`
`static ConfigOption<CoreOptions.SortEngine>`	`SORT_ENGINE`
`static ConfigOption<CoreOptions.RangeStrategy>`	`SORT_RANG_STRATEGY`
`static ConfigOption<MemorySize>`	`SORT_SPILL_BUFFER_SIZE`
`static ConfigOption<Integer>`	`SORT_SPILL_THRESHOLD`
`static ConfigOption<MemorySize>`	`SOURCE_SPLIT_OPEN_FILE_COST`
`static ConfigOption<MemorySize>`	`SOURCE_SPLIT_TARGET_SIZE`
`static ConfigOption<String>`	`SPILL_COMPRESSION`
`static ConfigOption<Integer>`	`SPILL_COMPRESSION_ZSTD_LEVEL`
`static String`	`STATS_MODE_SUFFIX`
`static ConfigOption<CoreOptions.StreamScanMode>`	`STREAM_SCAN_MODE`
`static ConfigOption<CoreOptions.StreamingReadMode>`	`STREAMING_READ_MODE`
`static ConfigOption<Boolean>`	`STREAMING_READ_OVERWRITE`
`static ConfigOption<java.time.Duration>`	`STREAMING_READ_SNAPSHOT_DELAY`
`static ConfigOption<Boolean>`	`TAG_AUTOMATIC_COMPLETION`
`static ConfigOption<CoreOptions.TagCreationMode>`	`TAG_AUTOMATIC_CREATION`
`static ConfigOption<String>`	`TAG_CALLBACK_PARAM`
`static ConfigOption<String>`	`TAG_CALLBACKS`
`static ConfigOption<java.time.Duration>`	`TAG_CREATION_DELAY`
`static ConfigOption<CoreOptions.TagCreationPeriod>`	`TAG_CREATION_PERIOD`
`static ConfigOption<java.time.Duration>`	`TAG_DEFAULT_TIME_RETAINED`
`static ConfigOption<Integer>`	`TAG_NUM_RETAINED_MAX`
`static ConfigOption<CoreOptions.TagPeriodFormatter>`	`TAG_PERIOD_FORMATTER`
`static ConfigOption<MemorySize>`	`TARGET_FILE_SIZE`
`static ConfigOption<TableType>`	`TYPE`
`static ConfigOption<Integer>`	`WRITE_BATCH_SIZE`
`static ConfigOption<Boolean>`	`WRITE_BUFFER_FOR_APPEND`
`static ConfigOption<MemorySize>`	`WRITE_BUFFER_MAX_DISK_SIZE`
`static ConfigOption<MemorySize>`	`WRITE_BUFFER_SIZE`
`static ConfigOption<Boolean>`	`WRITE_BUFFER_SPILLABLE`
`static ConfigOption<MemorySize>`	`WRITE_MANIFEST_CACHE`
`static ConfigOption<Integer>`	`WRITE_MAX_WRITERS_TO_SPILL`
`static ConfigOption<Boolean>`	`WRITE_ONLY`
`static ConfigOption<Integer>`	`ZORDER_VAR_LENGTH_CONTRIBUTION`

Constructor Summary

Constructors
Constructor and Description

CoreOptions(Map<String,String> options)

CoreOptions(Options options)

Constructors
Constructor and Description
`CoreOptions(Map<String,String> options)`
`CoreOptions(Options options)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`asyncFileWrite()`
`String`	`branch()`
`static String`	`branch(Map<String,String> options)`
`int`	`bucket()`
`int`	`cachePageSize()`
`String`	`changelogFilePrefix()`
`boolean`	`changelogLifecycleDecoupled()`
`int`	`changelogNumRetainMax()`
`int`	`changelogNumRetainMin()`
`CoreOptions.ChangelogProducer`	`changelogProducer()`
`boolean`	`changelogRowDeduplicate()`
`List<String>`	`changelogRowDeduplicateIgnoreFields()`
`java.time.Duration`	`changelogTimeRetain()`
`boolean`	`cleanEmptyDirectories()`
`Map<String,String>`	`commitCallbacks()`
`boolean`	`commitForceCompact()`
`int`	`commitMaxRetries()`
`long`	`compactionFileSize(boolean hasPrimaryKey)`
`Optional<Integer>`	`compactionMaxFileNum()`
`int`	`compactionMinFileNum()`
`java.time.Duration`	`consumerExpireTime()`
`String`	`consumerId()`
`boolean`	`consumerIgnoreProgress()`
`java.time.Duration`	`continuousDiscoveryInterval()`
`String`	`createCommitUser()`
`static String`	`createCommitUser(Options options)`
`static FileFormat`	`createFileFormat(Options options, ConfigOption<String> formatOption)`
`int`	`crossPartitionUpsertBootstrapParallelism()`
`java.time.Duration`	`crossPartitionUpsertIndexTtl()`
`String`	`dataFilePrefix()`
`boolean`	`definedAggFunc()`
`int`	`deleteFileThreadNum()`
`boolean`	`deleteForceProduceChangelog()`
`MemorySize`	`deletionVectorIndexFileTargetSize()`
`boolean`	`deletionVectorsEnabled()`
`Integer`	`dynamicBucketAssignerParallelism()`
`Integer`	`dynamicBucketInitialBuckets()`
`long`	`dynamicBucketTargetRowNum()`
`boolean`	`dynamicPartitionOverwrite()`
`boolean`	`endInputCheckPartitionExpire()`
`ExpireConfig`	`expireConfig()`
`String`	`fieldAggFunc(String fieldName)`
`boolean`	`fieldAggIgnoreRetract(String fieldName)`
`boolean`	`fieldCollectAggDistinct(String fieldName)`
`String`	`fieldListAggDelimiter(String fieldName)`
`List<String>`	`fieldNestedUpdateAggNestedKey(String fieldName)`
`String`	`fieldsDefaultFunc()`
`String`	`fileCompression()`
`Map<Integer,String>`	`fileCompressionPerLevel()`
`FileFormat`	`fileFormat()`
`Map<Integer,String>`	`fileFormatPerLevel()`
`long`	`fileIndexInManifestThreshold()`
`boolean`	`fileIndexReadEnabled()`
`MemorySize`	`fileReaderAsyncThreshold()`
`boolean`	`fileSuffixIncludeCompression()`
`boolean`	`forceCreatingSnapshot()`
`String`	`formatType()`
`static CoreOptions`	`fromMap(Map<String,String> options)`
`Map<String,String>`	`getFieldDefaultValues()`
`Integer`	`getLocalSampleMagnification()`
`static List<ConfigOption<?>>`	`getOptions()`
`boolean`	`ignoreDelete()`
`Pair<String,String>`	`incrementalBetween()`
`CoreOptions.IncrementalBetweenScanMode`	`incrementalBetweenScanMode()`
`FileIndexOptions`	`indexColumnsOptions()`
`boolean`	`legacyPartitionName()`
`long`	`localMergeBufferSize()`
`boolean`	`localMergeEnabled()`
`int`	`localSortMaxNumFileHandles()`
`MemorySize`	`lookupCacheMaxMemory()`
`CompressOptions`	`lookupCompressOptions()`
`CoreOptions.LookupLocalFileType`	`lookupLocalFileType()`
`LookupStrategy`	`lookupStrategy()`
`String`	`manifestCompression()`
`FileFormat`	`manifestFormat()`
`MemorySize`	`manifestFullCompactionThresholdSize()`
`int`	`manifestMergeMinCount()`
`MemorySize`	`manifestTargetSize()`
`int`	`maxSizeAmplificationPercent()`
`CoreOptions.MergeEngine`	`mergeEngine()`
`boolean`	`needLookup()`
`int`	`numLevels()`
`int`	`numSortedRunCompactionTrigger()`
`int`	`numSortedRunStopTrigger()`
`java.time.Duration`	`optimizedCompactionInterval()`
`int`	`pageSize()`
`boolean`	`partialUpdateRemoveRecordOnDelete()`
`String`	`partitionDefaultName()`
`boolean`	`partitionedTableInMetastore()`
`java.time.Duration`	`partitionExpireCheckInterval()`
`CoreOptions.PartitionExpireStrategy`	`partitionExpireStrategy()`
`java.time.Duration`	`partitionExpireTime()`
`String`	`partitionTimestampFormatter()`
`String`	`partitionTimestampPattern()`
`Path`	`path()`
`static Path`	`path(Map<String,String> options)`
`static Path`	`path(Options options)`
`boolean`	`prepareCommitWaitCompaction()`
`java.time.Duration`	`recordLevelExpireTime()`
`String`	`recordLevelTimeField()`
`Optional<String>`	`rowkindField()`
`Long`	`scanBoundedWatermark()`
`Long`	`scanFileCreationTimeMills()`
`Integer`	`scanManifestParallelism()`
`boolean`	`scanPlanSortPartition()`
`Long`	`scanSnapshotId()`
`int`	`scanSplitMaxPerTask()`
`String`	`scanTagName()`
`String`	`scanTimestamp()`
`Long`	`scanTimestampMills()`
`String`	`scanVersion()`
`Long`	`scanWatermark()`
`List<String>`	`sequenceField()`
`boolean`	`sequenceFieldSortOrderIsAscending()`
`static void`	`setDefaultValues(Options options)` Set the default values of the `CoreOptions` via the given `Options`.
`String`	`sinkWatermarkTimeZone()`
`CoreOptions.ExpireExecutionMode`	`snapshotExpireExecutionMode()`
`int`	`snapshotExpireLimit()`
`int`	`snapshotNumRetainMax()`
`int`	`snapshotNumRetainMin()`
`java.time.Duration`	`snapshotTimeRetain()`
`java.time.Duration`	`snapshotWatermarkIdleTimeout()`
`boolean`	`sortBySize()`
`int`	`sortedRunSizeRatio()`
`CoreOptions.SortEngine`	`sortEngine()`
`long`	`sortSpillBufferSize()`
`int`	`sortSpillThreshold()`
`CompressOptions`	`spillCompressOptions()`
`long`	`splitOpenFileCost()`
`long`	`splitTargetSize()`
`CoreOptions.StartupMode`	`startupMode()`
`static CoreOptions.StartupMode`	`startupMode(Options options)`
`boolean`	`statsDenseStore()`
`java.time.Duration`	`streamingReadDelay()`
`boolean`	`streamingReadOverwrite()`
`static CoreOptions.StreamingReadMode`	`streamReadType(Options options)`
`boolean`	`tagAutomaticCompletion()`
`Map<String,String>`	`tagCallbacks()`
`java.time.Duration`	`tagCreationDelay()`
`CoreOptions.TagCreationMode`	`tagCreationMode()`
`CoreOptions.TagCreationPeriod`	`tagCreationPeriod()`
`java.time.Duration`	`tagDefaultTimeRetained()`
`Integer`	`tagNumRetainedMax()`
`CoreOptions.TagPeriodFormatter`	`tagPeriodFormatter()`
`String`	`tagToPartitionField()`
`CoreOptions.TagCreationMode`	`tagToPartitionPreview()`
`long`	`targetFileSize(boolean hasPrimaryKey)`
`Options`	`toConfiguration()`
`Map<String,String>`	`toMap()`
`boolean`	`useWriteBufferForAppend()`
`int`	`varTypeSize()`
`long`	`writeBufferSize()`
`boolean`	`writeBufferSpillable(boolean usingObjectStore, boolean isStreaming)`
`MemorySize`	`writeBufferSpillDiskSize()`
`MemorySize`	`writeManifestCache()`
`int`	`writeMaxWritersToSpill()`
`boolean`	`writeOnly()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_VALUE_SUFFIX

public static final String DEFAULT_VALUE_SUFFIX

See Also:: Constant Field Values

FIELDS_PREFIX

public static final String FIELDS_PREFIX

See Also:: Constant Field Values

FIELDS_SEPARATOR

public static final String FIELDS_SEPARATOR

See Also:: Constant Field Values

AGG_FUNCTION

public static final String AGG_FUNCTION

See Also:: Constant Field Values

DEFAULT_AGG_FUNCTION

public static final String DEFAULT_AGG_FUNCTION

See Also:: Constant Field Values

IGNORE_RETRACT

public static final String IGNORE_RETRACT

See Also:: Constant Field Values

NESTED_KEY
```
public static final String NESTED_KEY
```
See Also:

Constant Field Values

DISTINCT
```
public static final String DISTINCT
```
See Also:

Constant Field Values

LIST_AGG_DELIMITER

public static final String LIST_AGG_DELIMITER

See Also:: Constant Field Values

FILE_INDEX
```
public static final String FILE_INDEX
```
See Also:

Constant Field Values

COLUMNS
```
public static final String COLUMNS
```
See Also:

Constant Field Values

TYPE

public static final ConfigOption<TableType> TYPE

BUCKET

public static final ConfigOption<Integer> BUCKET

BUCKET_KEY

public static final ConfigOption<String> BUCKET_KEY

PATH

public static final ConfigOption<String> PATH

BRANCH

public static final ConfigOption<String> BRANCH

FILE_FORMAT_ORC

public static final String FILE_FORMAT_ORC

See Also:: Constant Field Values

FILE_FORMAT_AVRO

public static final String FILE_FORMAT_AVRO

See Also:: Constant Field Values

FILE_FORMAT_PARQUET

public static final String FILE_FORMAT_PARQUET

See Also:: Constant Field Values

FILE_FORMAT

public static final ConfigOption<String> FILE_FORMAT

FILE_COMPRESSION_PER_LEVEL

public static final ConfigOption<Map<String,String>> FILE_COMPRESSION_PER_LEVEL

FILE_FORMAT_PER_LEVEL

public static final ConfigOption<Map<String,String>> FILE_FORMAT_PER_LEVEL

FILE_COMPRESSION

public static final ConfigOption<String> FILE_COMPRESSION

FILE_COMPRESSION_ZSTD_LEVEL

public static final ConfigOption<Integer> FILE_COMPRESSION_ZSTD_LEVEL

DATA_FILE_PREFIX

public static final ConfigOption<String> DATA_FILE_PREFIX

CHANGELOG_FILE_PREFIX

public static final ConfigOption<String> CHANGELOG_FILE_PREFIX

FILE_SUFFIX_INCLUDE_COMPRESSION

public static final ConfigOption<Boolean> FILE_SUFFIX_INCLUDE_COMPRESSION

FILE_BLOCK_SIZE

public static final ConfigOption<MemorySize> FILE_BLOCK_SIZE

FILE_INDEX_IN_MANIFEST_THRESHOLD

public static final ConfigOption<MemorySize> FILE_INDEX_IN_MANIFEST_THRESHOLD

FILE_INDEX_READ_ENABLED

public static final ConfigOption<Boolean> FILE_INDEX_READ_ENABLED

MANIFEST_FORMAT

public static final ConfigOption<String> MANIFEST_FORMAT

MANIFEST_COMPRESSION

public static final ConfigOption<String> MANIFEST_COMPRESSION

MANIFEST_TARGET_FILE_SIZE

public static final ConfigOption<MemorySize> MANIFEST_TARGET_FILE_SIZE

MANIFEST_FULL_COMPACTION_FILE_SIZE

public static final ConfigOption<MemorySize> MANIFEST_FULL_COMPACTION_FILE_SIZE

MANIFEST_MERGE_MIN_COUNT

public static final ConfigOption<Integer> MANIFEST_MERGE_MIN_COUNT

PARTITION_DEFAULT_NAME

public static final ConfigOption<String> PARTITION_DEFAULT_NAME

PARTITION_GENERATE_LEGCY_NAME

public static final ConfigOption<Boolean> PARTITION_GENERATE_LEGCY_NAME

SNAPSHOT_NUM_RETAINED_MIN

public static final ConfigOption<Integer> SNAPSHOT_NUM_RETAINED_MIN

SNAPSHOT_NUM_RETAINED_MAX

public static final ConfigOption<Integer> SNAPSHOT_NUM_RETAINED_MAX

SNAPSHOT_TIME_RETAINED

public static final ConfigOption<java.time.Duration> SNAPSHOT_TIME_RETAINED

CHANGELOG_NUM_RETAINED_MIN

public static final ConfigOption<Integer> CHANGELOG_NUM_RETAINED_MIN

CHANGELOG_NUM_RETAINED_MAX

public static final ConfigOption<Integer> CHANGELOG_NUM_RETAINED_MAX

CHANGELOG_TIME_RETAINED

public static final ConfigOption<java.time.Duration> CHANGELOG_TIME_RETAINED

SNAPSHOT_EXPIRE_EXECUTION_MODE

public static final ConfigOption<CoreOptions.ExpireExecutionMode> SNAPSHOT_EXPIRE_EXECUTION_MODE

SNAPSHOT_EXPIRE_LIMIT

public static final ConfigOption<Integer> SNAPSHOT_EXPIRE_LIMIT

SNAPSHOT_CLEAN_EMPTY_DIRECTORIES

public static final ConfigOption<Boolean> SNAPSHOT_CLEAN_EMPTY_DIRECTORIES

CONTINUOUS_DISCOVERY_INTERVAL

public static final ConfigOption<java.time.Duration> CONTINUOUS_DISCOVERY_INTERVAL

SCAN_MAX_SPLITS_PER_TASK

public static final ConfigOption<Integer> SCAN_MAX_SPLITS_PER_TASK

MERGE_ENGINE

public static final ConfigOption<CoreOptions.MergeEngine> MERGE_ENGINE

IGNORE_DELETE

public static final ConfigOption<Boolean> IGNORE_DELETE

SORT_ENGINE

public static final ConfigOption<CoreOptions.SortEngine> SORT_ENGINE

SORT_SPILL_THRESHOLD

public static final ConfigOption<Integer> SORT_SPILL_THRESHOLD

SORT_SPILL_BUFFER_SIZE

public static final ConfigOption<MemorySize> SORT_SPILL_BUFFER_SIZE

SPILL_COMPRESSION

public static final ConfigOption<String> SPILL_COMPRESSION

SPILL_COMPRESSION_ZSTD_LEVEL

public static final ConfigOption<Integer> SPILL_COMPRESSION_ZSTD_LEVEL

WRITE_ONLY

public static final ConfigOption<Boolean> WRITE_ONLY

SOURCE_SPLIT_TARGET_SIZE

public static final ConfigOption<MemorySize> SOURCE_SPLIT_TARGET_SIZE

SOURCE_SPLIT_OPEN_FILE_COST

public static final ConfigOption<MemorySize> SOURCE_SPLIT_OPEN_FILE_COST

WRITE_BUFFER_SIZE

public static final ConfigOption<MemorySize> WRITE_BUFFER_SIZE

WRITE_BUFFER_MAX_DISK_SIZE

public static final ConfigOption<MemorySize> WRITE_BUFFER_MAX_DISK_SIZE

WRITE_BUFFER_SPILLABLE

public static final ConfigOption<Boolean> WRITE_BUFFER_SPILLABLE

WRITE_BUFFER_FOR_APPEND

public static final ConfigOption<Boolean> WRITE_BUFFER_FOR_APPEND

WRITE_MAX_WRITERS_TO_SPILL

public static final ConfigOption<Integer> WRITE_MAX_WRITERS_TO_SPILL

WRITE_MANIFEST_CACHE

public static final ConfigOption<MemorySize> WRITE_MANIFEST_CACHE

LOCAL_SORT_MAX_NUM_FILE_HANDLES

public static final ConfigOption<Integer> LOCAL_SORT_MAX_NUM_FILE_HANDLES

PAGE_SIZE

public static final ConfigOption<MemorySize> PAGE_SIZE

CACHE_PAGE_SIZE

public static final ConfigOption<MemorySize> CACHE_PAGE_SIZE

TARGET_FILE_SIZE

public static final ConfigOption<MemorySize> TARGET_FILE_SIZE

NUM_SORTED_RUNS_COMPACTION_TRIGGER

public static final ConfigOption<Integer> NUM_SORTED_RUNS_COMPACTION_TRIGGER

NUM_SORTED_RUNS_STOP_TRIGGER

public static final ConfigOption<Integer> NUM_SORTED_RUNS_STOP_TRIGGER

NUM_LEVELS

public static final ConfigOption<Integer> NUM_LEVELS

COMMIT_FORCE_COMPACT

public static final ConfigOption<Boolean> COMMIT_FORCE_COMPACT

COMMIT_MAX_RETRIES

public static final ConfigOption<Integer> COMMIT_MAX_RETRIES

COMPACTION_MAX_SIZE_AMPLIFICATION_PERCENT

public static final ConfigOption<Integer> COMPACTION_MAX_SIZE_AMPLIFICATION_PERCENT

COMPACTION_SIZE_RATIO

public static final ConfigOption<Integer> COMPACTION_SIZE_RATIO

COMPACTION_OPTIMIZATION_INTERVAL

public static final ConfigOption<java.time.Duration> COMPACTION_OPTIMIZATION_INTERVAL

COMPACTION_MIN_FILE_NUM

public static final ConfigOption<Integer> COMPACTION_MIN_FILE_NUM

COMPACTION_MAX_FILE_NUM

public static final ConfigOption<Integer> COMPACTION_MAX_FILE_NUM

CHANGELOG_PRODUCER

public static final ConfigOption<CoreOptions.ChangelogProducer> CHANGELOG_PRODUCER

CHANGELOG_PRODUCER_ROW_DEDUPLICATE

public static final ConfigOption<Boolean> CHANGELOG_PRODUCER_ROW_DEDUPLICATE

CHANGELOG_PRODUCER_ROW_DEDUPLICATE_IGNORE_FIELDS

public static final ConfigOption<String> CHANGELOG_PRODUCER_ROW_DEDUPLICATE_IGNORE_FIELDS

SEQUENCE_FIELD

public static final ConfigOption<String> SEQUENCE_FIELD

SEQUENCE_FIELD_SORT_ORDER

public static final ConfigOption<CoreOptions.SortOrder> SEQUENCE_FIELD_SORT_ORDER

PARTIAL_UPDATE_REMOVE_RECORD_ON_DELETE

public static final ConfigOption<Boolean> PARTIAL_UPDATE_REMOVE_RECORD_ON_DELETE

ROWKIND_FIELD

public static final ConfigOption<String> ROWKIND_FIELD

SCAN_MODE

public static final ConfigOption<CoreOptions.StartupMode> SCAN_MODE

SCAN_TIMESTAMP

public static final ConfigOption<String> SCAN_TIMESTAMP

SCAN_TIMESTAMP_MILLIS

public static final ConfigOption<Long> SCAN_TIMESTAMP_MILLIS

SCAN_WATERMARK

public static final ConfigOption<Long> SCAN_WATERMARK

SCAN_FILE_CREATION_TIME_MILLIS

public static final ConfigOption<Long> SCAN_FILE_CREATION_TIME_MILLIS

SCAN_SNAPSHOT_ID

public static final ConfigOption<Long> SCAN_SNAPSHOT_ID

SCAN_TAG_NAME

public static final ConfigOption<String> SCAN_TAG_NAME

SCAN_VERSION

public static final ConfigOption<String> SCAN_VERSION

SCAN_BOUNDED_WATERMARK

public static final ConfigOption<Long> SCAN_BOUNDED_WATERMARK

SCAN_MANIFEST_PARALLELISM

public static final ConfigOption<Integer> SCAN_MANIFEST_PARALLELISM

STREAMING_READ_SNAPSHOT_DELAY

public static final ConfigOption<java.time.Duration> STREAMING_READ_SNAPSHOT_DELAY

LOG_CONSISTENCY

public static final ConfigOption<CoreOptions.LogConsistency> LOG_CONSISTENCY

LOG_CHANGELOG_MODE

public static final ConfigOption<CoreOptions.LogChangelogMode> LOG_CHANGELOG_MODE

LOG_KEY_FORMAT

public static final ConfigOption<String> LOG_KEY_FORMAT

LOG_FORMAT

public static final ConfigOption<String> LOG_FORMAT

AUTO_CREATE

public static final ConfigOption<Boolean> AUTO_CREATE

STREAMING_READ_OVERWRITE

public static final ConfigOption<Boolean> STREAMING_READ_OVERWRITE

DYNAMIC_PARTITION_OVERWRITE

public static final ConfigOption<Boolean> DYNAMIC_PARTITION_OVERWRITE

PARTITION_EXPIRATION_STRATEGY

public static final ConfigOption<CoreOptions.PartitionExpireStrategy> PARTITION_EXPIRATION_STRATEGY

PARTITION_EXPIRATION_TIME

public static final ConfigOption<java.time.Duration> PARTITION_EXPIRATION_TIME

PARTITION_EXPIRATION_CHECK_INTERVAL

public static final ConfigOption<java.time.Duration> PARTITION_EXPIRATION_CHECK_INTERVAL

PARTITION_TIMESTAMP_FORMATTER

public static final ConfigOption<String> PARTITION_TIMESTAMP_FORMATTER

PARTITION_TIMESTAMP_PATTERN

public static final ConfigOption<String> PARTITION_TIMESTAMP_PATTERN

PARTITION_MARK_DONE_WHEN_END_INPUT

public static final ConfigOption<Boolean> PARTITION_MARK_DONE_WHEN_END_INPUT

SCAN_PLAN_SORT_PARTITION

public static final ConfigOption<Boolean> SCAN_PLAN_SORT_PARTITION

PRIMARY_KEY

public static final ConfigOption<String> PRIMARY_KEY

PARTITION

public static final ConfigOption<String> PARTITION

LOOKUP_LOCAL_FILE_TYPE

public static final ConfigOption<CoreOptions.LookupLocalFileType> LOOKUP_LOCAL_FILE_TYPE

LOOKUP_HASH_LOAD_FACTOR

public static final ConfigOption<Float> LOOKUP_HASH_LOAD_FACTOR

LOOKUP_CACHE_FILE_RETENTION

public static final ConfigOption<java.time.Duration> LOOKUP_CACHE_FILE_RETENTION

LOOKUP_CACHE_MAX_DISK_SIZE

public static final ConfigOption<MemorySize> LOOKUP_CACHE_MAX_DISK_SIZE

LOOKUP_CACHE_SPILL_COMPRESSION

public static final ConfigOption<String> LOOKUP_CACHE_SPILL_COMPRESSION

LOOKUP_CACHE_MAX_MEMORY_SIZE

public static final ConfigOption<MemorySize> LOOKUP_CACHE_MAX_MEMORY_SIZE

LOOKUP_CACHE_BLOOM_FILTER_ENABLED

public static final ConfigOption<Boolean> LOOKUP_CACHE_BLOOM_FILTER_ENABLED

LOOKUP_CACHE_BLOOM_FILTER_FPP

public static final ConfigOption<Double> LOOKUP_CACHE_BLOOM_FILTER_FPP

READ_BATCH_SIZE

public static final ConfigOption<Integer> READ_BATCH_SIZE

WRITE_BATCH_SIZE

public static final ConfigOption<Integer> WRITE_BATCH_SIZE

CONSUMER_ID

public static final ConfigOption<String> CONSUMER_ID

FULL_COMPACTION_DELTA_COMMITS

public static final ConfigOption<Integer> FULL_COMPACTION_DELTA_COMMITS

STREAM_SCAN_MODE

public static final ConfigOption<CoreOptions.StreamScanMode> STREAM_SCAN_MODE

STREAMING_READ_MODE

public static final ConfigOption<CoreOptions.StreamingReadMode> STREAMING_READ_MODE

CONSUMER_EXPIRATION_TIME

public static final ConfigOption<java.time.Duration> CONSUMER_EXPIRATION_TIME

CONSUMER_CONSISTENCY_MODE

public static final ConfigOption<CoreOptions.ConsumerMode> CONSUMER_CONSISTENCY_MODE

CONSUMER_IGNORE_PROGRESS

public static final ConfigOption<Boolean> CONSUMER_IGNORE_PROGRESS

DYNAMIC_BUCKET_TARGET_ROW_NUM

public static final ConfigOption<Long> DYNAMIC_BUCKET_TARGET_ROW_NUM

DYNAMIC_BUCKET_INITIAL_BUCKETS

public static final ConfigOption<Integer> DYNAMIC_BUCKET_INITIAL_BUCKETS

DYNAMIC_BUCKET_ASSIGNER_PARALLELISM

public static final ConfigOption<Integer> DYNAMIC_BUCKET_ASSIGNER_PARALLELISM

INCREMENTAL_BETWEEN

public static final ConfigOption<String> INCREMENTAL_BETWEEN

INCREMENTAL_BETWEEN_SCAN_MODE

public static final ConfigOption<CoreOptions.IncrementalBetweenScanMode> INCREMENTAL_BETWEEN_SCAN_MODE

INCREMENTAL_BETWEEN_TIMESTAMP

public static final ConfigOption<String> INCREMENTAL_BETWEEN_TIMESTAMP

END_INPUT_CHECK_PARTITION_EXPIRE

public static final ConfigOption<Boolean> END_INPUT_CHECK_PARTITION_EXPIRE

STATS_MODE_SUFFIX

public static final String STATS_MODE_SUFFIX

See Also:: Constant Field Values

METADATA_STATS_MODE

public static final ConfigOption<String> METADATA_STATS_MODE

METADATA_STATS_DENSE_STORE

public static final ConfigOption<Boolean> METADATA_STATS_DENSE_STORE

COMMIT_CALLBACKS

public static final ConfigOption<String> COMMIT_CALLBACKS

COMMIT_CALLBACK_PARAM

public static final ConfigOption<String> COMMIT_CALLBACK_PARAM

TAG_CALLBACKS

public static final ConfigOption<String> TAG_CALLBACKS

TAG_CALLBACK_PARAM

public static final ConfigOption<String> TAG_CALLBACK_PARAM

PARTITION_MARK_DONE_ACTION

public static final ConfigOption<String> PARTITION_MARK_DONE_ACTION

METASTORE_PARTITIONED_TABLE

public static final ConfigOption<Boolean> METASTORE_PARTITIONED_TABLE

METASTORE_TAG_TO_PARTITION

public static final ConfigOption<String> METASTORE_TAG_TO_PARTITION

METASTORE_TAG_TO_PARTITION_PREVIEW

public static final ConfigOption<CoreOptions.TagCreationMode> METASTORE_TAG_TO_PARTITION_PREVIEW

TAG_AUTOMATIC_CREATION

public static final ConfigOption<CoreOptions.TagCreationMode> TAG_AUTOMATIC_CREATION

TAG_CREATION_PERIOD

public static final ConfigOption<CoreOptions.TagCreationPeriod> TAG_CREATION_PERIOD

TAG_CREATION_DELAY

public static final ConfigOption<java.time.Duration> TAG_CREATION_DELAY

TAG_PERIOD_FORMATTER

public static final ConfigOption<CoreOptions.TagPeriodFormatter> TAG_PERIOD_FORMATTER

TAG_NUM_RETAINED_MAX

public static final ConfigOption<Integer> TAG_NUM_RETAINED_MAX

TAG_DEFAULT_TIME_RETAINED

public static final ConfigOption<java.time.Duration> TAG_DEFAULT_TIME_RETAINED

TAG_AUTOMATIC_COMPLETION

public static final ConfigOption<Boolean> TAG_AUTOMATIC_COMPLETION

SNAPSHOT_WATERMARK_IDLE_TIMEOUT

public static final ConfigOption<java.time.Duration> SNAPSHOT_WATERMARK_IDLE_TIMEOUT

PARQUET_ENABLE_DICTIONARY

public static final ConfigOption<Integer> PARQUET_ENABLE_DICTIONARY

SINK_WATERMARK_TIME_ZONE

public static final ConfigOption<String> SINK_WATERMARK_TIME_ZONE

LOCAL_MERGE_BUFFER_SIZE

public static final ConfigOption<MemorySize> LOCAL_MERGE_BUFFER_SIZE

CROSS_PARTITION_UPSERT_INDEX_TTL

public static final ConfigOption<java.time.Duration> CROSS_PARTITION_UPSERT_INDEX_TTL

CROSS_PARTITION_UPSERT_BOOTSTRAP_PARALLELISM

public static final ConfigOption<Integer> CROSS_PARTITION_UPSERT_BOOTSTRAP_PARALLELISM

ZORDER_VAR_LENGTH_CONTRIBUTION

public static final ConfigOption<Integer> ZORDER_VAR_LENGTH_CONTRIBUTION

FILE_READER_ASYNC_THRESHOLD

public static final ConfigOption<MemorySize> FILE_READER_ASYNC_THRESHOLD

COMMIT_FORCE_CREATE_SNAPSHOT

public static final ConfigOption<Boolean> COMMIT_FORCE_CREATE_SNAPSHOT

DELETION_VECTORS_ENABLED

public static final ConfigOption<Boolean> DELETION_VECTORS_ENABLED

DELETION_VECTOR_INDEX_FILE_TARGET_SIZE

public static final ConfigOption<MemorySize> DELETION_VECTOR_INDEX_FILE_TARGET_SIZE

DELETION_FORCE_PRODUCE_CHANGELOG

public static final ConfigOption<Boolean> DELETION_FORCE_PRODUCE_CHANGELOG

SORT_RANG_STRATEGY

public static final ConfigOption<CoreOptions.RangeStrategy> SORT_RANG_STRATEGY

SORT_COMPACTION_SAMPLE_MAGNIFICATION

public static final ConfigOption<Integer> SORT_COMPACTION_SAMPLE_MAGNIFICATION

RECORD_LEVEL_EXPIRE_TIME

public static final ConfigOption<java.time.Duration> RECORD_LEVEL_EXPIRE_TIME

RECORD_LEVEL_TIME_FIELD

public static final ConfigOption<String> RECORD_LEVEL_TIME_FIELD

FIELDS_DEFAULT_AGG_FUNC

public static final ConfigOption<String> FIELDS_DEFAULT_AGG_FUNC

COMMIT_USER_PREFIX

public static final ConfigOption<String> COMMIT_USER_PREFIX

FORCE_LOOKUP

public static final ConfigOption<Boolean> FORCE_LOOKUP

LOOKUP_WAIT

public static final ConfigOption<Boolean> LOOKUP_WAIT

DELETE_FILE_THREAD_NUM

public static final ConfigOption<Integer> DELETE_FILE_THREAD_NUM

SCAN_FALLBACK_BRANCH

public static final ConfigOption<String> SCAN_FALLBACK_BRANCH

ASYNC_FILE_WRITE

public static final ConfigOption<Boolean> ASYNC_FILE_WRITE

MATERIALIZED_TABLE_DEFINITION_QUERY

public static final ConfigOption<String> MATERIALIZED_TABLE_DEFINITION_QUERY

MATERIALIZED_TABLE_INTERVAL_FRESHNESS

public static final ConfigOption<String> MATERIALIZED_TABLE_INTERVAL_FRESHNESS

MATERIALIZED_TABLE_INTERVAL_FRESHNESS_TIME_UNIT

public static final ConfigOption<CoreOptions.MaterializedTableIntervalFreshnessTimeUnit> MATERIALIZED_TABLE_INTERVAL_FRESHNESS_TIME_UNIT

MATERIALIZED_TABLE_LOGICAL_REFRESH_MODE

public static final ConfigOption<CoreOptions.MaterializedTableRefreshMode> MATERIALIZED_TABLE_LOGICAL_REFRESH_MODE

MATERIALIZED_TABLE_REFRESH_MODE

public static final ConfigOption<CoreOptions.MaterializedTableRefreshMode> MATERIALIZED_TABLE_REFRESH_MODE

MATERIALIZED_TABLE_REFRESH_STATUS

public static final ConfigOption<CoreOptions.MaterializedTableRefreshStatus> MATERIALIZED_TABLE_REFRESH_STATUS

MATERIALIZED_TABLE_REFRESH_HANDLER_DESCRIPTION

public static final ConfigOption<String> MATERIALIZED_TABLE_REFRESH_HANDLER_DESCRIPTION

MATERIALIZED_TABLE_REFRESH_HANDLER_BYTES

public static final ConfigOption<String> MATERIALIZED_TABLE_REFRESH_HANDLER_BYTES

IMMUTABLE_OPTIONS

public static final Set<String> IMMUTABLE_OPTIONS

Constructor Detail

CoreOptions

public CoreOptions(Map<String,String> options)

CoreOptions
```
public CoreOptions(Options options)
```

Method Detail

fromMap

public static CoreOptions fromMap(Map<String,String> options)

toConfiguration
```
public Options toConfiguration()
```

toMap
```
public Map<String,String> toMap()
```

bucket
```
public int bucket()
```

path
```
public Path path()
```

branch
```
public String branch()
```

branch

public static String branch(Map<String,String> options)

path

public static Path path(Map<String,String> options)

path

public static Path path(Options options)

formatType
```
public String formatType()
```

fileFormat
```
public FileFormat fileFormat()
```

manifestFormat
```
public FileFormat manifestFormat()
```

manifestCompression
```
public String manifestCompression()
```

manifestTargetSize

public MemorySize manifestTargetSize()

manifestFullCompactionThresholdSize

public MemorySize manifestFullCompactionThresholdSize()

writeManifestCache

public MemorySize writeManifestCache()

partitionDefaultName
```
public String partitionDefaultName()
```

legacyPartitionName
```
public boolean legacyPartitionName()
```

sortBySize
```
public boolean sortBySize()
```

getLocalSampleMagnification

public Integer getLocalSampleMagnification()

createFileFormat

public static FileFormat createFileFormat(Options options,
                                          ConfigOption<String> formatOption)

fileCompressionPerLevel

public Map<Integer,String> fileCompressionPerLevel()

fileFormatPerLevel

public Map<Integer,String> fileFormatPerLevel()

dataFilePrefix
```
public String dataFilePrefix()
```

changelogFilePrefix
```
public String changelogFilePrefix()
```

fileSuffixIncludeCompression

public boolean fileSuffixIncludeCompression()

fieldsDefaultFunc
```
public String fieldsDefaultFunc()
```

createCommitUser

public static String createCommitUser(Options options)

createCommitUser
```
public String createCommitUser()
```

definedAggFunc
```
public boolean definedAggFunc()
```

fieldAggFunc

public String fieldAggFunc(String fieldName)

fieldAggIgnoreRetract

public boolean fieldAggIgnoreRetract(String fieldName)

fieldNestedUpdateAggNestedKey

public List<String> fieldNestedUpdateAggNestedKey(String fieldName)

fieldCollectAggDistinct

public boolean fieldCollectAggDistinct(String fieldName)

fieldListAggDelimiter

public String fieldListAggDelimiter(String fieldName)

fileCompression

@Nullable
public String fileCompression()

fileReaderAsyncThreshold

public MemorySize fileReaderAsyncThreshold()

snapshotNumRetainMin
```
public int snapshotNumRetainMin()
```

snapshotNumRetainMax
```
public int snapshotNumRetainMax()
```

snapshotTimeRetain

public java.time.Duration snapshotTimeRetain()

changelogNumRetainMin
```
public int changelogNumRetainMin()
```

changelogNumRetainMax
```
public int changelogNumRetainMax()
```

changelogTimeRetain

public java.time.Duration changelogTimeRetain()

changelogLifecycleDecoupled

public boolean changelogLifecycleDecoupled()

snapshotExpireExecutionMode

public CoreOptions.ExpireExecutionMode snapshotExpireExecutionMode()

snapshotExpireLimit
```
public int snapshotExpireLimit()
```

cleanEmptyDirectories

public boolean cleanEmptyDirectories()

deleteFileThreadNum
```
public int deleteFileThreadNum()
```

endInputCheckPartitionExpire

public boolean endInputCheckPartitionExpire()

expireConfig
```
public ExpireConfig expireConfig()
```

manifestMergeMinCount
```
public int manifestMergeMinCount()
```

mergeEngine

public CoreOptions.MergeEngine mergeEngine()

ignoreDelete
```
public boolean ignoreDelete()
```

sortEngine

public CoreOptions.SortEngine sortEngine()

sortSpillThreshold
```
public int sortSpillThreshold()
```

splitTargetSize
```
public long splitTargetSize()
```

splitOpenFileCost
```
public long splitOpenFileCost()
```

writeBufferSize
```
public long writeBufferSize()
```

writeBufferSpillable

public boolean writeBufferSpillable(boolean usingObjectStore,
                                    boolean isStreaming)

writeBufferSpillDiskSize

public MemorySize writeBufferSpillDiskSize()

useWriteBufferForAppend

public boolean useWriteBufferForAppend()

writeMaxWritersToSpill
```
public int writeMaxWritersToSpill()
```

sortSpillBufferSize
```
public long sortSpillBufferSize()
```

spillCompressOptions

public CompressOptions spillCompressOptions()

lookupCompressOptions

public CompressOptions lookupCompressOptions()

continuousDiscoveryInterval

public java.time.Duration continuousDiscoveryInterval()

scanSplitMaxPerTask
```
public int scanSplitMaxPerTask()
```

localSortMaxNumFileHandles

public int localSortMaxNumFileHandles()

pageSize
```
public int pageSize()
```

cachePageSize
```
public int cachePageSize()
```

lookupLocalFileType

public CoreOptions.LookupLocalFileType lookupLocalFileType()

lookupCacheMaxMemory

public MemorySize lookupCacheMaxMemory()

targetFileSize

public long targetFileSize(boolean hasPrimaryKey)

compactionFileSize

public long compactionFileSize(boolean hasPrimaryKey)

numSortedRunCompactionTrigger

public int numSortedRunCompactionTrigger()

optimizedCompactionInterval

@Nullable
public java.time.Duration optimizedCompactionInterval()

numSortedRunStopTrigger
```
public int numSortedRunStopTrigger()
```

numLevels
```
public int numLevels()
```

commitForceCompact
```
public boolean commitForceCompact()
```

commitMaxRetries
```
public int commitMaxRetries()
```

maxSizeAmplificationPercent

public int maxSizeAmplificationPercent()

sortedRunSizeRatio
```
public int sortedRunSizeRatio()
```

compactionMinFileNum
```
public int compactionMinFileNum()
```

compactionMaxFileNum

public Optional<Integer> compactionMaxFileNum()

dynamicBucketTargetRowNum

public long dynamicBucketTargetRowNum()

changelogProducer

public CoreOptions.ChangelogProducer changelogProducer()

needLookup
```
public boolean needLookup()
```

lookupStrategy

public LookupStrategy lookupStrategy()

changelogRowDeduplicate

public boolean changelogRowDeduplicate()

changelogRowDeduplicateIgnoreFields

public List<String> changelogRowDeduplicateIgnoreFields()

scanPlanSortPartition

public boolean scanPlanSortPartition()

startupMode

public CoreOptions.StartupMode startupMode()

startupMode

public static CoreOptions.StartupMode startupMode(Options options)

scanTimestampMills
```
public Long scanTimestampMills()
```

scanTimestamp
```
public String scanTimestamp()
```

scanWatermark
```
public Long scanWatermark()
```

scanFileCreationTimeMills

public Long scanFileCreationTimeMills()

scanBoundedWatermark
```
public Long scanBoundedWatermark()
```

scanSnapshotId
```
public Long scanSnapshotId()
```

scanTagName
```
public String scanTagName()
```

scanVersion
```
public String scanVersion()
```

incrementalBetween

public Pair<String,String> incrementalBetween()

incrementalBetweenScanMode

public CoreOptions.IncrementalBetweenScanMode incrementalBetweenScanMode()

scanManifestParallelism

public Integer scanManifestParallelism()

streamingReadDelay

public java.time.Duration streamingReadDelay()

dynamicBucketInitialBuckets

public Integer dynamicBucketInitialBuckets()

dynamicBucketAssignerParallelism

public Integer dynamicBucketAssignerParallelism()

sequenceField
```
public List<String> sequenceField()
```

sequenceFieldSortOrderIsAscending

public boolean sequenceFieldSortOrderIsAscending()

partialUpdateRemoveRecordOnDelete

public boolean partialUpdateRemoveRecordOnDelete()

rowkindField

public Optional<String> rowkindField()

writeOnly
```
public boolean writeOnly()
```

streamingReadOverwrite

public boolean streamingReadOverwrite()

dynamicPartitionOverwrite

public boolean dynamicPartitionOverwrite()

partitionExpireTime

public java.time.Duration partitionExpireTime()

partitionExpireCheckInterval

public java.time.Duration partitionExpireCheckInterval()

partitionExpireStrategy

public CoreOptions.PartitionExpireStrategy partitionExpireStrategy()

partitionTimestampFormatter

public String partitionTimestampFormatter()

partitionTimestampPattern

public String partitionTimestampPattern()

consumerId
```
public String consumerId()
```

streamReadType

public static CoreOptions.StreamingReadMode streamReadType(Options options)

consumerExpireTime

public java.time.Duration consumerExpireTime()

consumerIgnoreProgress

public boolean consumerIgnoreProgress()

partitionedTableInMetastore

public boolean partitionedTableInMetastore()

tagToPartitionField

@Nullable
public String tagToPartitionField()

tagToPartitionPreview

public CoreOptions.TagCreationMode tagToPartitionPreview()

tagCreationMode

public CoreOptions.TagCreationMode tagCreationMode()

tagCreationPeriod

public CoreOptions.TagCreationPeriod tagCreationPeriod()

tagCreationDelay

public java.time.Duration tagCreationDelay()

tagPeriodFormatter

public CoreOptions.TagPeriodFormatter tagPeriodFormatter()

tagNumRetainedMax

@Nullable
public Integer tagNumRetainedMax()

tagDefaultTimeRetained

public java.time.Duration tagDefaultTimeRetained()

tagAutomaticCompletion

public boolean tagAutomaticCompletion()

snapshotWatermarkIdleTimeout

public java.time.Duration snapshotWatermarkIdleTimeout()

sinkWatermarkTimeZone
```
public String sinkWatermarkTimeZone()
```

forceCreatingSnapshot

public boolean forceCreatingSnapshot()

getFieldDefaultValues

public Map<String,String> getFieldDefaultValues()

commitCallbacks

public Map<String,String> commitCallbacks()

tagCallbacks

public Map<String,String> tagCallbacks()

localMergeEnabled
```
public boolean localMergeEnabled()
```

localMergeBufferSize
```
public long localMergeBufferSize()
```

crossPartitionUpsertIndexTtl

public java.time.Duration crossPartitionUpsertIndexTtl()

crossPartitionUpsertBootstrapParallelism

public int crossPartitionUpsertBootstrapParallelism()

varTypeSize
```
public int varTypeSize()
```

deletionVectorsEnabled

public boolean deletionVectorsEnabled()

deletionVectorIndexFileTargetSize

public MemorySize deletionVectorIndexFileTargetSize()

indexColumnsOptions

public FileIndexOptions indexColumnsOptions()

fileIndexInManifestThreshold

public long fileIndexInManifestThreshold()

fileIndexReadEnabled
```
public boolean fileIndexReadEnabled()
```

deleteForceProduceChangelog

public boolean deleteForceProduceChangelog()

recordLevelExpireTime

@Nullable
public java.time.Duration recordLevelExpireTime()

recordLevelTimeField

@Nullable
public String recordLevelTimeField()

prepareCommitWaitCompaction

public boolean prepareCommitWaitCompaction()

asyncFileWrite
```
public boolean asyncFileWrite()
```

statsDenseStore
```
public boolean statsDenseStore()
```

setDefaultValues
```
public static void setDefaultValues(Options options)
```
Set the default values of the CoreOptions via the given Options.

Parameters:

options - the options to set default values

getOptions

public static List<ConfigOption<?>> getOptions()

Back to Paimon Website

Class CoreOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_VALUE_SUFFIX

FIELDS_PREFIX

FIELDS_SEPARATOR

AGG_FUNCTION

DEFAULT_AGG_FUNCTION

IGNORE_RETRACT

NESTED_KEY

DISTINCT

LIST_AGG_DELIMITER

FILE_INDEX

COLUMNS

TYPE

BUCKET

BUCKET_KEY

PATH

BRANCH

FILE_FORMAT_ORC

FILE_FORMAT_AVRO

FILE_FORMAT_PARQUET

FILE_FORMAT

FILE_COMPRESSION_PER_LEVEL

FILE_FORMAT_PER_LEVEL

FILE_COMPRESSION

FILE_COMPRESSION_ZSTD_LEVEL

DATA_FILE_PREFIX

CHANGELOG_FILE_PREFIX

FILE_SUFFIX_INCLUDE_COMPRESSION

FILE_BLOCK_SIZE

FILE_INDEX_IN_MANIFEST_THRESHOLD

FILE_INDEX_READ_ENABLED

MANIFEST_FORMAT

MANIFEST_COMPRESSION

MANIFEST_TARGET_FILE_SIZE

MANIFEST_FULL_COMPACTION_FILE_SIZE

MANIFEST_MERGE_MIN_COUNT

PARTITION_DEFAULT_NAME

PARTITION_GENERATE_LEGCY_NAME

SNAPSHOT_NUM_RETAINED_MIN

SNAPSHOT_NUM_RETAINED_MAX

SNAPSHOT_TIME_RETAINED

CHANGELOG_NUM_RETAINED_MIN

CHANGELOG_NUM_RETAINED_MAX

CHANGELOG_TIME_RETAINED

SNAPSHOT_EXPIRE_EXECUTION_MODE

SNAPSHOT_EXPIRE_LIMIT

SNAPSHOT_CLEAN_EMPTY_DIRECTORIES

CONTINUOUS_DISCOVERY_INTERVAL

SCAN_MAX_SPLITS_PER_TASK

MERGE_ENGINE

IGNORE_DELETE

SORT_ENGINE

SORT_SPILL_THRESHOLD

SORT_SPILL_BUFFER_SIZE

SPILL_COMPRESSION

SPILL_COMPRESSION_ZSTD_LEVEL

WRITE_ONLY

SOURCE_SPLIT_TARGET_SIZE

SOURCE_SPLIT_OPEN_FILE_COST

WRITE_BUFFER_SIZE

WRITE_BUFFER_MAX_DISK_SIZE

WRITE_BUFFER_SPILLABLE

WRITE_BUFFER_FOR_APPEND

WRITE_MAX_WRITERS_TO_SPILL

WRITE_MANIFEST_CACHE

LOCAL_SORT_MAX_NUM_FILE_HANDLES

PAGE_SIZE

CACHE_PAGE_SIZE

TARGET_FILE_SIZE

NUM_SORTED_RUNS_COMPACTION_TRIGGER

NUM_SORTED_RUNS_STOP_TRIGGER

NUM_LEVELS

COMMIT_FORCE_COMPACT