Skip to content

[doc](config) add some be config doc #1097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
384 changes: 384 additions & 0 deletions docs/admin-manual/config/be-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -1356,6 +1356,390 @@ Indicates how many tablets failed to load in the data directory. At the same tim
* Description: The `max_filter_ratio` limit can only work if the total rows of `group commit` is less than this value. See [Group Commit](../../data-operate/import/group-commit-manual.md) for more details
* Default: 10000

#### `LZ4_HC_compression_level`
* Description: level of compression when using LZ4_HC
* Default: LZ4HC_CLEVEL_DEFAULT

#### `agent_task_trace_threshold_sec`
* Description: Threshold to logging agent task trace, in seconds.
* Default: 2

#### `allow_invalid_decimalv2_literal`
* Description: Allow invalid decimalv2 literal for compatible with old version. Recommend set it false strongly.
* Default: false

#### `allow_zero_date`
* Description: Convert date 0000-00-00 to 0000-01-01. It's recommended to set to false
* Default: false

#### `alter_index_worker_count`
* Description: the count of thread to alter index
* Default: 3

#### `arrow_flight_result_sink_buffer_size_rows`
* Description: arrow flight result sink buffer rows size
* Default: 4096 * 8

#### `auto_inc_fetch_thread_num`
* Description: number of threads that fetch auto-inc ranges from FE
* Default: 3

#### `auto_inc_low_water_level_mark_size_ratio`
* Description: the ratio of _low_level_water_level_mark/_batch_size in AutoIncIDBuffer
* Default: 3

#### `auto_inc_prefetch_size_ratio`
* Description: the ratio of _prefetch_size/_batch_size in AutoIncIDBuffer
* Default: 10

#### `be_node_role`
* Description: Node role tag for backend. Mix role is the default role, and computation role have no any tablet.
* Default: mix

#### `be_proc_monitor_interval_ms`
* Description: How often to obtain information about the BE process
* Default: 10000

#### `bitmap_serialize_version`
* Description: the version of bitmap type to serialize
* Default: 1

#### `brpc_heavy_work_pool_max_queue_size`
* Description: brpc heavy_work_pool max queue size, if it's -1, get max(10240, CpuInfo::num_cores() * 320)
* Default: -1

#### `brpc_heavy_work_pool_threads`
* Description: brpc heavy_work_pool threads num. if it's -1, get max(128, CpuInfo::num_cores() * 4)
* Default: -1

#### `brpc_light_work_pool_max_queue_size`
* Description: brpc light_work_pool max queue size, if it's -1, get max(10240, CpuInfo::num_cores() * 320)
* Default: -1

#### `brpc_light_work_pool_threads`
* Description: brpc light_work_pool threads num. if it's -1, get max(128, CpuInfo::num_cores() * 4)
* Default: -1

#### `brpc_idle_timeout_sec`
* Description: the time of brpc server keep idle connection, setting this value too small may cause rpc between backends to fail the default value is set to -1, which means never close idle connection.
* Default: -1

#### `ca_cert_file_paths`
* Description: the file paths(one or more) of CA cert, splite using ";" aws s3 lib use it to init s3client
* Default: "/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/ssl/ca-bundle.pem"

#### `calc_delete_bitmap_max_thread`
* Description: the count of thread to calc delete bitmap
* Default: 32

#### `calc_delete_bitmap_worker_count`
* Description: the count of thread to calc delete bitmap worker, only used for cloud
* Default: 8

#### `calc_tablet_delete_bitmap_task_max_thread`
* Description: the count of thread to calc tablet delete bitmap task, only used for cloud
* Default: 32

#### `check_segment_when_build_rowset_meta`
* Description: whether need to check the segment size when building rowset meta
* Default: false

#### `clean_stream_load_record_interval_secs`
* Description: time interval to clean expired stream load records
* Default: 1800

#### `clear_file_cache`
* Description: whether need to clean up the file cache
* Default: false

#### `crash_in_alloc_large_memory_bytes`
* Description: when alloc memory larger than crash_in_alloc_large_memory_bytes will crash, default -1 means disabled. if you need a core dump to analyze large memory allocation, modify this parameter to crash when large memory allocation occur will help
* Default: -1

#### `data_page_cache_stale_sweep_time_sec`
* Description: data page cache stale sweep time sec
* Default: 300

#### `debug_inverted_index_compaction`
* Description: Only for debug inverted_index_compaction, do not use in production
* Default: false

#### `delete_bitmap_agg_cache_capacity`
* Description: Global bitmap cache capacity for aggregation cache, size in bytes
* Default: 104857600

#### `delete_bitmap_agg_cache_stale_sweep_time_sec`
* Description: delete_bitmap agg-cache stale sweep time sec
* Default: 1800

