Skip to main content

Module config

Module config 

Source
Expand description

Configurations.

Structsยง

BloomFilterConfig
Configuration options for the bloom filter.
FulltextIndexConfig
Configuration options for the full-text index.
IndexConfig
InvertedIndexConfig
Configuration options for the inverted index.
MitoConfig
Configuration for MitoEngine. Before using the config, call MitoConfig::sanitize() to validate and normalize it.

Enumsยง

IndexBuildMode
Index build mode.
MemoryThreshold
Memory threshold for performing certain actions.
Mode
Operational mode for certain actions.
ScanMemoryMode
Memory accounted against the shared scan limit.

Constantsยง

DEFAULT_MAX_CONCURRENT_SCAN_FILES ๐Ÿ”’
Default maximum number of SST files to scan concurrently.
DEFAULT_SERIES_INDEX_MAINTENANCE_INTERVAL ๐Ÿ”’
FETCH_OPTION_TIMEOUT ๐Ÿ”’
Fetch option timeout
GLOBAL_WRITE_BUFFER_SIZE_FACTOR ๐Ÿ”’
INDEX_CREATE_MEM_THRESHOLD_FACTOR ๐Ÿ”’
Use 1/INDEX_CREATE_MEM_THRESHOLD_FACTOR of OS memory size as mem threshold for creating index
INDEX_METADATA_CACHE_SIZE_FACTOR ๐Ÿ”’
Use 1/INDEX_METADATA_CACHE_SIZE_FACTOR of OS memory size as index metadata cache size in default mode
MEM_CACHE_SIZE_FACTOR ๐Ÿ”’
Use 1/MEM_CACHE_SIZE_FACTOR of OS memory size as mem cache size in default mode
MULTIPART_UPLOAD_MINIMUM_SIZE ๐Ÿ”’
PAGE_CACHE_SIZE_FACTOR ๐Ÿ”’
Use 1/PAGE_CACHE_SIZE_FACTOR of OS memory size as page cache size in default mode
PREFILTER_RESULT_CACHE_SIZE_FACTOR ๐Ÿ”’
Use 1/PREFILTER_RESULT_CACHE_SIZE_FACTOR of OS memory size as prefilter result cache size in default mode
SST_META_CACHE_SIZE_FACTOR ๐Ÿ”’
Use 1/SST_META_CACHE_SIZE_FACTOR of OS memory size as SST meta cache size in default mode

Functionsยง

divide_num_cpus ๐Ÿ”’
Divide cpu num by a non-zero divisor and returns at least 1.