public class CoreOptions extends Object implements Serializable
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.
|
Constructor and Description |
---|
CoreOptions(Map<String,String> options) |
CoreOptions(Options options) |
public static final String DEFAULT_VALUE_SUFFIX
public static final String FIELDS_PREFIX
public static final String FIELDS_SEPARATOR
public static final String AGG_FUNCTION
public static final String DEFAULT_AGG_FUNCTION
public static final String IGNORE_RETRACT
public static final String NESTED_KEY
public static final String DISTINCT
public static final String LIST_AGG_DELIMITER
public static final String FILE_INDEX
public static final String COLUMNS
public static final ConfigOption<TableType> TYPE
public static final ConfigOption<Integer> BUCKET
public static final ConfigOption<String> BUCKET_KEY
public static final ConfigOption<String> PATH
public static final ConfigOption<String> BRANCH
public static final String FILE_FORMAT_ORC
public static final String FILE_FORMAT_AVRO
public static final String FILE_FORMAT_PARQUET
public static final ConfigOption<String> FILE_FORMAT
public static final ConfigOption<Map<String,String>> FILE_COMPRESSION_PER_LEVEL
public static final ConfigOption<Map<String,String>> FILE_FORMAT_PER_LEVEL
public static final ConfigOption<String> FILE_COMPRESSION
public static final ConfigOption<Integer> FILE_COMPRESSION_ZSTD_LEVEL
public static final ConfigOption<String> DATA_FILE_PREFIX
public static final ConfigOption<String> CHANGELOG_FILE_PREFIX
public static final ConfigOption<Boolean> FILE_SUFFIX_INCLUDE_COMPRESSION
public static final ConfigOption<MemorySize> FILE_BLOCK_SIZE
public static final ConfigOption<MemorySize> FILE_INDEX_IN_MANIFEST_THRESHOLD
public static final ConfigOption<Boolean> FILE_INDEX_READ_ENABLED
public static final ConfigOption<String> MANIFEST_FORMAT
public static final ConfigOption<String> MANIFEST_COMPRESSION
public static final ConfigOption<MemorySize> MANIFEST_TARGET_FILE_SIZE
public static final ConfigOption<MemorySize> MANIFEST_FULL_COMPACTION_FILE_SIZE
public static final ConfigOption<Integer> MANIFEST_MERGE_MIN_COUNT
public static final ConfigOption<String> PARTITION_DEFAULT_NAME
public static final ConfigOption<Boolean> PARTITION_GENERATE_LEGCY_NAME
public static final ConfigOption<Integer> SNAPSHOT_NUM_RETAINED_MIN
public static final ConfigOption<Integer> SNAPSHOT_NUM_RETAINED_MAX
public static final ConfigOption<java.time.Duration> SNAPSHOT_TIME_RETAINED
public static final ConfigOption<Integer> CHANGELOG_NUM_RETAINED_MIN
public static final ConfigOption<Integer> CHANGELOG_NUM_RETAINED_MAX
public static final ConfigOption<java.time.Duration> CHANGELOG_TIME_RETAINED
public static final ConfigOption<CoreOptions.ExpireExecutionMode> SNAPSHOT_EXPIRE_EXECUTION_MODE
public static final ConfigOption<Integer> SNAPSHOT_EXPIRE_LIMIT
public static final ConfigOption<Boolean> SNAPSHOT_CLEAN_EMPTY_DIRECTORIES
public static final ConfigOption<java.time.Duration> CONTINUOUS_DISCOVERY_INTERVAL
public static final ConfigOption<Integer> SCAN_MAX_SPLITS_PER_TASK
public static final ConfigOption<CoreOptions.MergeEngine> MERGE_ENGINE
public static final ConfigOption<Boolean> IGNORE_DELETE
public static final ConfigOption<CoreOptions.SortEngine> SORT_ENGINE
public static final ConfigOption<Integer> SORT_SPILL_THRESHOLD
public static final ConfigOption<MemorySize> SORT_SPILL_BUFFER_SIZE
public static final ConfigOption<String> SPILL_COMPRESSION
public static final ConfigOption<Integer> SPILL_COMPRESSION_ZSTD_LEVEL
public static final ConfigOption<Boolean> WRITE_ONLY
public static final ConfigOption<MemorySize> SOURCE_SPLIT_TARGET_SIZE
public static final ConfigOption<MemorySize> SOURCE_SPLIT_OPEN_FILE_COST
public static final ConfigOption<MemorySize> WRITE_BUFFER_SIZE
public static final ConfigOption<MemorySize> WRITE_BUFFER_MAX_DISK_SIZE
public static final ConfigOption<Boolean> WRITE_BUFFER_SPILLABLE
public static final ConfigOption<Boolean> WRITE_BUFFER_FOR_APPEND
public static final ConfigOption<Integer> WRITE_MAX_WRITERS_TO_SPILL
public static final ConfigOption<MemorySize> WRITE_MANIFEST_CACHE
public static final ConfigOption<Integer> LOCAL_SORT_MAX_NUM_FILE_HANDLES
public static final ConfigOption<MemorySize> PAGE_SIZE
public static final ConfigOption<MemorySize> CACHE_PAGE_SIZE
public static final ConfigOption<MemorySize> TARGET_FILE_SIZE
public static final ConfigOption<Integer> NUM_SORTED_RUNS_COMPACTION_TRIGGER
public static final ConfigOption<Integer> NUM_SORTED_RUNS_STOP_TRIGGER
public static final ConfigOption<Integer> NUM_LEVELS
public static final ConfigOption<Boolean> COMMIT_FORCE_COMPACT
public static final ConfigOption<Integer> COMMIT_MAX_RETRIES
public static final ConfigOption<Integer> COMPACTION_MAX_SIZE_AMPLIFICATION_PERCENT
public static final ConfigOption<Integer> COMPACTION_SIZE_RATIO
public static final ConfigOption<java.time.Duration> COMPACTION_OPTIMIZATION_INTERVAL
public static final ConfigOption<Integer> COMPACTION_MIN_FILE_NUM
public static final ConfigOption<Integer> COMPACTION_MAX_FILE_NUM
public static final ConfigOption<CoreOptions.ChangelogProducer> CHANGELOG_PRODUCER
public static final ConfigOption<Boolean> CHANGELOG_PRODUCER_ROW_DEDUPLICATE
public static final ConfigOption<String> CHANGELOG_PRODUCER_ROW_DEDUPLICATE_IGNORE_FIELDS
public static final ConfigOption<String> SEQUENCE_FIELD
public static final ConfigOption<CoreOptions.SortOrder> SEQUENCE_FIELD_SORT_ORDER
public static final ConfigOption<Boolean> PARTIAL_UPDATE_REMOVE_RECORD_ON_DELETE
public static final ConfigOption<String> ROWKIND_FIELD
public static final ConfigOption<CoreOptions.StartupMode> SCAN_MODE
public static final ConfigOption<String> SCAN_TIMESTAMP
public static final ConfigOption<Long> SCAN_TIMESTAMP_MILLIS
public static final ConfigOption<Long> SCAN_WATERMARK
public static final ConfigOption<Long> SCAN_FILE_CREATION_TIME_MILLIS
public static final ConfigOption<Long> SCAN_SNAPSHOT_ID
public static final ConfigOption<String> SCAN_TAG_NAME
public static final ConfigOption<String> SCAN_VERSION
public static final ConfigOption<Long> SCAN_BOUNDED_WATERMARK
public static final ConfigOption<Integer> SCAN_MANIFEST_PARALLELISM
public static final ConfigOption<java.time.Duration> STREAMING_READ_SNAPSHOT_DELAY
public static final ConfigOption<CoreOptions.LogConsistency> LOG_CONSISTENCY
public static final ConfigOption<CoreOptions.LogChangelogMode> LOG_CHANGELOG_MODE
public static final ConfigOption<String> LOG_KEY_FORMAT
public static final ConfigOption<String> LOG_FORMAT
public static final ConfigOption<Boolean> AUTO_CREATE
public static final ConfigOption<Boolean> STREAMING_READ_OVERWRITE
public static final ConfigOption<Boolean> DYNAMIC_PARTITION_OVERWRITE
public static final ConfigOption<CoreOptions.PartitionExpireStrategy> PARTITION_EXPIRATION_STRATEGY
public static final ConfigOption<java.time.Duration> PARTITION_EXPIRATION_TIME
public static final ConfigOption<java.time.Duration> PARTITION_EXPIRATION_CHECK_INTERVAL
public static final ConfigOption<String> PARTITION_TIMESTAMP_FORMATTER
public static final ConfigOption<String> PARTITION_TIMESTAMP_PATTERN
public static final ConfigOption<Boolean> PARTITION_MARK_DONE_WHEN_END_INPUT
public static final ConfigOption<Boolean> SCAN_PLAN_SORT_PARTITION
public static final ConfigOption<String> PRIMARY_KEY
public static final ConfigOption<String> PARTITION
public static final ConfigOption<CoreOptions.LookupLocalFileType> LOOKUP_LOCAL_FILE_TYPE
public static final ConfigOption<Float> LOOKUP_HASH_LOAD_FACTOR
public static final ConfigOption<java.time.Duration> LOOKUP_CACHE_FILE_RETENTION
public static final ConfigOption<MemorySize> LOOKUP_CACHE_MAX_DISK_SIZE
public static final ConfigOption<String> LOOKUP_CACHE_SPILL_COMPRESSION
public static final ConfigOption<MemorySize> LOOKUP_CACHE_MAX_MEMORY_SIZE
public static final ConfigOption<Boolean> LOOKUP_CACHE_BLOOM_FILTER_ENABLED
public static final ConfigOption<Double> LOOKUP_CACHE_BLOOM_FILTER_FPP
public static final ConfigOption<Integer> READ_BATCH_SIZE
public static final ConfigOption<Integer> WRITE_BATCH_SIZE
public static final ConfigOption<String> CONSUMER_ID
public static final ConfigOption<Integer> FULL_COMPACTION_DELTA_COMMITS
public static final ConfigOption<CoreOptions.StreamScanMode> STREAM_SCAN_MODE
public static final ConfigOption<CoreOptions.StreamingReadMode> STREAMING_READ_MODE
public static final ConfigOption<java.time.Duration> CONSUMER_EXPIRATION_TIME
public static final ConfigOption<CoreOptions.ConsumerMode> CONSUMER_CONSISTENCY_MODE
public static final ConfigOption<Boolean> CONSUMER_IGNORE_PROGRESS
public static final ConfigOption<Long> DYNAMIC_BUCKET_TARGET_ROW_NUM
public static final ConfigOption<Integer> DYNAMIC_BUCKET_INITIAL_BUCKETS
public static final ConfigOption<Integer> DYNAMIC_BUCKET_ASSIGNER_PARALLELISM
public static final ConfigOption<String> INCREMENTAL_BETWEEN
public static final ConfigOption<CoreOptions.IncrementalBetweenScanMode> INCREMENTAL_BETWEEN_SCAN_MODE
public static final ConfigOption<String> INCREMENTAL_BETWEEN_TIMESTAMP
public static final ConfigOption<Boolean> END_INPUT_CHECK_PARTITION_EXPIRE
public static final String STATS_MODE_SUFFIX
public static final ConfigOption<String> METADATA_STATS_MODE
public static final ConfigOption<Boolean> METADATA_STATS_DENSE_STORE
public static final ConfigOption<String> COMMIT_CALLBACKS
public static final ConfigOption<String> COMMIT_CALLBACK_PARAM
public static final ConfigOption<String> TAG_CALLBACKS
public static final ConfigOption<String> TAG_CALLBACK_PARAM
public static final ConfigOption<String> PARTITION_MARK_DONE_ACTION
public static final ConfigOption<Boolean> METASTORE_PARTITIONED_TABLE
public static final ConfigOption<String> METASTORE_TAG_TO_PARTITION
public static final ConfigOption<CoreOptions.TagCreationMode> METASTORE_TAG_TO_PARTITION_PREVIEW
public static final ConfigOption<CoreOptions.TagCreationMode> TAG_AUTOMATIC_CREATION
public static final ConfigOption<CoreOptions.TagCreationPeriod> TAG_CREATION_PERIOD
public static final ConfigOption<java.time.Duration> TAG_CREATION_DELAY
public static final ConfigOption<CoreOptions.TagPeriodFormatter> TAG_PERIOD_FORMATTER
public static final ConfigOption<Integer> TAG_NUM_RETAINED_MAX
public static final ConfigOption<java.time.Duration> TAG_DEFAULT_TIME_RETAINED
public static final ConfigOption<Boolean> TAG_AUTOMATIC_COMPLETION
public static final ConfigOption<java.time.Duration> SNAPSHOT_WATERMARK_IDLE_TIMEOUT
public static final ConfigOption<Integer> PARQUET_ENABLE_DICTIONARY
public static final ConfigOption<String> SINK_WATERMARK_TIME_ZONE
public static final ConfigOption<MemorySize> LOCAL_MERGE_BUFFER_SIZE
public static final ConfigOption<java.time.Duration> CROSS_PARTITION_UPSERT_INDEX_TTL
public static final ConfigOption<Integer> CROSS_PARTITION_UPSERT_BOOTSTRAP_PARALLELISM
public static final ConfigOption<Integer> ZORDER_VAR_LENGTH_CONTRIBUTION
public static final ConfigOption<MemorySize> FILE_READER_ASYNC_THRESHOLD
public static final ConfigOption<Boolean> COMMIT_FORCE_CREATE_SNAPSHOT
public static final ConfigOption<Boolean> DELETION_VECTORS_ENABLED
public static final ConfigOption<MemorySize> DELETION_VECTOR_INDEX_FILE_TARGET_SIZE
public static final ConfigOption<Boolean> DELETION_FORCE_PRODUCE_CHANGELOG
public static final ConfigOption<CoreOptions.RangeStrategy> SORT_RANG_STRATEGY
public static final ConfigOption<Integer> SORT_COMPACTION_SAMPLE_MAGNIFICATION
public static final ConfigOption<java.time.Duration> RECORD_LEVEL_EXPIRE_TIME
public static final ConfigOption<String> RECORD_LEVEL_TIME_FIELD
public static final ConfigOption<String> FIELDS_DEFAULT_AGG_FUNC
public static final ConfigOption<String> COMMIT_USER_PREFIX
public static final ConfigOption<Boolean> FORCE_LOOKUP
public static final ConfigOption<Boolean> LOOKUP_WAIT
public static final ConfigOption<Integer> DELETE_FILE_THREAD_NUM
public static final ConfigOption<String> SCAN_FALLBACK_BRANCH
public static final ConfigOption<Boolean> ASYNC_FILE_WRITE
public static final ConfigOption<String> MATERIALIZED_TABLE_DEFINITION_QUERY
public static final ConfigOption<String> MATERIALIZED_TABLE_INTERVAL_FRESHNESS
public static final ConfigOption<CoreOptions.MaterializedTableIntervalFreshnessTimeUnit> MATERIALIZED_TABLE_INTERVAL_FRESHNESS_TIME_UNIT
public static final ConfigOption<CoreOptions.MaterializedTableRefreshMode> MATERIALIZED_TABLE_LOGICAL_REFRESH_MODE
public static final ConfigOption<CoreOptions.MaterializedTableRefreshMode> MATERIALIZED_TABLE_REFRESH_MODE
public static final ConfigOption<CoreOptions.MaterializedTableRefreshStatus> MATERIALIZED_TABLE_REFRESH_STATUS
public static final ConfigOption<String> MATERIALIZED_TABLE_REFRESH_HANDLER_DESCRIPTION
public static final ConfigOption<String> MATERIALIZED_TABLE_REFRESH_HANDLER_BYTES
public CoreOptions(Options options)
public static CoreOptions fromMap(Map<String,String> options)
public Options toConfiguration()
public int bucket()
public Path path()
public String branch()
public String formatType()
public FileFormat fileFormat()
public FileFormat manifestFormat()
public String manifestCompression()
public MemorySize manifestTargetSize()
public MemorySize manifestFullCompactionThresholdSize()
public MemorySize writeManifestCache()
public String partitionDefaultName()
public boolean legacyPartitionName()
public boolean sortBySize()
public Integer getLocalSampleMagnification()
public static FileFormat createFileFormat(Options options, ConfigOption<String> formatOption)
public String dataFilePrefix()
public String changelogFilePrefix()
public boolean fileSuffixIncludeCompression()
public String fieldsDefaultFunc()
public String createCommitUser()
public boolean definedAggFunc()
public boolean fieldAggIgnoreRetract(String fieldName)
public boolean fieldCollectAggDistinct(String fieldName)
public MemorySize fileReaderAsyncThreshold()
public int snapshotNumRetainMin()
public int snapshotNumRetainMax()
public java.time.Duration snapshotTimeRetain()
public int changelogNumRetainMin()
public int changelogNumRetainMax()
public java.time.Duration changelogTimeRetain()
public boolean changelogLifecycleDecoupled()
public CoreOptions.ExpireExecutionMode snapshotExpireExecutionMode()
public int snapshotExpireLimit()
public boolean cleanEmptyDirectories()
public int deleteFileThreadNum()
public boolean endInputCheckPartitionExpire()
public ExpireConfig expireConfig()
public int manifestMergeMinCount()
public CoreOptions.MergeEngine mergeEngine()
public boolean ignoreDelete()
public CoreOptions.SortEngine sortEngine()
public int sortSpillThreshold()
public long splitTargetSize()
public long splitOpenFileCost()
public long writeBufferSize()
public boolean writeBufferSpillable(boolean usingObjectStore, boolean isStreaming)
public MemorySize writeBufferSpillDiskSize()
public boolean useWriteBufferForAppend()
public int writeMaxWritersToSpill()
public long sortSpillBufferSize()
public CompressOptions spillCompressOptions()
public CompressOptions lookupCompressOptions()
public java.time.Duration continuousDiscoveryInterval()
public int scanSplitMaxPerTask()
public int localSortMaxNumFileHandles()
public int pageSize()
public int cachePageSize()
public CoreOptions.LookupLocalFileType lookupLocalFileType()
public MemorySize lookupCacheMaxMemory()
public long targetFileSize(boolean hasPrimaryKey)
public long compactionFileSize(boolean hasPrimaryKey)
public int numSortedRunCompactionTrigger()
@Nullable public java.time.Duration optimizedCompactionInterval()
public int numSortedRunStopTrigger()
public int numLevels()
public boolean commitForceCompact()
public int commitMaxRetries()
public int maxSizeAmplificationPercent()
public int sortedRunSizeRatio()
public int compactionMinFileNum()
public long dynamicBucketTargetRowNum()
public CoreOptions.ChangelogProducer changelogProducer()
public boolean needLookup()
public LookupStrategy lookupStrategy()
public boolean changelogRowDeduplicate()
public boolean scanPlanSortPartition()
public CoreOptions.StartupMode startupMode()
public static CoreOptions.StartupMode startupMode(Options options)
public Long scanTimestampMills()
public String scanTimestamp()
public Long scanWatermark()
public Long scanFileCreationTimeMills()
public Long scanBoundedWatermark()
public Long scanSnapshotId()
public String scanTagName()
public String scanVersion()
public CoreOptions.IncrementalBetweenScanMode incrementalBetweenScanMode()
public Integer scanManifestParallelism()
public java.time.Duration streamingReadDelay()
public Integer dynamicBucketInitialBuckets()
public Integer dynamicBucketAssignerParallelism()
public boolean sequenceFieldSortOrderIsAscending()
public boolean partialUpdateRemoveRecordOnDelete()
public boolean writeOnly()
public boolean streamingReadOverwrite()
public boolean dynamicPartitionOverwrite()
public java.time.Duration partitionExpireTime()
public java.time.Duration partitionExpireCheckInterval()
public CoreOptions.PartitionExpireStrategy partitionExpireStrategy()
public String partitionTimestampFormatter()
public String partitionTimestampPattern()
public String consumerId()
public static CoreOptions.StreamingReadMode streamReadType(Options options)
public java.time.Duration consumerExpireTime()
public boolean consumerIgnoreProgress()
public boolean partitionedTableInMetastore()
public CoreOptions.TagCreationMode tagToPartitionPreview()
public CoreOptions.TagCreationMode tagCreationMode()
public CoreOptions.TagCreationPeriod tagCreationPeriod()
public java.time.Duration tagCreationDelay()
public CoreOptions.TagPeriodFormatter tagPeriodFormatter()
public java.time.Duration tagDefaultTimeRetained()
public boolean tagAutomaticCompletion()
public java.time.Duration snapshotWatermarkIdleTimeout()
public String sinkWatermarkTimeZone()
public boolean forceCreatingSnapshot()
public boolean localMergeEnabled()
public long localMergeBufferSize()
public java.time.Duration crossPartitionUpsertIndexTtl()
public int crossPartitionUpsertBootstrapParallelism()
public int varTypeSize()
public boolean deletionVectorsEnabled()
public MemorySize deletionVectorIndexFileTargetSize()
public FileIndexOptions indexColumnsOptions()
public long fileIndexInManifestThreshold()
public boolean fileIndexReadEnabled()
public boolean deleteForceProduceChangelog()
@Nullable public java.time.Duration recordLevelExpireTime()
public boolean prepareCommitWaitCompaction()
public boolean asyncFileWrite()
public boolean statsDenseStore()
public static void setDefaultValues(Options options)
CoreOptions
via the given Options
.options
- the options to set default valuespublic static List<ConfigOption<?>> getOptions()
Copyright © 2023–2024 The Apache Software Foundation. All rights reserved.