#### `disable_memory_gc`
* Description: gc will release cache, cancel task, and task will wait for gc to release memory, default gc strategy is conservative, if you want to exclude the interference of gc, let it be true
* Default: false

#### `disable_pk_storage_page_cache`
* Description: whether to disable pk page cache feature in storage
* Default: false

#### `disable_segment_cache`
* Description: whether to disable segment cache feature in storage
* Default: false

#### `disable_storage_row_cache`
* Description: whether to disable row cache feature in storage
* Default: true

#### `doris_remote_scanner_thread_pool_queue_size`
* Description: number of remote_scanner thread pool queue size
* Default: 102400

#### `doris_remote_scanner_thread_pool_thread_num`
* Description: number of remote_scanner thread pool size
* Default: 48

#### `doris_scanner_min_thread_pool_thread_num`
* Description: Minimum number of threads in the scanner thread pool in doris
* Default: 8

#### `double_resize_threshold`
* Description: Increase the size threshold for detecting hash table re-expansion
* Default: 23

#### `download_binlog_rate_limit_kbs`
* Description: Download binlog rate limit, unit is KB/s
* Default: 0

#### `dwarf_location_info_mode`
* Description: DISABLED: Don't resolve location info. FAST: Perform CU lookup using .debug_aranges (might be incomplete). FULL: Scan all CU in .debug_info (slow!) on .debug_aranges lookup failure. FULL_WITH_INLINE: Scan .debug_info (super slower, use with caution) for inline functions in addition to FULL.
* Default: FAST

#### `enable_address_sanitizers_with_stack_trace`
* Description: Whether to output the relevant stack when Address Sanitizer is turned on
* Default: true

#### `enable_all_http_auth`
* Description: Whether to check authorization
* Default: false

#### `enable_be_proc_monitor`
* Description: whether need to enable the collection of relevant information of the BE process
* Default: false

#### `enable_brpc_stream_write_background`
* Description: enable write background when using brpc stream
* Default: true

#### `enable_bthread_transmit_block`
* Description: Whether to use bthread to transfer blocks
* Default: true

#### `enable_column_type_check`
* Description: Whether to enable column type consistency detection when reading data
* Default: true

#### `enable_compaction_checksum`
* Description: whether check compaction checksum
* Default: false

#### `enable_debug_log_timeout_secs`
* Description: Used for pipeline task execution timeout detection
* Default: 0

#### `enable_debug_points`
* Description: Whether to enable debug points test
* Default: false

#### `enable_delete_when_cumu_compaction`
* Description: whether apply delete pred in cumu compaction
* Default: false

#### `enable_feature_binlog`
* Description: whether enable binlog
* Default: false

#### `enable_file_cache`
* Description: enable block file cache
* Default: false

#### `enable_flush_file_cache_async`
* Description: This config controls whether the s3 file writer would flush cache asynchronously
* Default: true

#### `enable_fuzzy_mode`
* Description: Whether to enable BE fuzzy test
* Default: false

#### `enable_je_purge_dirty_pages`
* Description: Purge all unused dirty pages for all arenas
* Default: true

#### `enable_jvm_monitor`
* Description: whether enable JVM monitoring
* Default: false

#### `enable_low_cardinality_cache_code`
* Description: Whether to enable the low_cardinality cache code feature
* Default: true

#### `enable_low_cardinality_optimize`
* Description: Whether to enable low_cardinality optimization feature
* Default: true

#### `enable_memory_orphan_check`
* Description: default is true. if any memory tracking in Orphan mem tracker will report error. not modify the default value of this conf!! otherwise memory errors cannot be detected in time. allocator free memory not need to check, because when the thread memory tracker label is Orphan, use the tracker saved in Allocator.
* Default: true

#### `enable_merge_on_write_correctness_check`
* Description: Whether to enable unique correctness detection of MOW table
* Default: true

#### `enable_missing_rows_correctness_check`
* Description: missing rows correctness check when compaction for mow table
* Default: false

#### `enable_mow_compaction_correctness_check_core`
* Description: coredump directly if the compaction found there's duplicate key on mow table
* Default: false

#### `enable_parquet_page_index`
* Description: If set to false, the parquet reader will not use page index to filter data, only debug
* Default: false

#### `enable_rowid_conversion_correctness_check`
* Description: rowid conversion correctness check when compaction for mow table
* Default: false

#### `enable_set_in_bitmap_value`
* Description: enable set in BitmapValue
* Default: true

#### `enable_shrink_memory`
* Description: enable shrink memory at memory table
* Default: false

#### `enable_stacktrace`
* Description: if false, turn off all stacktrace
* Default: true

#### `enable_stream_load_commit_txn_on_be`
* Description: enable stream load commit txn on BE directly, bypassing FE. Only for cloud.
* Default: false

#### `enable_time_lut`
* Description: Look-up table for datetime runtime calculations
* Default: true

#### `enable_ttl_cache_evict_using_lru`
* Description: If true, evict the ttl cache using LRU when full. Otherwise, only expiration can evict ttl and new data won't add to cache when full.
* Default: true

#### `enable_use_cgroup_memory_info`
* Description: if true, process memory limit and memory usage based on cgroup memory info
* Default: true

#### `enable_vertical_segment_writer`
* Description: If enabled, segments will be flushed column by column
* Default: true

#### `enable_workload_group_memory_gc`
* Description: Enable memory GC for workload_group
* Default: true

#### `estimated_mem_per_column_reader`
* Description: Estimate the memory size of each column
* Default: 1024

#### `exchange_sink_ignore_eovercrowded`
* Description: Whether to ignore overcrowded errors in exchange-sink nodes
* Default: true

#### `exchg_buffer_queue_capacity_factor`
* Description: The queue size in the exchange-sink buffer
* Default: 64

#### `exit_on_exception`
* Description: Use `LOG(FATAL)` to replace `throw` when true
* Default: false

#### `hash_table_double_grow_degree`
* Description: When hash table capacity is greater than 2^double_grow_degree(default 2G), grow when 75% of the capacity is satisfied. Increase can reduce the number of hash table resize, but may waste more memory.
* Default: 31

#### `max_depth_of_expr_tree`
* Description: max depth of expression tree allowed
* Default: 600

#### `num_cores`
* Description: Number of cores Doris will used, this will effect only when it's greater than 0. Otherwise, Doris will use all cores returned from "/proc/cpuinfo".
* Default: 0

#### `num_disks`
* Description: Control the number of disks on the machine. If 0, this comes from the system settings.
* Default: 0

#### `pipeline_executor_size`
* Description: The number of available cores when pipeline scheduling is executed. When this value is less than or equal to 0, the number of CPU cores is used.
* Default: 0

#### `pipeline_task_leakage_detect_period_secs`
* Description: Pipeline task residual detection interval
* Default: 60

#### `query_cache_elasticity_size_mb`
* Description: Cache memory is pruned when reach query_cache_max_size_mb + query_cache_elasticity_size_mb
* Default: 128

#### `query_cache_max_partition_count`
* Description: Maximum number of cache partitions corresponding to a SQL
* Default: 1024

#### `query_cache_max_size_mb`
* Description: Set max cache's size of query results, the unit is M byte
* Default: 256

#### `query_statistics_reserve_timeout_ms`
* Description: Query statistics report timeout
* Default: 30000

#### `report_exec_status_thread_num`
* Description: query statistics report the number of worker threads
* Default: 5

#### `report_query_statistics_interval_ms`
* Description: Query statistics report interval
* Default: 3000

#### `scan_thread_nice_value`
* Description: The configuration item is used to lower the priority of the scanner thread, typically employed to ensure CPU scheduling for write operations. Default is 0, which is default value of thread nice value, increase this value to lower the priority of scan threads
* Default: 0

#### `soft_mem_limit_frac`
* Description: Soft memory limit as a fraction of hard memory limit.
* Default: 0.9

#### `stacktrace_in_alloc_large_memory_bytes`
* Description: when alloc memory larger than stacktrace_in_alloc_large_memory_bytes, default 2G, if alloc successful, will print a warning with stacktrace, but not prevent memory alloc. if alloc failed using Doris Allocator, will print stacktrace in error log. if is -1, disable print stacktrace when alloc large memory.
* Default: 2147483648

#### `string_overflow_size`
* Description: The maximum number of characters that can be stored in a String type
* Default: 4294967295

#### `thread_wait_gc_max_milliseconds`
* Description: The maximum time a thread waits for a full GC. Currently only query will wait for full gc.
* Default: 1000

#### `thrift_client_open_num_tries`
* Description: Number of open tries, default 1 means only try to open once, Retry the Open num_retries time waiting 100 milliseconds between retries
* Default: 1

#### `topn_agg_limit_multiplier`
* Description: Define how many percent data in hashtable bigger than limit, we should do agg limit opt
* Default: 2

#### `wg_weighted_memory_ratio_refresh_interval_ms`
* Description: Sleep time in milliseconds between refresh iterations of workload group weighted memory ratio
* Default: 50

### Compute and Storage Disaggregated Mode

#### `deploy_mode`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Integer value ranges: TINYINT, SMALLINT, INT, BIGINT, LARGEINT."

### example

``` sql
mysql [(none)]>SELECT bit_test(43, 1);
+-----------------+
| bit_test(43, 1) |
Expand Down
Loading
Loading