Coverage Report

Created: 2025-12-26 08:54

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/root/doris/be/src/common/config.h
Line
Count
Source
1
// Licensed to the Apache Software Foundation (ASF) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The ASF licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17
18
#pragma once
19
20
#include <cstdint>
21
#include <functional>
22
#include <map>
23
#include <mutex>
24
#include <string>
25
#include <utility>
26
#include <vector>
27
28
#define DECLARE_FIELD(FIELD_TYPE, FIELD_NAME) extern FIELD_TYPE FIELD_NAME
29
30
#define DECLARE_Bool(name) DECLARE_FIELD(bool, name)
31
#define DECLARE_Int16(name) DECLARE_FIELD(int16_t, name)
32
#define DECLARE_Int32(name) DECLARE_FIELD(int32_t, name)
33
#define DECLARE_Int64(name) DECLARE_FIELD(int64_t, name)
34
#define DECLARE_Double(name) DECLARE_FIELD(double, name)
35
#define DECLARE_String(name) DECLARE_FIELD(std::string, name)
36
#define DECLARE_Bools(name) DECLARE_FIELD(std::vector<bool>, name)
37
#define DECLARE_Int16s(name) DECLARE_FIELD(std::vector<int16_t>, name)
38
#define DECLARE_Int32s(name) DECLARE_FIELD(std::vector<int32_t>, name)
39
#define DECLARE_Int64s(name) DECLARE_FIELD(std::vector<int64_t>, name)
40
#define DECLARE_Doubles(name) DECLARE_FIELD(std::vector<double>, name)
41
#define DECLARE_Strings(name) DECLARE_FIELD(std::vector<std::string>, name)
42
#define DECLARE_mBool(name) DECLARE_FIELD(bool, name)
43
#define DECLARE_mInt16(name) DECLARE_FIELD(int16_t, name)
44
#define DECLARE_mInt32(name) DECLARE_FIELD(int32_t, name)
45
#define DECLARE_mInt64(name) DECLARE_FIELD(int64_t, name)
46
#define DECLARE_mDouble(name) DECLARE_FIELD(double, name)
47
#define DECLARE_mString(name) DECLARE_FIELD(std::string, name)
48
49
#define DEFINE_FIELD(FIELD_TYPE, FIELD_NAME, FIELD_DEFAULT, VALMUTABLE)                      \
50
    FIELD_TYPE FIELD_NAME;                                                                   \
51
    static Register reg_##FIELD_NAME(#FIELD_TYPE, #FIELD_NAME, &(FIELD_NAME), FIELD_DEFAULT, \
52
                                     VALMUTABLE);
53
54
#define DEFINE_VALIDATOR(FIELD_NAME, VALIDATOR)              \
55
196
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_17clEi
Line
Count
Source
55
7
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_18clEi
Line
Count
Source
55
7
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_19clEi
Line
Count
Source
55
7
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_20clEi
Line
Count
Source
55
21
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_21clEi
Line
Count
Source
55
21
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_22clEi
Line
Count
Source
55
21
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_23clEl
Line
Count
Source
55
7
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_24clEl
Line
Count
Source
55
7
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_25clEl
Line
Count
Source
55
7
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_26clEl
Line
Count
Source
55
7
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_27clERKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
55
14
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_28clEl
Line
Count
Source
55
7
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_29clEi
Line
Count
Source
55
35
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_30clEl
Line
Count
Source
55
7
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_31clERKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
55
21
    static auto validator_##FIELD_NAME = VALIDATOR;          \
56
    static RegisterConfValidator reg_validator_##FIELD_NAME( \
57
210
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_0clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_1clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_2clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_3clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_4clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_5clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_6clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_7clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_8clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_9clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_10clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_11clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_12clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_13clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_14clEv
Line
Count
Source
57
14
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
58
59
#define DEFINE_Int16(name, defaultstr) DEFINE_FIELD(int16_t, name, defaultstr, false)
60
#define DEFINE_Bools(name, defaultstr) DEFINE_FIELD(std::vector<bool>, name, defaultstr, false)
61
#define DEFINE_Doubles(name, defaultstr) DEFINE_FIELD(std::vector<double>, name, defaultstr, false)
62
#define DEFINE_Int16s(name, defaultstr) DEFINE_FIELD(std::vector<int16_t>, name, defaultstr, false)
63
#define DEFINE_Int32s(name, defaultstr) DEFINE_FIELD(std::vector<int32_t>, name, defaultstr, false)
64
#define DEFINE_Int64s(name, defaultstr) DEFINE_FIELD(std::vector<int64_t>, name, defaultstr, false)
65
#define DEFINE_Bool(name, defaultstr) DEFINE_FIELD(bool, name, defaultstr, false)
66
#define DEFINE_Double(name, defaultstr) DEFINE_FIELD(double, name, defaultstr, false)
67
#define DEFINE_Int32(name, defaultstr) DEFINE_FIELD(int32_t, name, defaultstr, false)
68
#define DEFINE_Int64(name, defaultstr) DEFINE_FIELD(int64_t, name, defaultstr, false)
69
#define DEFINE_String(name, defaultstr) DEFINE_FIELD(std::string, name, defaultstr, false)
70
#define DEFINE_Strings(name, defaultstr) \
71
    DEFINE_FIELD(std::vector<std::string>, name, defaultstr, false)
72
#define DEFINE_mBool(name, defaultstr) DEFINE_FIELD(bool, name, defaultstr, true)
73
#define DEFINE_mInt16(name, defaultstr) DEFINE_FIELD(int16_t, name, defaultstr, true)
74
#define DEFINE_mInt32(name, defaultstr) DEFINE_FIELD(int32_t, name, defaultstr, true)
75
#define DEFINE_mInt64(name, defaultstr) DEFINE_FIELD(int64_t, name, defaultstr, true)
76
#define DEFINE_mDouble(name, defaultstr) DEFINE_FIELD(double, name, defaultstr, true)
77
#define DEFINE_mString(name, defaultstr) DEFINE_FIELD(std::string, name, defaultstr, true)
78
#define DEFINE_Validator(name, validator) DEFINE_VALIDATOR(name, validator)
79
80
namespace doris {
81
class Status;
82
83
// If you want to modify the value of config, please go to common/config.cpp to modify.
84
namespace config {
85
// Dir of custom config file
86
DECLARE_String(custom_config_dir);
87
88
// Dir of jdbc drivers
89
DECLARE_String(jdbc_drivers_dir);
90
91
// cluster id
92
DECLARE_Int32(cluster_id);
93
// port on which BackendService is exported
94
DECLARE_Int32(be_port);
95
96
// port for brpc
97
DECLARE_Int32(brpc_port);
98
99
// port for arrow flight sql
100
// Default -1, do not start arrow flight sql server.
101
DECLARE_Int32(arrow_flight_sql_port);
102
103
// port for cdc client scan oltp cdc data
104
DECLARE_Int32(cdc_client_port);
105
106
// If the external client cannot directly access priority_networks, set public_host to be accessible
107
// to external client.
108
// There are usually two usage scenarios:
109
// 1. in production environment, it is often inconvenient to expose Doris BE nodes to the external network.
110
// However, a reverse proxy (such as Nginx) can be added to all Doris BE nodes, and the external client will be
111
// randomly routed to a Doris BE node when connecting to Nginx. set public_host to the host of Nginx.
112
// 2. if priority_networks is an internal network IP, and BE node has its own independent external IP,
113
// but Doris currently does not support modifying priority_networks, setting public_host to the real external IP.
114
DECLARE_mString(public_host);
115
116
// If the BE node is connected to the external network through a reverse proxy like Nginx
117
// and need to use Arrow Flight SQL, should add a server in Nginx to reverse proxy
118
// `Nginx:arrow_flight_sql_proxy_port` to `BE_priority_networks:arrow_flight_sql_port`. For example:
119
// upstream arrowflight {
120
//    server 10.16.10.8:8069;
121
//    server 10.16.10.8:8068;
122
//}
123
// server {
124
//    listen 8167 http2;
125
//    listen [::]:8167 http2;
126
//    server_name doris.arrowflight.com;
127
// }
128
DECLARE_Int32(arrow_flight_sql_proxy_port);
129
130
// the number of bthreads for brpc, the default value is set to -1,
131
// which means the number of bthreads is #cpu-cores
132
DECLARE_Int32(brpc_num_threads);
133
DECLARE_Int32(brpc_idle_timeout_sec);
134
135
// Declare a selection strategy for those servers have many ips.
136
// Note that there should at most one ip match this list.
137
// This is a list in semicolon-delimited format, in CIDR notation, e.g. 10.10.10.0/24
138
// If no ip match this rule, will choose one randomly.
139
DECLARE_String(priority_networks);
140
141
// performance moderate or compact, only tcmalloc compile
142
DECLARE_String(memory_mode);
143
144
// if true, process memory limit and memory usage based on cgroup memory info.
145
DECLARE_mBool(enable_use_cgroup_memory_info);
146
147
// process memory limit specified as number of bytes
148
// ('<int>[bB]?'), megabytes ('<float>[mM]'), gigabytes ('<float>[gG]'),
149
// or percentage of the physical memory ('<int>%').
150
// defaults to bytes if no unit is given"
151
// must larger than 0. and if larger than physical memory size,
152
// it will be set to physical memory size.
153
DECLARE_String(mem_limit);
154
155
// Soft memory limit as a fraction of hard memory limit.
156
DECLARE_Double(soft_mem_limit_frac);
157
158
// Cache capacity reduce mem limit as a fraction of soft mem limit.
159
DECLARE_mDouble(cache_capacity_reduce_mem_limit_frac);
160
161
// Schema change memory limit as a fraction of soft memory limit.
162
DECLARE_Double(schema_change_mem_limit_frac);
163
164
// Many modern allocators (for example) do not do a mremap for
165
// realloc, even in case of large enough chunks of memory. Although this allows
166
// you to increase performance and reduce memory consumption during realloc.
167
// To fix this, we do mremap manually if the chunk of memory is large enough.
168
//
169
// The threshold (128 MB, 128 * (1ULL << 20)) is chosen quite large, since changing the address
170
// space is very slow, especially in the case of a large number of threads. We
171
// expect that the set of operations mmap/something to do/mremap can only be
172
// performed about 1000 times per second.
173
//
174
// P.S. This is also required, because tcmalloc can not allocate a chunk of
175
// memory greater than 16 GB.
176
DECLARE_mInt64(mmap_threshold); // bytes
177
178
// When hash table capacity is greater than 2^double_grow_degree(default 2G), grow when 75% of the capacity is satisfied.
179
// Increase can reduce the number of hash table resize, but may waste more memory.
180
DECLARE_mInt32(hash_table_double_grow_degree);
181
182
// The max fill rate for hash table
183
DECLARE_mInt32(max_fill_rate);
184
185
DECLARE_mInt32(double_resize_threshold);
186
187
// The maximum low water mark of the system `/proc/meminfo/MemAvailable`, Unit byte, default -1.
188
// if it is -1, then low water mark = min(MemTotal - MemLimit, MemTotal * 5%), which is 3.2G on a 64G machine.
189
// Turn up max. more memory buffers will be reserved for Memory GC.
190
// Turn down max. will use as much memory as possible.
191
// note that: `max_` prefix should be removed, but keep it for compatibility.
192
DECLARE_Int64(max_sys_mem_available_low_water_mark_bytes);
193
194
// reserve a small amount of memory so we do not trigger MinorGC
195
DECLARE_Int64(memtable_limiter_reserved_memory_bytes);
196
197
// The size of the memory that gc wants to release each time, as a percentage of the mem limit.
198
DECLARE_mString(process_minor_gc_size);
199
DECLARE_mString(process_full_gc_size);
200
201
// gc will release cache, cancel task, and task will wait for gc to release memory,
202
// default gc strategy is conservative, if you want to exclude the interference of gc, let it be true
203
DECLARE_mBool(disable_memory_gc);
204
205
// for the query being canceled,
206
// if (current time - cancel start time) < revoke_memory_max_tolerance_ms, the query memory is counted in `freed_memory`,
207
// and the query memory is expected to be released soon.
208
// if > revoke_memory_max_tolerance_ms, the query memory will not be counted in `freed_memory`,
209
// and the query may be blocked during the cancel process. skip this query and continue to cancel other queries.
210
DECLARE_mInt64(revoke_memory_max_tolerance_ms);
211
212
// if false, turn off all stacktrace
213
DECLARE_mBool(enable_stacktrace);
214
215
// when alloc memory larger than stacktrace_in_alloc_large_memory_bytes, default 2G - 1,
216
// if alloc successful, will print a warning with stacktrace, but not prevent memory alloc.
217
// if alloc failed using Doris Allocator, will print stacktrace in error log.
218
// if is -1, disable print stacktrace when alloc large memory.
219
DECLARE_mInt64(stacktrace_in_alloc_large_memory_bytes);
220
221
// when alloc memory larger than crash_in_alloc_large_memory_bytes will crash, default -1 means disabled.
222
// if you need a core dump to analyze large memory allocation,
223
// modify this parameter to crash when large memory allocation occur will help
224
DECLARE_mInt64(crash_in_alloc_large_memory_bytes);
225
226
// The actual meaning of this parameter is `debug_memory`.
227
// 1. crash in memory tracker inaccurate, if memory tracker value is inaccurate, BE will crash.
228
//    usually used in test environments, default value is false.
229
// 2. print more memory logs.
230
DECLARE_mBool(crash_in_memory_tracker_inaccurate);
231
232
// default is true. if any memory tracking in Orphan mem tracker will report error.
233
// !! not modify the default value of this conf!! otherwise memory errors cannot be detected in time.
234
// allocator free memory not need to check, because when the thread memory tracker label is Orphan,
235
// use the tracker saved in Allocator.
236
DECLARE_mBool(enable_memory_orphan_check);
237
238
// The maximum time a thread waits for a full GC. Currently only query will wait for full gc.
239
DECLARE_mInt32(thread_wait_gc_max_milliseconds);
240
241
// reach mem limit, don't serialize in batch
242
DECLARE_mInt64(pre_serialize_keys_limit_bytes);
243
244
// the port heartbeat service used
245
DECLARE_Int32(heartbeat_service_port);
246
// the count of heart beat service
247
DECLARE_Int32(heartbeat_service_thread_count);
248
// the count of thread to create table
249
DECLARE_Int32(create_tablet_worker_count);
250
// the count of thread to drop table
251
DECLARE_Int32(drop_tablet_worker_count);
252
// the count of thread to batch load
253
DECLARE_Int32(push_worker_count_normal_priority);
254
// the count of thread to high priority batch load
255
DECLARE_Int32(push_worker_count_high_priority);
256
// the count of thread to publish version
257
DECLARE_Int32(publish_version_worker_count);
258
// the count of tablet thread to publish version
259
DECLARE_Int32(tablet_publish_txn_max_thread);
260
// the timeout of EnginPublishVersionTask
261
DECLARE_Int32(publish_version_task_timeout_s);
262
// the count of thread to calc delete bitmap
263
DECLARE_Int32(calc_delete_bitmap_max_thread);
264
// the num of threads to calc delete bitmap when building rowset
265
DECLARE_Int32(calc_delete_bitmap_for_load_max_thread);
266
// the count of thread to calc delete bitmap worker, only used for cloud
267
DECLARE_Int32(calc_delete_bitmap_worker_count);
268
// the count of thread to calc tablet delete bitmap task, only used for cloud
269
DECLARE_Int32(calc_tablet_delete_bitmap_task_max_thread);
270
// the count of thread to clear transaction task
271
DECLARE_Int32(clear_transaction_task_worker_count);
272
// the count of thread to delete
273
DECLARE_Int32(delete_worker_count);
274
// the count of thread to alter table
275
DECLARE_Int32(alter_tablet_worker_count);
276
// the count of thread to alter index
277
DECLARE_Int32(alter_index_worker_count);
278
// the count of thread to clone
279
DECLARE_Int32(clone_worker_count);
280
// the count of thread to clone
281
DECLARE_Int32(storage_medium_migrate_count);
282
// the count of thread to check consistency
283
DECLARE_Int32(check_consistency_worker_count);
284
// the count of thread to upload
285
DECLARE_Int32(upload_worker_count);
286
// the count of thread to download
287
DECLARE_Int32(download_worker_count);
288
// the count of thread to make snapshot
289
DECLARE_Int32(make_snapshot_worker_count);
290
// the count of thread to release snapshot
291
DECLARE_Int32(release_snapshot_worker_count);
292
// report random wait a little time to avoid FE receiving multiple be reports at the same time.
293
// do not set it to false for production environment
294
DECLARE_mBool(report_random_wait);
295
// the interval time(seconds) for agent report tasks signature to FE
296
DECLARE_mInt32(report_task_interval_seconds);
297
// the interval time(seconds) for agent report disk state to FE
298
DECLARE_mInt32(report_disk_state_interval_seconds);
299
// the interval time(seconds) for agent report olap table to FE
300
DECLARE_mInt32(report_tablet_interval_seconds);
301
// the max download speed(KB/s)
302
DECLARE_mInt32(max_download_speed_kbps);
303
// download low speed limit(KB/s)
304
DECLARE_mInt32(download_low_speed_limit_kbps);
305
// download low speed time(seconds)
306
DECLARE_mInt32(download_low_speed_time);
307
// whether to download small files in batch.
308
DECLARE_mBool(enable_batch_download);
309
// whether to check md5sum when download
310
DECLARE_mBool(enable_download_md5sum_check);
311
// download binlog meta timeout
312
DECLARE_mInt32(download_binlog_meta_timeout_ms);
313
// the interval time(seconds) for agent report index policy to FE
314
DECLARE_mInt32(report_index_policy_interval_seconds);
315
316
// deprecated, use env var LOG_DIR in be.conf
317
DECLARE_String(sys_log_dir);
318
// for udf
319
DECLARE_String(user_function_dir);
320
// INFO, WARNING, ERROR, FATAL
321
DECLARE_String(sys_log_level);
322
// TIME-DAY, TIME-HOUR, SIZE-MB-nnn
323
DECLARE_String(sys_log_roll_mode);
324
// log roll num
325
DECLARE_Int32(sys_log_roll_num);
326
// verbose log
327
DECLARE_Strings(sys_log_verbose_modules);
328
// verbose log level
329
DECLARE_Int32(sys_log_verbose_level);
330
// verbose log FLAGS_v
331
DECLARE_Int32(sys_log_verbose_flags_v);
332
// log buffer level
333
DECLARE_String(log_buffer_level);
334
// log enable custom date time format
335
DECLARE_Bool(sys_log_enable_custom_date_time_format);
336
// log custom date time format (https://en.cppreference.com/w/cpp/io/manip/put_time)
337
DECLARE_String(sys_log_custom_date_time_format);
338
// log custom date time milliseconds format (fmt::format)
339
DECLARE_String(sys_log_custom_date_time_ms_format);
340
341
// number of threads available to serve backend execution requests
342
DECLARE_Int32(be_service_threads);
343
344
// interval between profile reports; in seconds
345
DECLARE_mInt32(pipeline_status_report_interval);
346
// Time slice for pipeline task execution (ms)
347
DECLARE_mInt32(pipeline_task_exec_time_slice);
348
349
// task executor min concurrency per task
350
DECLARE_mInt32(task_executor_min_concurrency_per_task);
351
// task executor max concurrency per task
352
DECLARE_mInt32(task_executor_max_concurrency_per_task);
353
// task task executor inital split max concurrency per task, later concurrency may be adjusted dynamically
354
DECLARE_mInt32(task_executor_initial_max_concurrency_per_task);
355
// Enable task executor in internal table scan.
356
DECLARE_Bool(enable_task_executor_in_internal_table);
357
// Enable task executor in external table scan.
358
DECLARE_Bool(enable_task_executor_in_external_table);
359
360
// number of scanner thread pool size for olap table
361
// and the min thread num of remote scanner thread pool
362
DECLARE_mInt32(doris_scanner_thread_pool_thread_num);
363
DECLARE_mInt32(doris_scanner_min_thread_pool_thread_num);
364
// number of batch size to fetch the remote split source
365
DECLARE_mInt32(remote_split_source_batch_size);
366
// max number of remote scanner thread pool size
367
// if equal to -1, value is std::max(512, CpuInfo::num_cores() * 10)
368
DECLARE_Int32(doris_max_remote_scanner_thread_pool_thread_num);
369
// number of olap scanner thread pool queue size
370
DECLARE_Int32(doris_scanner_thread_pool_queue_size);
371
// default thrift client connect timeout(in seconds)
372
DECLARE_mInt32(thrift_connect_timeout_seconds);
373
// default thrift client retry interval (in milliseconds)
374
DECLARE_mInt64(thrift_client_retry_interval_ms);
375
// max message size of thrift request
376
// default: 100 * 1024 * 1024
377
DECLARE_mInt64(thrift_max_message_size);
378
// max bytes number for single scan range, used in segmentv2
379
DECLARE_mInt32(doris_scan_range_max_mb);
380
// single read execute fragment row number
381
DECLARE_mInt32(doris_scanner_row_num);
382
// single read execute fragment row bytes
383
DECLARE_mInt32(doris_scanner_row_bytes);
384
// single read execute fragment max run time millseconds
385
DECLARE_mInt32(doris_scanner_max_run_time_ms);
386
// (Advanced) Maximum size of per-query receive-side buffer
387
DECLARE_mInt32(exchg_node_buffer_size_bytes);
388
DECLARE_mInt32(exchg_buffer_queue_capacity_factor);
389
390
// memory_limitation_per_thread_for_schema_change_bytes unit bytes
391
DECLARE_mInt64(memory_limitation_per_thread_for_schema_change_bytes);
392
393
// all cache prune interval, used by GC and periodic thread.
394
DECLARE_mInt32(cache_prune_interval_sec);
395
DECLARE_mInt32(cache_periodic_prune_stale_sweep_sec);
396
// the clean interval of tablet lookup cache
397
DECLARE_mInt32(tablet_lookup_cache_stale_sweep_time_sec);
398
DECLARE_mInt32(point_query_row_cache_stale_sweep_time_sec);
399
DECLARE_mInt32(disk_stat_monitor_interval);
400
DECLARE_mInt32(unused_rowset_monitor_interval);
401
DECLARE_mInt32(quering_rowsets_evict_interval);
402
DECLARE_String(storage_root_path);
403
DECLARE_mString(broken_storage_path);
404
DECLARE_Int32(min_active_scan_threads);
405
DECLARE_Int32(min_active_file_scan_threads);
406
407
// Config is used to check incompatible old format hdr_ format
408
// whether doris uses strict way. When config is true, process will log fatal
409
// and exit. When config is false, process will only log warning.
410
DECLARE_Bool(storage_strict_check_incompatible_old_format);
411
412
// BE process will exit if the percentage of error disk reach this value.
413
DECLARE_mInt32(max_percentage_of_error_disk);
414
DECLARE_mInt32(default_num_rows_per_column_file_block);
415
// pending data policy
416
DECLARE_mInt32(pending_data_expire_time_sec);
417
// inc_rowset snapshot rs sweep time interval
418
DECLARE_mInt32(tablet_rowset_stale_sweep_time_sec);
419
// tablet stale rowset sweep by threshold size
420
DECLARE_Bool(tablet_rowset_stale_sweep_by_size);
421
DECLARE_mInt32(tablet_rowset_stale_sweep_threshold_size);
422
// garbage sweep policy
423
DECLARE_Int32(max_garbage_sweep_interval);
424
DECLARE_Int32(min_garbage_sweep_interval);
425
// garbage sweep every batch will sleep 1ms
426
DECLARE_mInt32(garbage_sweep_batch_size);
427
DECLARE_mInt32(snapshot_expire_time_sec);
428
// It is only a recommended value. When the disk space is insufficient,
429
// the file storage period under trash dose not have to comply with this parameter.
430
DECLARE_mInt32(trash_file_expire_time_sec);
431
// minimum file descriptor number
432
// modify them upon necessity
433
DECLARE_Int32(min_file_descriptor_number);
434
DECLARE_mBool(disable_segment_cache);
435
DECLARE_String(row_cache_mem_limit);
436
437
// Cache for storage page size
438
DECLARE_String(storage_page_cache_limit);
439
// Shard size for page cache, the value must be power of two.
440
// It's recommended to set it to a value close to the number of BE cores in order to reduce lock contentions.
441
DECLARE_Int32(storage_page_cache_shard_size);
442
// Percentage for index page cache
443
// all storage page cache will be divided into data_page_cache and index_page_cache
444
DECLARE_Int32(index_page_cache_percentage);
445
// whether to disable page cache feature in storage
446
// TODO delete it. Divided into Data page, Index page, pk index page
447
DECLARE_Bool(disable_storage_page_cache);
448
// whether to disable row cache feature in storage
449
DECLARE_mBool(disable_storage_row_cache);
450
// whether to disable pk page cache feature in storage
451
DECLARE_Bool(disable_pk_storage_page_cache);
452
453
// Cache for mow primary key storage page size, it's seperated from
454
// storage_page_cache_limit
455
DECLARE_String(pk_storage_page_cache_limit);
456
// data page size for primary key index
457
DECLARE_Int32(primary_key_data_page_size);
458
459
// inc_rowset snapshot rs sweep time interval
460
DECLARE_mInt32(data_page_cache_stale_sweep_time_sec);
461
DECLARE_mInt32(index_page_cache_stale_sweep_time_sec);
462
// great impact on the performance of MOW, so it can be longer.
463
DECLARE_mInt32(pk_index_page_cache_stale_sweep_time_sec);
464
465
DECLARE_mBool(enable_low_cardinality_optimize);
466
DECLARE_Bool(enable_low_cardinality_cache_code);
467
468
// be policy
469
// whether check compaction checksum
470
DECLARE_mBool(enable_compaction_checksum);
471
// whether disable automatic compaction task
472
DECLARE_mBool(disable_auto_compaction);
473
// whether enable vertical compaction
474
DECLARE_mBool(enable_vertical_compaction);
475
// whether enable ordered data compaction
476
DECLARE_mBool(enable_ordered_data_compaction);
477
// In vertical compaction, column number for every group
478
DECLARE_mInt32(vertical_compaction_num_columns_per_group);
479
// In vertical compaction, max memory usage for row_source_buffer
480
DECLARE_Int32(vertical_compaction_max_row_source_memory_mb);
481
// In vertical compaction, max dest segment file size
482
DECLARE_mInt64(vertical_compaction_max_segment_size);
483
484
// If enabled, segments will be flushed column by column
485
DECLARE_mBool(enable_vertical_segment_writer);
486
487
// In ordered data compaction, min segment size for input rowset
488
DECLARE_mInt32(ordered_data_compaction_min_segment_size);
489
490
// This config can be set to limit thread number in compaction thread pool.
491
DECLARE_mInt32(max_base_compaction_threads);
492
DECLARE_mInt32(max_cumu_compaction_threads);
493
DECLARE_mInt32(max_single_replica_compaction_threads);
494
495
DECLARE_Bool(enable_base_compaction_idle_sched);
496
DECLARE_mInt64(base_compaction_min_rowset_num);
497
DECLARE_mInt64(base_compaction_max_compaction_score);
498
DECLARE_mInt64(mow_base_compaction_max_compaction_score);
499
DECLARE_mDouble(base_compaction_min_data_ratio);
500
DECLARE_mInt64(base_compaction_dup_key_max_file_size_mbytes);
501
502
DECLARE_Bool(enable_skip_tablet_compaction);
503
DECLARE_mInt32(skip_tablet_compaction_second);
504
// output rowset of cumulative compaction total disk size exceed this config size,
505
// this rowset will be given to base compaction, unit is m byte.
506
DECLARE_mInt64(compaction_promotion_size_mbytes);
507
508
// output rowset of cumulative compaction total disk size exceed this config ratio of
509
// base rowset's total disk size, this rowset will be given to base compaction. The value must be between
510
// 0 and 1.
511
DECLARE_mDouble(compaction_promotion_ratio);
512
513
// the smallest size of rowset promotion. When the rowset is less than this config, this
514
// rowset will be not given to base compaction. The unit is m byte.
515
DECLARE_mInt64(compaction_promotion_min_size_mbytes);
516
517
// When output rowset of cumulative compaction total version count (end_version - start_version)
518
// exceed this config count, the rowset will be moved to base compaction
519
// NOTE: this config will work for unique key merge-on-write table only, to reduce version count
520
// related cost on delete bitmap more effectively.
521
DECLARE_mInt64(compaction_promotion_version_count);
522
523
// The lower bound size to do cumulative compaction. When total disk size of candidate rowsets is less than
524
// this size, size_based policy may not do to cumulative compaction. The unit is m byte.
525
DECLARE_mInt64(compaction_min_size_mbytes);
526
527
// cumulative compaction policy: min and max delta file's number
528
DECLARE_mInt64(cumulative_compaction_min_deltas);
529
DECLARE_mInt64(cumulative_compaction_max_deltas);
530
DECLARE_mInt32(cumulative_compaction_max_deltas_factor);
531
532
// This config can be set to limit thread number in  multiget thread pool.
533
DECLARE_mInt32(multi_get_max_threads);
534
535
// The upper limit of "permits" held by all compaction tasks. This config can be set to limit memory consumption for compaction.
536
DECLARE_mInt64(total_permits_for_compaction_score);
537
538
// sleep interval in ms after generated compaction tasks
539
DECLARE_mInt32(generate_compaction_tasks_interval_ms);
540
// sleep interval in second after update replica infos
541
DECLARE_mInt32(update_replica_infos_interval_seconds);
542
543
// Compaction task number per disk.
544
// Must be greater than 2, because Base compaction and Cumulative compaction have at least one thread each.
545
DECLARE_mInt32(compaction_task_num_per_disk);
546
// compaction thread num for fast disk(typically .SSD), must be greater than 2.
547
DECLARE_mInt32(compaction_task_num_per_fast_disk);
548
549
// How many rounds of cumulative compaction for each round of base compaction when compaction tasks generation.
550
DECLARE_mInt32(cumulative_compaction_rounds_for_each_base_compaction_round);
551
552
// Minimum number of threads required in the thread pool to activate the large cumu compaction delay strategy.
553
// The delay strategy is only applied when the thread pool has at least this many threads.
554
DECLARE_mInt32(large_cumu_compaction_task_min_thread_num);
555
// Maximum size threshold (in bytes) for input rowsets. Compaction tasks with input size
556
// exceeding this threshold will be delayed when thread pool is near capacity. Default 100MB.
557
DECLARE_mInt32(large_cumu_compaction_task_bytes_threshold);
558
// Maximum row count threshold for compaction input. Compaction tasks with row count
559
// exceeding this threshold will be delayed when thread pool is near capacity. Default 1 million.
560
DECLARE_mInt32(large_cumu_compaction_task_row_num_threshold);
561
562
// Not compact the invisible versions, but with some limitations:
563
// if not timeout, keep no more than compaction_keep_invisible_version_max_count versions;
564
// if timeout, keep no more than compaction_keep_invisible_version_min_count versions.
565
DECLARE_mInt32(compaction_keep_invisible_version_timeout_sec);
566
DECLARE_mInt32(compaction_keep_invisible_version_min_count);
567
DECLARE_mInt32(compaction_keep_invisible_version_max_count);
568
569
// Threshold to logging compaction trace, in seconds.
570
DECLARE_mInt32(base_compaction_trace_threshold);
571
DECLARE_mInt32(cumulative_compaction_trace_threshold);
572
DECLARE_mBool(disable_compaction_trace_log);
573
574
// Interval to picking rowset to compact, in seconds
575
DECLARE_mInt64(pick_rowset_to_compact_interval_sec);
576
577
// Compaction priority schedule
578
DECLARE_mBool(enable_compaction_priority_scheduling);
579
DECLARE_mInt32(low_priority_compaction_task_num_per_disk);
580
DECLARE_mInt32(low_priority_compaction_score_threshold);
581
582
// Thread count to do tablet meta checkpoint, -1 means use the data directories count.
583
DECLARE_Int32(max_meta_checkpoint_threads);
584
585
// Threshold to logging agent task trace, in seconds.
586
DECLARE_mInt32(agent_task_trace_threshold_sec);
587
588
// This config can be set to limit thread number in tablet migration thread pool.
589
DECLARE_Int32(min_tablet_migration_threads);
590
DECLARE_Int32(max_tablet_migration_threads);
591
592
DECLARE_mInt32(finished_migration_tasks_size);
593
// If size less than this, the remaining rowsets will be force to complete
594
DECLARE_mInt32(migration_remaining_size_threshold_mb);
595
// If the task runs longer than this time, the task will be terminated, in seconds.
596
// timeout = std::max(migration_task_timeout_secs,  tablet size / 1MB/s)
597
DECLARE_mInt32(migration_task_timeout_secs);
598
// timeout for try_lock migration lock
599
DECLARE_Int64(migration_lock_timeout_ms);
600
601
// Port to start debug webserver on
602
DECLARE_Int32(webserver_port);
603
// Https enable flag
604
DECLARE_Bool(enable_https);
605
// Path of certificate
606
DECLARE_String(ssl_certificate_path);
607
// Path of private key
608
DECLARE_String(ssl_private_key_path);
609
// Whether to check authorization
610
DECLARE_Bool(enable_all_http_auth);
611
// Number of webserver workers
612
DECLARE_Int32(webserver_num_workers);
613
614
DECLARE_Bool(enable_single_replica_load);
615
// Number of download workers for single replica load
616
DECLARE_Int32(single_replica_load_download_num_workers);
617
618
// Used for mini Load. mini load data file will be removed after this time.
619
DECLARE_Int64(load_data_reserve_hours);
620
// log error log will be removed after this time
621
DECLARE_mInt64(load_error_log_reserve_hours);
622
// error log size limit, default 200MB
623
DECLARE_mInt64(load_error_log_limit_bytes);
624
625
// be brpc interface is classified into two categories: light and heavy
626
// each category has diffrent thread number
627
// threads to handle heavy api interface, such as transmit_block etc
628
DECLARE_Int32(brpc_heavy_work_pool_threads);
629
// threads to handle light api interface, such as exec_plan_fragment_prepare/exec_plan_fragment_start
630
DECLARE_Int32(brpc_light_work_pool_threads);
631
DECLARE_Int32(brpc_heavy_work_pool_max_queue_size);
632
DECLARE_Int32(brpc_light_work_pool_max_queue_size);
633
DECLARE_mBool(enable_bthread_transmit_block);
634
DECLARE_Int32(brpc_arrow_flight_work_pool_threads);
635
DECLARE_Int32(brpc_arrow_flight_work_pool_max_queue_size);
636
637
// The maximum amount of data that can be processed by a stream load
638
DECLARE_mInt64(streaming_load_max_mb);
639
// Some data formats, such as JSON, cannot be streamed.
640
// Therefore, it is necessary to limit the maximum number of
641
// such data when using stream load to prevent excessive memory consumption.
642
DECLARE_mInt64(streaming_load_json_max_mb);
643
// the alive time of a TabletsChannel.
644
// If the channel does not receive any data till this time,
645
// the channel will be removed.
646
DECLARE_mInt32(streaming_load_rpc_max_alive_time_sec);
647
// the timeout of a rpc to open the tablet writer in remote BE.
648
// short operation time, can set a short timeout
649
DECLARE_Int32(tablet_writer_open_rpc_timeout_sec);
650
// You can ignore brpc error '[E1011]The server is overcrowded' when writing data.
651
DECLARE_mBool(tablet_writer_ignore_eovercrowded);
652
DECLARE_mInt32(slave_replica_writer_rpc_timeout_sec);
653
// Whether to enable stream load record function, the default is false.
654
// False: disable stream load record
655
DECLARE_mBool(enable_stream_load_record);
656
// Whether to enable stream load record to audit log table, the default is true.
657
DECLARE_mBool(enable_stream_load_record_to_audit_log_table);
658
// the maximum bytes of a batch of stream load records to audit log table
659
DECLARE_mInt64(stream_load_record_batch_bytes);
660
// the interval to send a batch of stream load records to audit log table
661
DECLARE_mInt64(stream_load_record_batch_interval_secs);
662
// batch size of stream load record reported to FE
663
DECLARE_mInt32(stream_load_record_batch_size);
664
// expire time of stream load record in rocksdb.
665
DECLARE_Int32(stream_load_record_expire_time_secs);
666
// time interval to clean expired stream load records
667
DECLARE_mInt64(clean_stream_load_record_interval_secs);
668
// enable stream load commit txn on BE directly, bypassing FE. Only for cloud.
669
DECLARE_mBool(enable_stream_load_commit_txn_on_be);
670
// The buffer size to store stream table function schema info
671
DECLARE_Int64(stream_tvf_buffer_size);
672
673
// request cdc client timeout
674
DECLARE_mInt32(request_cdc_client_timeout_ms);
675
676
// OlapTableSink sender's send interval, should be less than the real response time of a tablet writer rpc.
677
// You may need to lower the speed when the sink receiver bes are too busy.
678
DECLARE_mInt32(olap_table_sink_send_interval_microseconds);
679
// For auto partition, the send interval will multiply the factor
680
DECLARE_mDouble(olap_table_sink_send_interval_auto_partition_factor);
681
682
// Fragment thread pool
683
DECLARE_Int32(fragment_mgr_async_work_pool_thread_num_min);
684
DECLARE_Int32(fragment_mgr_async_work_pool_thread_num_max);
685
DECLARE_Int32(fragment_mgr_async_work_pool_queue_size);
686
687
// Control the number of disks on the machine.  If 0, this comes from the system settings.
688
DECLARE_Int32(num_disks);
689
// The read size is the size of the reads sent to os.
690
// There is a trade off of latency and throughout, trying to keep disks busy but
691
// not introduce seeks.  The literature seems to agree that with 8 MB reads, random
692
// io and sequential io perform similarly.
693
DECLARE_Int32(read_size);       // 8 * 1024 * 1024, Read Size (in bytes)
694
DECLARE_Int32(min_buffer_size); // 1024, The minimum read buffer size (in bytes)
695
696
// for pprof
697
DECLARE_String(pprof_profile_dir);
698
// for jeprofile in jemalloc
699
DECLARE_mString(jeprofile_dir);
700
// Purge all unused dirty pages for all arenas.
701
DECLARE_mBool(enable_je_purge_dirty_pages);
702
// Jemalloc `arenas.dirty_decay_ms`, equal to `dirty_decay_ms` in JEMALLOC_CONF in be.conf.
703
DECLARE_mInt32(je_dirty_decay_ms);
704
705
// to forward compatibility, will be removed later
706
DECLARE_mBool(enable_token_check);
707
708
// to open/close system metrics
709
DECLARE_Bool(enable_system_metrics);
710
711
// Number of cores Doris will used, this will effect only when it's greater than 0.
712
// Otherwise, Doris will use all cores returned from "/proc/cpuinfo".
713
DECLARE_Int32(num_cores);
714
715
// When BE start, If there is a broken disk, BE process will exit by default.
716
// Otherwise, we will ignore the broken disk,
717
DECLARE_Bool(ignore_broken_disk);
718
DECLARE_Bool(ignore_file_cache_dir_upgrade_failure);
719
720
// Sleep time in milliseconds between memory maintenance iterations
721
DECLARE_mInt32(memory_maintenance_sleep_time_ms);
722
723
// Memory gc are expensive, wait a while to avoid too frequent.
724
DECLARE_mInt32(memory_gc_sleep_time_ms);
725
726
// max write buffer size before flush, default 200MB
727
DECLARE_mInt64(write_buffer_size);
728
DECLARE_mBool(enable_adaptive_write_buffer_size);
729
// max buffer size used in memtable for the aggregated table, default 400MB
730
DECLARE_mInt64(write_buffer_size_for_agg);
731
732
DECLARE_mInt64(min_write_buffer_size_for_partial_update);
733
// max parallel flush task per memtable writer
734
DECLARE_mInt32(memtable_flush_running_count_limit);
735
736
// maximum sleep time to wait for memory when writing or flushing memtable.
737
DECLARE_mInt32(memtable_wait_for_memory_sleep_time_s);
738
739
DECLARE_Int32(load_process_max_memory_limit_percent); // 50%
740
741
// If the memory consumption of load jobs exceed load_process_max_memory_limit,
742
// all load jobs will hang there to wait for memtable flush. We should have a
743
// soft limit which can trigger the memtable flush for the load channel who
744
// consumes lagest memory size before we reach the hard limit. The soft limit
745
// might avoid all load jobs hang at the same time.
746
DECLARE_Int32(load_process_soft_mem_limit_percent);
747
748
// If load memory consumption is within load_process_safe_mem_permit_percent,
749
// memtable memory limiter will do nothing.
750
DECLARE_Int32(load_process_safe_mem_permit_percent);
751
752
// If there are a lot of memtable memory, then wait them flush finished.
753
DECLARE_mDouble(load_max_wg_active_memtable_percent);
754
755
// result buffer cancelled time (unit: second)
756
DECLARE_mInt32(result_buffer_cancelled_interval_time);
757
758
// arrow flight result sink buffer rows size, default 4096 * 8
759
DECLARE_mInt32(arrow_flight_result_sink_buffer_size_rows);
760
// The timeout for ADBC Client to wait for data using arrow flight reader.
761
// If the query is very complex and no result is generated after this time, consider increasing this timeout.
762
DECLARE_mInt32(arrow_flight_reader_brpc_controller_timeout_ms);
763
764
// the increased frequency of priority for remaining tasks in BlockingPriorityQueue
765
DECLARE_mInt32(priority_queue_remaining_tasks_increased_frequency);
766
767
// sync tablet_meta when modifying meta
768
DECLARE_mBool(sync_tablet_meta);
769
770
// sync a file writer when it is closed
771
DECLARE_mBool(sync_file_on_close);
772
773
// default thrift rpc timeout ms
774
DECLARE_mInt32(thrift_rpc_timeout_ms);
775
776
// txn commit rpc timeout
777
DECLARE_mInt32(txn_commit_rpc_timeout_ms);
778
779
// If set to true, metric calculator will run
780
DECLARE_Bool(enable_metric_calculator);
781
782
// max consumer num in one data consumer group, for routine load
783
DECLARE_mInt32(max_consumer_num_per_group);
784
785
// the max size of thread pool for routine load task.
786
// this should be larger than FE config 'max_routine_load_task_num_per_be' (default 5)
787
DECLARE_Int32(max_routine_load_thread_pool_size);
788
789
// max external scan cache batch count, means cache max_memory_cache_batch_count * batch_size row
790
// default is 20, batch_size's default value is 1024 means 20 * 1024 rows will be cached
791
DECLARE_mInt32(max_memory_sink_batch_count);
792
793
// This configuration is used for the context gc thread schedule period
794
// note: unit is minute, default is 5min
795
DECLARE_mInt32(scan_context_gc_interval_min);
796
797
// es scroll keep-alive
798
DECLARE_String(es_scroll_keepalive);
799
800
// HTTP connection timeout for es
801
DECLARE_mInt32(es_http_timeout_ms);
802
803
// the max client cache number per each host
804
// There are variety of client cache in BE, but currently we use the
805
// same cache size configuration.
806
// TODO(cmy): use different config to set different client cache if necessary.
807
DECLARE_Int32(max_client_cache_size_per_host);
808
809
DECLARE_Int32(max_master_fe_client_cache_size);
810
811
// Dir to save files downloaded by SmallFileMgr
812
DECLARE_String(small_file_dir);
813
// path gc
814
DECLARE_Bool(path_gc_check);
815
DECLARE_mInt32(path_gc_check_interval_second);
816
DECLARE_mInt32(path_gc_check_step);
817
DECLARE_mInt32(path_gc_check_step_interval_ms);
818
819
// The following 2 configs limit the max usage of disk capacity of a data dir.
820
// If both of these 2 threshold reached, no more data can be writen into that data dir.
821
// The percent of max used capacity of a data dir
822
DECLARE_mInt32(storage_flood_stage_usage_percent); // 90%
823
// The min bytes that should be left of a data dir
824
DECLARE_mInt64(storage_flood_stage_left_capacity_bytes); // 1GB
825
// number of thread for flushing memtable per store
826
DECLARE_Int32(flush_thread_num_per_store);
827
// number of thread for flushing memtable per store, for high priority load task
828
DECLARE_Int32(high_priority_flush_thread_num_per_store);
829
// number of threads = min(flush_thread_num_per_store * num_store,
830
//                         max_flush_thread_num_per_cpu * num_cpu)
831
DECLARE_Int32(max_flush_thread_num_per_cpu);
832
833
// config for tablet meta checkpoint
834
DECLARE_mInt32(tablet_meta_checkpoint_min_new_rowsets_num);
835
DECLARE_mInt32(tablet_meta_checkpoint_min_interval_secs);
836
DECLARE_Int32(generate_tablet_meta_checkpoint_tasks_interval_secs);
837
838
// config for default rowset type
839
// Valid configs: ALPHA, BETA
840
DECLARE_String(default_rowset_type);
841
842
// Maximum size of a single message body in all protocols
843
DECLARE_Int64(brpc_max_body_size);
844
// Max unwritten bytes in each socket, if the limit is reached, Socket.Write fails with EOVERCROWDED
845
// Default, if the physical memory is less than or equal to 64G, the value is 1G
846
//          if the physical memory is greater than 64G, the value is physical memory * mem_limit(0.8) / 1024 * 20
847
DECLARE_Int64(brpc_socket_max_unwritten_bytes);
848
// Whether to set FLAGS_usercode_in_pthread to true in brpc
849
DECLARE_mBool(brpc_usercode_in_pthread);
850
// TODO(zxy): expect to be true in v1.3
851
// Whether to embed the ProtoBuf Request serialized string together with Tuple/Block data into
852
// Controller Attachment and send it through http brpc when the length of the Tuple/Block data
853
// is greater than 1.8G. This is to avoid the error of Request length overflow (2G).
854
DECLARE_mBool(transfer_large_data_by_brpc);
855
856
// max number of txns for every txn_partition_map in txn manager
857
// this is a self protection to avoid too many txns saving in manager
858
DECLARE_mInt64(max_runnings_transactions_per_txn_map);
859
860
// tablet_map_lock shard size, the value is 2^n, n=0,1,2,3,4
861
// this is a an enhancement for better performance to manage tablet
862
DECLARE_Int32(tablet_map_shard_size);
863
864
// txn_map_lock shard size, the value is 2^n, n=0,1,2,3,4
865
// this is a an enhancement for better performance to manage txn
866
DECLARE_Int32(txn_map_shard_size);
867
868
// txn_lock shard size, the value is 2^n, n=0,1,2,3,4
869
// this is a an enhancement for better performance to commit and publish txn
870
DECLARE_Int32(txn_shard_size);
871
872
// Whether to continue to start be when load tablet from header failed.
873
DECLARE_Bool(ignore_load_tablet_failure);
874
875
// Whether to continue to start be when load tablet from header failed.
876
DECLARE_mBool(ignore_rowset_stale_unconsistent_delete);
877
878
// Set max cache's size of query results, the unit is M byte
879
DECLARE_Int32(query_cache_max_size_mb);
880
881
// Cache memory is pruned when reach query_cache_max_size_mb + query_cache_elasticity_size_mb
882
DECLARE_Int32(query_cache_elasticity_size_mb);
883
884
// Maximum number of cache partitions corresponding to a SQL
885
DECLARE_Int32(query_cache_max_partition_count);
886
887
// Maximum number of version of a tablet. If the version num of a tablet exceed limit,
888
// the load process will reject new incoming load job of this tablet.
889
// This is to avoid too many version num.
890
DECLARE_mInt32(max_tablet_version_num);
891
892
DECLARE_mInt32(time_series_max_tablet_version_num);
893
894
// the max sleep time when meeting high pressure load task
895
DECLARE_mInt64(max_load_back_pressure_version_wait_time_ms);
896
// the threshold of rowset number gap that triggers back pressure
897
DECLARE_mInt64(load_back_pressure_version_threshold);
898
899
// Frontend mainly use two thrift sever type: THREAD_POOL, THREADED_SELECTOR. if fe use THREADED_SELECTOR model for thrift server,
900
// the thrift_server_type_of_fe should be set THREADED_SELECTOR to make be thrift client to fe constructed with TFramedTransport
901
DECLARE_String(thrift_server_type_of_fe);
902
903
// disable zone map index when page row is too few
904
DECLARE_mInt32(zone_map_row_num_threshold);
905
906
// aws sdk log level
907
//    Off = 0,
908
//    Fatal = 1,
909
//    Error = 2,
910
//    Warn = 3,
911
//    Info = 4,
912
//    Debug = 5,
913
//    Trace = 6
914
DECLARE_Int32(aws_log_level);
915
916
// azure sdk log level
917
//    Verbose = 1,
918
//    Informational = 2,
919
//    Warning = 3,
920
//    Error = 4
921
DECLARE_Int32(azure_log_level);
922
923
// the buffer size when read data from remote storage like s3
924
DECLARE_mInt32(remote_storage_read_buffer_mb);
925
926
// The minimum length when TCMalloc Hook consumes/releases MemTracker, consume size
927
// smaller than this value will continue to accumulate. specified as number of bytes.
928
// Decreasing this value will increase the frequency of consume/release.
929
// Increasing this value will cause MemTracker statistics to be inaccurate.
930
DECLARE_mInt32(mem_tracker_consume_min_size_bytes);
931
932
// The version information of the tablet will be stored in the memory
933
// in an adjacency graph data structure.
934
// And as the new version is written and the old version is deleted,
935
// the data structure will begin to have empty vertex with no edge associations(orphan vertex).
936
// This config is used to control that when the proportion of orphan vertex is greater than the threshold,
937
// the adjacency graph will be rebuilt to ensure that the data structure will not expand indefinitely.
938
// This config usually only needs to be modified during testing.
939
// In most cases, it does not need to be modified.
940
DECLARE_mDouble(tablet_version_graph_orphan_vertex_ratio);
941
942
// share delta writers when memtable_on_sink_node = true
943
DECLARE_Bool(share_delta_writers);
944
// timeout for open load stream rpc in ms
945
DECLARE_Int64(open_load_stream_timeout_ms);
946
// enable write background when using brpc stream
947
DECLARE_mBool(enable_brpc_stream_write_background);
948
949
// brpc streaming max_buf_size in bytes
950
DECLARE_Int64(load_stream_max_buf_size);
951
// brpc streaming messages_in_batch
952
DECLARE_Int32(load_stream_messages_in_batch);
953
// brpc streaming StreamWait seconds on EAGAIN
954
DECLARE_Int32(load_stream_eagain_wait_seconds);
955
// max tasks per flush token in load stream
956
DECLARE_Int32(load_stream_flush_token_max_tasks);
957
// max wait flush token time in load stream
958
DECLARE_Int32(load_stream_max_wait_flush_token_time_ms);
959
// number of send batch thread pool size
960
DECLARE_Int32(send_batch_thread_pool_thread_num);
961
// number of send batch thread pool queue size
962
DECLARE_Int32(send_batch_thread_pool_queue_size);
963
964
// Limit the number of segment of a newly created rowset.
965
// The newly created rowset may to be compacted after loading,
966
// so if there are too many segment in a rowset, the compaction process
967
// will run out of memory.
968
// When doing compaction, each segment may take at least 1MB buffer.
969
DECLARE_mInt32(max_segment_num_per_rowset);
970
971
// Store segment without compression if a segment is smaller than
972
// segment_compression_threshold_kb.
973
DECLARE_mInt32(segment_compression_threshold_kb);
974
975
// Time to clean up useless JDBC connection pool cache
976
DECLARE_mInt32(jdbc_connection_pool_cache_clear_time_sec);
977
978
// Global bitmap cache capacity for aggregation cache, size in bytes
979
DECLARE_Int64(delete_bitmap_agg_cache_capacity);
980
DECLARE_String(delete_bitmap_dynamic_agg_cache_limit);
981
DECLARE_mInt32(delete_bitmap_agg_cache_stale_sweep_time_sec);
982
983
// A common object cache depends on an Sharded LRU Cache.
984
DECLARE_mInt32(common_obj_lru_cache_stale_sweep_time_sec);
985
986
// reference https://github.com/edenhill/librdkafka/blob/master/INTRODUCTION.md#broker-version-compatibility
987
// If the dependent kafka broker version older than 0.10.0.0,
988
// the value of kafka_api_version_request should be false, and the
989
// value set by the fallback version kafka_broker_version_fallback will be used,
990
// and the valid values are: 0.9.0.x, 0.8.x.y.
991
DECLARE_String(kafka_api_version_request);
992
DECLARE_String(kafka_broker_version_fallback);
993
DECLARE_mString(kafka_debug);
994
995
// The number of pool siz of routine load consumer.
996
// If you meet the error describe in https://github.com/edenhill/librdkafka/issues/3608
997
// Change this size to 0 to fix it temporarily.
998
DECLARE_mInt32(routine_load_consumer_pool_size);
999
1000
// the timeout of condition variable wait in blocking_get and blocking_put
1001
DECLARE_mInt32(blocking_queue_cv_wait_timeout_ms);
1002
1003
// Used in single-stream-multi-table load. When receive a batch of messages from kafka,
1004
// if the size of batch is more than this threshold, we will request plans for all related tables.
1005
DECLARE_Int32(multi_table_batch_plan_threshold);
1006
1007
// Used in single-stream-multi-table load. When receiving a batch of messages from Kafka,
1008
// if the size of the table wait for plan is more than this threshold, we will request plans for all related tables.
1009
// The param is aimed to avoid requesting and executing too many plans at once.
1010
// Performing small batch processing on multiple tables during the loaded process can reduce the pressure of a single RPC
1011
// and improve the real-time processing of data.
1012
DECLARE_Int32(multi_table_max_wait_tables);
1013
1014
// When the timeout of a load task is less than this threshold,
1015
// Doris treats it as a high priority task.
1016
// high priority tasks use a separate thread pool for flush and do not block rpc by memory cleanup logic.
1017
// this threshold is mainly used to identify routine load tasks and should not be modified if not necessary.
1018
DECLARE_mInt32(load_task_high_priority_threshold_second);
1019
1020
// The min timeout of load rpc (add batch, close)
1021
// Because a load rpc may be blocked for a while.
1022
// Increase this config may avoid rpc timeout.
1023
DECLARE_mInt32(min_load_rpc_timeout_ms);
1024
1025
// use which protocol to access function service, candicate is baidu_std/h2:grpc
1026
DECLARE_String(function_service_protocol);
1027
1028
// use which load balancer to select server to connect
1029
DECLARE_String(rpc_load_balancer);
1030
1031
// a soft limit of string type length, the hard limit is 2GB - 4, but if too long will cause very low performance,
1032
// so we set a soft limit, default is 1MB
1033
DECLARE_mInt32(string_type_length_soft_limit_bytes);
1034
1035
// Threshold fo reading a small file into memory
1036
DECLARE_mInt32(in_memory_file_size);
1037
1038
// Max size of parquet page header in bytes
1039
DECLARE_mInt32(parquet_header_max_size_mb);
1040
// Max buffer size for parquet row group
1041
DECLARE_mInt32(parquet_rowgroup_max_buffer_mb);
1042
// Max buffer size for parquet chunk column
1043
DECLARE_mInt32(parquet_column_max_buffer_mb);
1044
// Merge small IO, the max amplified read ratio
1045
DECLARE_mDouble(max_amplified_read_ratio);
1046
// Equivalent min size of each IO that can reach the maximum storage speed limit
1047
// 1MB for oss, 8KB for hdfs
1048
DECLARE_mInt32(merged_oss_min_io_size);
1049
DECLARE_mInt32(merged_hdfs_min_io_size);
1050
1051
// OrcReader
1052
DECLARE_mInt32(orc_natural_read_size_mb);
1053
DECLARE_mInt64(big_column_size_buffer);
1054
DECLARE_mInt64(small_column_size_buffer);
1055
1056
DECLARE_mInt32(runtime_filter_sampling_frequency);
1057
DECLARE_mInt32(execution_max_rpc_timeout_sec);
1058
DECLARE_mBool(execution_ignore_eovercrowded);
1059
1060
// cooldown task configs
1061
DECLARE_Int32(cooldown_thread_num);
1062
DECLARE_mInt64(generate_cooldown_task_interval_sec);
1063
DECLARE_mInt32(remove_unused_remote_files_interval_sec); // 6h
1064
DECLARE_mInt32(confirm_unused_remote_files_interval_sec);
1065
DECLARE_Int32(cold_data_compaction_thread_num);
1066
DECLARE_mInt32(cold_data_compaction_interval_sec);
1067
DECLARE_mInt32(cold_data_compaction_score_threshold);
1068
1069
DECLARE_Int32(min_s3_file_system_thread_num);
1070
DECLARE_Int32(max_s3_file_system_thread_num);
1071
1072
DECLARE_Bool(enable_time_lut);
1073
DECLARE_mBool(enable_simdjson_reader);
1074
1075
DECLARE_mBool(enable_query_like_bloom_filter);
1076
// number of s3 scanner thread pool size
1077
DECLARE_Int32(doris_remote_scanner_thread_pool_thread_num);
1078
// number of s3 scanner thread pool queue size
1079
DECLARE_Int32(doris_remote_scanner_thread_pool_queue_size);
1080
1081
// limit the queue of pending batches which will be sent by a single nodechannel
1082
DECLARE_mInt64(nodechannel_pending_queue_max_bytes);
1083
1084
// The batch size for sending data by brpc streaming client
1085
DECLARE_mInt64(brpc_streaming_client_batch_bytes);
1086
DECLARE_mInt64(block_cache_wait_timeout_ms);
1087
1088
DECLARE_Bool(enable_brpc_builtin_services);
1089
1090
DECLARE_Bool(enable_brpc_connection_check);
1091
1092
DECLARE_mInt64(brpc_connection_check_timeout_ms);
1093
1094
// Max waiting time to wait the "plan fragment start" rpc.
1095
// If timeout, the fragment will be cancelled.
1096
// This parameter is usually only used when the FE loses connection,
1097
// and the BE can automatically cancel the relevant fragment after the timeout,
1098
// so as to avoid occupying the execution thread for a long time.
1099
DECLARE_mInt32(max_fragment_start_wait_time_seconds);
1100
1101
DECLARE_Int32(fragment_mgr_cancel_worker_interval_seconds);
1102
1103
// Node role tag for backend. Mix role is the default role, and computation role have no
1104
// any tablet.
1105
DECLARE_String(be_node_role);
1106
1107
// Hide webserver page for safety.
1108
// Hide the be config page for webserver.
1109
DECLARE_Bool(hide_webserver_config_page);
1110
1111
DECLARE_Bool(enable_segcompaction);
1112
1113
// Max number of segments allowed in a single segcompaction task.
1114
DECLARE_mInt32(segcompaction_batch_size);
1115
1116
// Max row count allowed in a single source segment, bigger segments will be skipped.
1117
DECLARE_Int32(segcompaction_candidate_max_rows);
1118
1119
// Max file size allowed in a single source segment, bigger segments will be skipped.
1120
DECLARE_Int64(segcompaction_candidate_max_bytes);
1121
1122
// Max total row count allowed in a single segcompaction task.
1123
DECLARE_Int32(segcompaction_task_max_rows);
1124
1125
// Max total file size allowed in a single segcompaction task.
1126
DECLARE_Int64(segcompaction_task_max_bytes);
1127
1128
// Global segcompaction thread pool size.
1129
DECLARE_mInt32(segcompaction_num_threads);
1130
1131
// enable java udf and jdbc scannode
1132
DECLARE_Bool(enable_java_support);
1133
1134
// Set config randomly to check more issues in github workflow
1135
DECLARE_Bool(enable_fuzzy_mode);
1136
1137
DECLARE_Bool(enable_graceful_exit_check);
1138
1139
DECLARE_Bool(enable_debug_points);
1140
1141
DECLARE_Int32(pipeline_executor_size);
1142
DECLARE_Int32(blocking_pipeline_executor_size);
1143
1144
// block file cache
1145
DECLARE_Bool(enable_file_cache);
1146
// format: [{"path":"/path/to/file_cache","total_size":21474836480,"query_limit":10737418240}]
1147
// format: [{"path":"/path/to/file_cache","total_size":21474836480,"query_limit":10737418240},{"path":"/path/to/file_cache2","total_size":21474836480,"query_limit":10737418240}]
1148
// format: [{"path":"/path/to/file_cache","total_size":21474836480,"query_limit":10737418240, "ttl_percent":50, "normal_percent":40, "disposable_percent":5, "index_percent":5}]
1149
// format: [{"path": "xxx", "total_size":53687091200, "storage": "memory"}]
1150
// Note1: storage is "disk" by default
1151
// Note2: when the storage is "memory", the path is ignored. So you can set xxx to anything you like
1152
// and doris will just reset the path to "memory" internally.
1153
// In a very wierd case when your storage is disk, and the directory, by accident, is named
1154
// "memory" for some reason, you should write the path as:
1155
//     {"path": "memory", "total_size":53687091200, "storage": "disk"}
1156
// or use the default storage value:
1157
//     {"path": "memory", "total_size":53687091200}
1158
// Both will use the directory "memory" on the disk instead of the real RAM.
1159
DECLARE_String(file_cache_path);
1160
DECLARE_Int64(file_cache_each_block_size);
1161
DECLARE_Bool(clear_file_cache);
1162
DECLARE_Bool(enable_file_cache_query_limit);
1163
DECLARE_Int32(file_cache_enter_disk_resource_limit_mode_percent);
1164
DECLARE_Int32(file_cache_exit_disk_resource_limit_mode_percent);
1165
DECLARE_mBool(enable_evict_file_cache_in_advance);
1166
DECLARE_mInt32(file_cache_enter_need_evict_cache_in_advance_percent);
1167
DECLARE_mInt32(file_cache_exit_need_evict_cache_in_advance_percent);
1168
DECLARE_mInt32(file_cache_evict_in_advance_interval_ms);
1169
DECLARE_mInt64(file_cache_evict_in_advance_batch_bytes);
1170
DECLARE_mInt64(file_cache_evict_in_advance_recycle_keys_num_threshold);
1171
DECLARE_mBool(enable_read_cache_file_directly);
1172
DECLARE_Bool(file_cache_enable_evict_from_other_queue_by_size);
1173
// If true, evict the ttl cache using LRU when full.
1174
// Otherwise, only expiration can evict ttl and new data won't add to cache when full.
1175
DECLARE_Bool(enable_ttl_cache_evict_using_lru);
1176
DECLARE_mBool(enbale_dump_error_file);
1177
// limit the max size of error log on disk
1178
DECLARE_mInt64(file_cache_error_log_limit_bytes);
1179
DECLARE_mInt64(cache_lock_wait_long_tail_threshold_us);
1180
DECLARE_mInt64(cache_lock_held_long_tail_threshold_us);
1181
// Base compaction may retrieve and produce some less frequently accessed data,
1182
// potentially affecting the file cache hit rate.
1183
// This configuration determines whether to retain the output within the file cache.
1184
// Make your choice based on the following considerations:
1185
// If your file cache is ample enough to accommodate all the data in your database,
1186
// enable this option; otherwise, it is recommended to leave it disabled.
1187
DECLARE_mBool(enable_file_cache_keep_base_compaction_output);
1188
DECLARE_mBool(enable_file_cache_adaptive_write);
1189
DECLARE_mDouble(file_cache_keep_base_compaction_output_min_hit_ratio);
1190
DECLARE_mDouble(file_cache_meta_store_vs_file_system_diff_num_threshold);
1191
DECLARE_mDouble(file_cache_keep_schema_change_output_min_hit_ratio);
1192
DECLARE_mInt64(file_cache_remove_block_qps_limit);
1193
DECLARE_mInt64(file_cache_background_gc_interval_ms);
1194
DECLARE_mInt64(file_cache_background_block_lru_update_interval_ms);
1195
DECLARE_mInt64(file_cache_background_block_lru_update_qps_limit);
1196
DECLARE_mBool(enable_reader_dryrun_when_download_file_cache);
1197
DECLARE_mInt64(file_cache_background_monitor_interval_ms);
1198
DECLARE_mInt64(file_cache_background_ttl_gc_interval_ms);
1199
DECLARE_mInt64(file_cache_background_ttl_info_update_interval_ms);
1200
DECLARE_mInt64(file_cache_background_tablet_id_flush_interval_ms);
1201
DECLARE_mInt64(file_cache_background_ttl_gc_batch);
1202
DECLARE_Int32(file_cache_downloader_thread_num_min);
1203
DECLARE_Int32(file_cache_downloader_thread_num_max);
1204
// used to persist lru information before be reboot and load the info back
1205
DECLARE_mInt64(file_cache_background_lru_dump_interval_ms);
1206
// dump queue only if the queue update specific times through several dump intervals
1207
DECLARE_mInt64(file_cache_background_lru_dump_update_cnt_threshold);
1208
DECLARE_mInt64(file_cache_background_lru_dump_tail_record_num);
1209
DECLARE_mInt64(file_cache_background_lru_log_replay_interval_ms);
1210
DECLARE_mBool(enable_evaluate_shadow_queue_diff);
1211
1212
// inverted index searcher cache
1213
// cache entry stay time after lookup
1214
DECLARE_mInt32(index_cache_entry_stay_time_after_lookup_s);
1215
// cache entry that have not been visited for a certain period of time can be cleaned up by GC thread
1216
DECLARE_mInt32(inverted_index_cache_stale_sweep_time_sec);
1217
// inverted index searcher cache size
1218
DECLARE_String(inverted_index_searcher_cache_limit);
1219
DECLARE_mBool(enable_write_index_searcher_cache);
1220
DECLARE_Bool(enable_inverted_index_cache_check_timestamp);
1221
DECLARE_mBool(enable_inverted_index_correct_term_write);
1222
DECLARE_Int32(inverted_index_fd_number_limit_percent); // 50%
1223
DECLARE_Int32(inverted_index_query_cache_shards);
1224
1225
// inverted index match bitmap cache size
1226
DECLARE_String(inverted_index_query_cache_limit);
1227
1228
// condition cache limit
1229
DECLARE_Int16(condition_cache_limit);
1230
1231
// inverted index
1232
DECLARE_mDouble(inverted_index_ram_buffer_size);
1233
DECLARE_mInt32(inverted_index_max_buffered_docs);
1234
// dict path for chinese analyzer
1235
DECLARE_String(inverted_index_dict_path);
1236
DECLARE_Int32(inverted_index_read_buffer_size);
1237
// tree depth for bkd index
1238
DECLARE_Int32(max_depth_in_bkd_tree);
1239
// index compaction
1240
DECLARE_mBool(inverted_index_compaction_enable);
1241
// Only for debug, do not use in production
1242
DECLARE_mBool(debug_inverted_index_compaction);
1243
// index by RAM directory
1244
DECLARE_mBool(inverted_index_ram_dir_enable);
1245
// wheather index by RAM directory when base compaction
1246
DECLARE_mBool(inverted_index_ram_dir_enable_when_base_compaction);
1247
// use num_broadcast_buffer blocks as buffer to do broadcast
1248
DECLARE_Int32(num_broadcast_buffer);
1249
1250
// max depth of expression tree allowed.
1251
DECLARE_Int32(max_depth_of_expr_tree);
1252
1253
// Report a tablet as bad when io errors occurs more than this value.
1254
DECLARE_mInt64(max_tablet_io_errors);
1255
1256
// Report a tablet as bad when its path not found
1257
DECLARE_Int32(tablet_path_check_interval_seconds);
1258
DECLARE_mInt32(tablet_path_check_batch_size);
1259
1260
// it must be larger than or equal to 5MB
1261
DECLARE_mInt64(s3_write_buffer_size);
1262
// Log interval when doing s3 upload task
1263
DECLARE_mInt32(s3_file_writer_log_interval_second);
1264
// the max number of cached file handle for block segemnt
1265
DECLARE_mInt64(file_cache_max_file_reader_cache_size);
1266
DECLARE_mInt64(hdfs_write_batch_buffer_size_mb);
1267
//enable shrink memory
1268
DECLARE_mBool(enable_shrink_memory);
1269
// enable cache for high concurrent point query work load
1270
DECLARE_mInt32(schema_cache_capacity);
1271
DECLARE_mInt32(schema_cache_sweep_time_sec);
1272
1273
// max number of segment cache
1274
DECLARE_Int32(segment_cache_capacity);
1275
DECLARE_Int32(segment_cache_fd_percentage);
1276
DECLARE_Int32(segment_cache_memory_percentage);
1277
DECLARE_Bool(enable_segment_cache_prune);
1278
1279
DECLARE_mInt32(estimated_mem_per_column_reader);
1280
1281
// enable binlog
1282
DECLARE_Bool(enable_feature_binlog);
1283
1284
// enable set in BitmapValue
1285
DECLARE_Bool(enable_set_in_bitmap_value);
1286
1287
// max number of hdfs file handle in cache
1288
DECLARE_Int64(max_hdfs_file_handle_cache_num);
1289
DECLARE_Int32(max_hdfs_file_handle_cache_time_sec);
1290
1291
// max number of meta info of external files, such as parquet footer
1292
DECLARE_Int64(max_external_file_meta_cache_num);
1293
// Apply delete pred in cumu compaction
1294
DECLARE_mBool(enable_delete_when_cumu_compaction);
1295
1296
// max_write_buffer_number for rocksdb
1297
DECLARE_Int32(rocksdb_max_write_buffer_number);
1298
1299
// Convert date 0000-00-00 to 0000-01-01. It's recommended to set to false.
1300
DECLARE_mBool(allow_zero_date);
1301
// Allow invalid decimalv2 literal for compatible with old version. Recommend set it false strongly.
1302
DECLARE_mBool(allow_invalid_decimalv2_literal);
1303
// Allow to specify kerberos credentials cache path.
1304
DECLARE_mString(kerberos_ccache_path);
1305
// set krb5.conf path, use "/etc/krb5.conf" by default
1306
DECLARE_mString(kerberos_krb5_conf_path);
1307
// the interval for renew kerberos ticket cache
1308
DECLARE_mInt32(kerberos_refresh_interval_second);
1309
1310
// JDK-8153057: avoid StackOverflowError thrown from the UncaughtExceptionHandler in thread "process reaper"
1311
DECLARE_mBool(jdk_process_reaper_use_default_stack_size);
1312
1313
// Values include `none`, `glog`, `boost`, `glibc`, `libunwind`
1314
DECLARE_mString(get_stack_trace_tool);
1315
DECLARE_mBool(enable_address_sanitizers_with_stack_trace);
1316
1317
// DISABLED: Don't resolve location info.
1318
// FAST: Perform CU lookup using .debug_aranges (might be incomplete).
1319
// FULL: Scan all CU in .debug_info (slow!) on .debug_aranges lookup failure.
1320
// FULL_WITH_INLINE: Scan .debug_info (super slower, use with caution) for inline functions in addition to FULL.
1321
DECLARE_mString(dwarf_location_info_mode);
1322
1323
// the ratio of _prefetch_size/_batch_size in AutoIncIDBuffer
1324
DECLARE_mInt64(auto_inc_prefetch_size_ratio);
1325
1326
// the ratio of _low_level_water_level_mark/_batch_size in AutoIncIDBuffer
1327
DECLARE_mInt64(auto_inc_low_water_level_mark_size_ratio);
1328
1329
// number of threads that fetch auto-inc ranges from FE
1330
DECLARE_mInt64(auto_inc_fetch_thread_num);
1331
// Max connection cache num for point lookup queries
1332
DECLARE_mInt64(lookup_connection_cache_capacity);
1333
1334
// level of compression when using LZ4_HC, whose defalut value is LZ4HC_CLEVEL_DEFAULT
1335
DECLARE_mInt64(LZ4_HC_compression_level);
1336
// Threshold of a column as sparse column
1337
// Notice: TEST ONLY
1338
DECLARE_mBool(variant_use_cloud_schema_dict_cache);
1339
// Threshold to estimate a column is sparsed
1340
// Notice: TEST ONLY
1341
DECLARE_mInt64(variant_threshold_rows_to_estimate_sparse_column);
1342
// Treat invalid json format str as string, instead of throwing exception if false
1343
DECLARE_mBool(variant_throw_exeception_on_invalid_json);
1344
// Enable vertical compact subcolumns of variant column
1345
DECLARE_mBool(enable_vertical_compact_variant_subcolumns);
1346
1347
DECLARE_mBool(enable_merge_on_write_correctness_check);
1348
// USED FOR DEBUGING
1349
// core directly if the compaction found there's duplicate key on mow table
1350
DECLARE_mBool(enable_mow_compaction_correctness_check_core);
1351
// USED FOR DEBUGING
1352
// let compaction fail if the compaction found there's duplicate key on mow table
1353
DECLARE_mBool(enable_mow_compaction_correctness_check_fail);
1354
// rowid conversion correctness check when compaction for mow table
1355
DECLARE_mBool(enable_rowid_conversion_correctness_check);
1356
// missing rows correctness check when compaction for mow table
1357
DECLARE_mBool(enable_missing_rows_correctness_check);
1358
// When the number of missing versions is more than this value, do not directly
1359
// retry the publish and handle it through async publish.
1360
DECLARE_mInt32(mow_publish_max_discontinuous_version_num);
1361
// When the size of primary keys in memory exceeds this value, finish current segment
1362
// and create a new segment, used in compaction.
1363
DECLARE_mInt64(mow_primary_key_index_max_size_in_memory);
1364
// When the version is not continuous for MOW table in publish phase and the gap between
1365
// current txn's publishing version and the max version of the tablet exceeds this value,
1366
// don't print warning log
1367
DECLARE_mInt32(publish_version_gap_logging_threshold);
1368
// get agg by cache for mow table
1369
DECLARE_mBool(enable_mow_get_agg_by_cache);
1370
// get agg correctness check for mow table
1371
DECLARE_mBool(enable_mow_get_agg_correctness_check_core);
1372
DECLARE_mBool(enable_agg_and_remove_pre_rowsets_delete_bitmap);
1373
DECLARE_mBool(enable_check_agg_and_remove_pre_rowsets_delete_bitmap);
1374
1375
// The secure path with user files, used in the `local` table function.
1376
DECLARE_String(user_files_secure_path);
1377
1378
// If fe's frontend info has not been updated for more than fe_expire_duration_seconds, it will be regarded
1379
// as an abnormal fe, this will cause be to cancel this fe's related query.
1380
DECLARE_Int32(fe_expire_duration_seconds);
1381
1382
// If use stop_be.sh --grace, then BE has to wait all running queries to stop to avoiding running query failure
1383
// , but if the waiting time exceed the limit, then be will exit directly.
1384
// During this period, FE will not send any queries to BE and waiting for all running queries to stop.
1385
DECLARE_Int32(grace_shutdown_wait_seconds);
1386
// When using the graceful stop feature, after the main process waits for
1387
// all currently running tasks to finish, it will continue to wait for
1388
// an additional period to ensure that queries still running on other nodes have also completed.
1389
// Since a BE node cannot detect the task execution status on other BE nodes,
1390
// you may need to increase this threshold to allow for a longer waiting time.
1391
DECLARE_Int32(grace_shutdown_post_delay_seconds);
1392
1393
// BitmapValue serialize version.
1394
DECLARE_Int16(bitmap_serialize_version);
1395
1396
// group commit config
1397
DECLARE_String(group_commit_wal_path);
1398
DECLARE_Int32(group_commit_replay_wal_retry_num);
1399
DECLARE_Int32(group_commit_replay_wal_retry_interval_seconds);
1400
DECLARE_Int32(group_commit_replay_wal_retry_interval_max_seconds);
1401
DECLARE_mInt32(group_commit_relay_wal_threads);
1402
// This config can be set to limit thread number in group commit request fragment thread pool.
1403
DECLARE_mInt32(group_commit_insert_threads);
1404
DECLARE_mInt32(group_commit_memory_rows_for_max_filter_ratio);
1405
DECLARE_Bool(wait_internal_group_commit_finish);
1406
// Max size(bytes) of group commit queues, used for mem back pressure.
1407
DECLARE_mInt32(group_commit_queue_mem_limit);
1408
// Max size(bytes) or percentage(%) of wal disk usage, used for disk space back pressure, default 10% of the disk available space.
1409
// group_commit_wal_max_disk_limit=1024 or group_commit_wal_max_disk_limit=10% can be automatically identified.
1410
DECLARE_mString(group_commit_wal_max_disk_limit);
1411
DECLARE_Bool(group_commit_wait_replay_wal_finish);
1412
1413
// The configuration item is used to lower the priority of the scanner thread,
1414
// typically employed to ensure CPU scheduling for write operations.
1415
// Default is 0, which is default value of thread nice value, increase this value
1416
// to lower the priority of scan threads
1417
DECLARE_Int32(scan_thread_nice_value);
1418
// Used to modify the recycle interval of tablet schema cache
1419
DECLARE_mInt32(tablet_schema_cache_recycle_interval);
1420
// Granularity is at the column level
1421
DECLARE_mInt32(tablet_schema_cache_capacity);
1422
1423
// Use `LOG(FATAL)` to replace `throw` when true
1424
DECLARE_mBool(exit_on_exception);
1425
1426
// cgroup
1427
DECLARE_String(doris_cgroup_cpu_path);
1428
DECLARE_mBool(enable_be_proc_monitor);
1429
DECLARE_mInt32(be_proc_monitor_interval_ms);
1430
DECLARE_Int32(workload_group_metrics_interval_ms);
1431
1432
// This config controls whether the s3 file writer would flush cache asynchronously
1433
DECLARE_Bool(enable_flush_file_cache_async);
1434
1435
// Ingest binlog work pool size
1436
DECLARE_Int32(ingest_binlog_work_pool_size);
1437
1438
// Ingest binlog with persistent connection
1439
DECLARE_Bool(enable_ingest_binlog_with_persistent_connection);
1440
1441
// Log ingest binlog elapsed threshold, -1 means no log
1442
DECLARE_mInt64(ingest_binlog_elapsed_threshold_ms);
1443
1444
// Download binlog rate limit, unit is KB/s
1445
DECLARE_Int32(download_binlog_rate_limit_kbs);
1446
1447
DECLARE_mInt32(buffered_reader_read_timeout_ms);
1448
1449
// whether to enable /api/snapshot api
1450
DECLARE_Bool(enable_snapshot_action);
1451
1452
// The max columns size for a tablet schema
1453
DECLARE_mInt32(variant_max_merged_tablet_schema_size);
1454
1455
DECLARE_mInt64(local_exchange_buffer_mem_limit);
1456
1457
DECLARE_mInt64(enable_debug_log_timeout_secs);
1458
1459
DECLARE_mBool(enable_column_type_check);
1460
1461
// Tolerance for the number of partition id 0 in rowset, default 0
1462
DECLARE_Int32(ignore_invalid_partition_id_rowset_num);
1463
1464
DECLARE_mInt32(report_query_statistics_interval_ms);
1465
DECLARE_mInt32(query_statistics_reserve_timeout_ms);
1466
DECLARE_mInt32(report_exec_status_thread_num);
1467
1468
// consider two high usage disk at the same available level if they do not exceed this diff.
1469
DECLARE_mDouble(high_disk_avail_level_diff_usages);
1470
1471
// create tablet in partition random robin idx lru size, default 10000
1472
DECLARE_Int32(partition_disk_index_lru_size);
1473
DECLARE_String(spill_storage_root_path);
1474
// Spill storage limit specified as number of bytes
1475
// ('<int>[bB]?'), megabytes ('<float>[mM]'), gigabytes ('<float>[gG]'),
1476
// or percentage of capaity ('<int>%').
1477
// Defaults to bytes if no unit is given.
1478
// Must larger than 0.
1479
// If specified as percentage, the final limit value is:
1480
//   disk_capacity_bytes * storage_flood_stage_usage_percent * spill_storage_limit
1481
DECLARE_String(spill_storage_limit);
1482
DECLARE_mInt32(spill_gc_interval_ms);
1483
DECLARE_mInt32(spill_gc_work_time_ms);
1484
DECLARE_Int64(spill_in_paused_queue_timeout_ms);
1485
DECLARE_Int64(wait_cancel_release_memory_ms);
1486
1487
DECLARE_mBool(check_segment_when_build_rowset_meta);
1488
1489
DECLARE_Int32(num_query_ctx_map_partitions);
1490
1491
DECLARE_mBool(force_azure_blob_global_endpoint);
1492
1493
DECLARE_mBool(enable_s3_rate_limiter);
1494
DECLARE_mInt64(s3_get_bucket_tokens);
1495
DECLARE_mInt64(s3_get_token_per_second);
1496
DECLARE_mInt64(s3_get_token_limit);
1497
1498
DECLARE_mInt64(s3_put_bucket_tokens);
1499
DECLARE_mInt64(s3_put_token_per_second);
1500
DECLARE_mInt64(s3_put_token_limit);
1501
// max s3 client retry times
1502
DECLARE_mInt32(max_s3_client_retry);
1503
// When meet s3 429 error, the "get" request will
1504
// sleep s3_read_base_wait_time_ms (*1, *2, *3, *4) ms
1505
// get try again.
1506
// The max sleep time is s3_read_max_wait_time_ms
1507
// and the max retry time is max_s3_client_retry
1508
DECLARE_mInt32(s3_read_base_wait_time_ms);
1509
DECLARE_mInt32(s3_read_max_wait_time_ms);
1510
DECLARE_mBool(enable_s3_object_check_after_upload);
1511
1512
// write as inverted index tmp directory
1513
DECLARE_String(tmp_file_dir);
1514
1515
// the directory for storing the trino-connector plugins.
1516
DECLARE_String(trino_connector_plugin_dir);
1517
1518
// the file paths(one or more) of CA cert, splite using ";" aws s3 lib use it to init s3client
1519
DECLARE_mString(ca_cert_file_paths);
1520
1521
/** Table sink configurations(currently contains only external table types) **/
1522
// Minimum data processed to scale writers in exchange when non partition writing
1523
DECLARE_mInt64(table_sink_non_partition_write_scaling_data_processed_threshold);
1524
// Minimum data processed to trigger skewed partition rebalancing in exchange when partition writing
1525
DECLARE_mInt64(table_sink_partition_write_min_data_processed_rebalance_threshold);
1526
// Minimum partition data processed to rebalance writers in exchange when partition writing
1527
DECLARE_mInt64(table_sink_partition_write_min_partition_data_processed_rebalance_threshold);
1528
// Maximum processed partition nums of per writer when partition writing
1529
DECLARE_mInt32(table_sink_partition_write_max_partition_nums_per_writer);
1530
1531
/** Hive sink configurations **/
1532
DECLARE_mInt64(hive_sink_max_file_size);
1533
1534
/** Iceberg sink configurations **/
1535
DECLARE_mInt64(iceberg_sink_max_file_size);
1536
1537
// Number of open tries, default 1 means only try to open once.
1538
// Retry the Open num_retries time waiting 100 milliseconds between retries.
1539
DECLARE_mInt32(thrift_client_open_num_tries);
1540
1541
// http scheme in S3Client to use. E.g. http or https
1542
DECLARE_String(s3_client_http_scheme);
1543
1544
DECLARE_mBool(ignore_schema_change_check);
1545
1546
/** Only use in fuzzy test **/
1547
DECLARE_mInt64(string_overflow_size);
1548
1549
// The min thread num for BufferedReaderPrefetchThreadPool
1550
DECLARE_Int64(num_buffered_reader_prefetch_thread_pool_min_thread);
1551
// The max thread num for BufferedReaderPrefetchThreadPool
1552
DECLARE_Int64(num_buffered_reader_prefetch_thread_pool_max_thread);
1553
// The min thread num for S3FileUploadThreadPool
1554
DECLARE_Int64(num_s3_file_upload_thread_pool_min_thread);
1555
// The max thread num for S3FileUploadThreadPool
1556
DECLARE_Int64(num_s3_file_upload_thread_pool_max_thread);
1557
// The maximum jvm heap usage ratio for hdfs write workload
1558
DECLARE_mDouble(max_hdfs_wirter_jni_heap_usage_ratio);
1559
// The sleep milliseconds duration when hdfs write exceeds the maximum usage
1560
DECLARE_mInt64(hdfs_jni_write_sleep_milliseconds);
1561
// The max retry times when hdfs write failed
1562
DECLARE_mInt64(hdfs_jni_write_max_retry_time);
1563
1564
// The min thread num for NonBlockCloseThreadPool
1565
DECLARE_Int64(min_nonblock_close_thread_num);
1566
// The max thread num for NonBlockCloseThreadPool
1567
DECLARE_Int64(max_nonblock_close_thread_num);
1568
// The possibility that mem allocator throws an exception during memory allocation
1569
// This config is for test usage, be careful when changing it.
1570
DECLARE_mDouble(mem_alloc_fault_probability);
1571
// The time out milliseconds for remote fetch schema RPC
1572
DECLARE_mInt64(fetch_remote_schema_rpc_timeout_ms);
1573
// The size of the local buffer for S3FileSytem's upload function
1574
1575
DECLARE_Int64(s3_file_system_local_upload_buffer_size);
1576
1577
//JVM monitoring enable. To prevent be from crashing due to jvm compatibility issues.
1578
DECLARE_Bool(enable_jvm_monitor);
1579
1580
// Num threads to load data dirs, default value -1 indicates the same number of threads as the number of data dirs
1581
DECLARE_Int32(load_data_dirs_threads);
1582
1583
// Skip loading stale rowset meta when initializing `TabletMeta` from protobuf
1584
DECLARE_mBool(skip_loading_stale_rowset_meta);
1585
// Whether to use file to record log. When starting BE with --console,
1586
// all logs will be written to both standard output and file.
1587
// Disable this option will no longer use file to record log.
1588
// Only works when starting BE with --console.
1589
DECLARE_Bool(enable_file_logger);
1590
1591
// Enable partition column fallback when partition columns are missing from file
1592
DECLARE_Bool(enable_iceberg_partition_column_fallback);
1593
1594
// The minimum row group size when exporting Parquet files.
1595
DECLARE_Int64(min_row_group_size);
1596
1597
DECLARE_mInt64(compaction_memory_bytes_limit);
1598
1599
DECLARE_mInt64(compaction_batch_size);
1600
1601
DECLARE_mBool(enable_parquet_page_index);
1602
1603
// Wheather to ignore not found file in external teble(eg, hive)
1604
// Default is true, if set to false, the not found file will result in query failure.
1605
DECLARE_mBool(ignore_not_found_file_in_external_table);
1606
1607
DECLARE_mBool(enable_hdfs_mem_limiter);
1608
1609
// Define how many percent data in hashtable bigger than limit
1610
// we should do agg limit opt
1611
DECLARE_mInt16(topn_agg_limit_multiplier);
1612
1613
DECLARE_mInt64(tablet_meta_serialize_size_limit);
1614
1615
DECLARE_mInt64(pipeline_task_leakage_detect_period_secs);
1616
// To be compatible with hadoop's block compression
1617
DECLARE_mInt32(snappy_compression_block_size);
1618
DECLARE_mInt32(lz4_compression_block_size);
1619
1620
DECLARE_mBool(enable_pipeline_task_leakage_detect);
1621
1622
DECLARE_mInt32(check_score_rounds_num);
1623
1624
// MB
1625
DECLARE_Int32(query_cache_size);
1626
DECLARE_Bool(force_regenerate_rowsetid_on_start_error);
1627
1628
// Enable validation to check the correctness of table size.
1629
DECLARE_Bool(enable_table_size_correctness_check);
1630
// Enable sleep 5s between delete cumulative compaction.
1631
DECLARE_mBool(enable_sleep_between_delete_cumu_compaction);
1632
1633
DECLARE_mInt32(compaction_num_per_round);
1634
DECLARE_mInt32(max_automatic_compaction_num_per_round);
1635
1636
DECLARE_mInt32(check_tablet_delete_bitmap_interval_seconds);
1637
DECLARE_mInt32(check_tablet_delete_bitmap_score_top_n);
1638
DECLARE_mBool(enable_check_tablet_delete_bitmap_score);
1639
DECLARE_mInt32(schema_dict_cache_capacity);
1640
1641
// whether to prune rows with delete sign = 1 in base compaction
1642
// ATTN: this config is only for test
1643
DECLARE_mBool(enable_prune_delete_sign_when_base_compaction);
1644
1645
DECLARE_mBool(enable_mow_verbose_log);
1646
1647
DECLARE_mInt32(tablet_sched_delay_time_ms);
1648
DECLARE_mInt32(load_trigger_compaction_version_percent);
1649
DECLARE_mInt64(base_compaction_interval_seconds_since_last_operation);
1650
DECLARE_mBool(enable_compaction_pause_on_high_memory);
1651
1652
DECLARE_mBool(enable_quorum_success_write);
1653
DECLARE_mDouble(quorum_success_max_wait_multiplier);
1654
DECLARE_mInt64(quorum_success_min_wait_seconds);
1655
DECLARE_mInt32(quorum_success_remaining_timeout_seconds);
1656
1657
DECLARE_mBool(enable_calc_delete_bitmap_between_segments_concurrently);
1658
1659
DECLARE_mBool(enable_update_delete_bitmap_kv_check_core);
1660
1661
DECLARE_mBool(enable_fetch_rowsets_from_peer_replicas);
1662
// the max length of segments key bounds, in bytes
1663
// ATTENTION: as long as this conf has ever been enabled, cluster downgrade and backup recovery will no longer be supported.
1664
DECLARE_mInt32(segments_key_bounds_truncation_threshold);
1665
// ATTENTION: for test only, use random segments key bounds truncation threshold every time
1666
DECLARE_mBool(random_segments_key_bounds_truncation);
1667
1668
DECLARE_mBool(enable_auto_clone_on_compaction_missing_version);
1669
1670
DECLARE_mBool(enable_auto_clone_on_mow_publish_missing_version);
1671
1672
// p0, daily, rqg, external
1673
DECLARE_String(fuzzy_test_type);
1674
1675
// The maximum csv line reader output buffer size
1676
DECLARE_mInt64(max_csv_line_reader_output_buffer_size);
1677
1678
// Maximum number of OpenMP threads available for concurrent index builds.
1679
// -1 means auto: use 80% of detected CPU cores.
1680
DECLARE_Int32(omp_threads_limit);
1681
// The capacity of segment partial column cache, used to cache column readers for each segment.
1682
DECLARE_mInt32(max_segment_partial_column_cache_size);
1683
// Chunk size for ANN/vector index building per training/adding batch
1684
DECLARE_mInt64(ann_index_build_chunk_size);
1685
1686
DECLARE_mBool(enable_prefill_output_dbm_agg_cache_after_compaction);
1687
DECLARE_mBool(enable_prefill_all_dbm_agg_cache_after_compaction);
1688
1689
DECLARE_mBool(enable_wal_tde);
1690
1691
DECLARE_mBool(print_stack_when_cache_miss);
1692
1693
DECLARE_mBool(read_cluster_cache_opt_verbose_log);
1694
1695
DECLARE_mString(aws_credentials_provider_version);
1696
1697
#ifdef BE_TEST
1698
// test s3
1699
DECLARE_String(test_s3_resource);
1700
DECLARE_String(test_s3_ak);
1701
DECLARE_String(test_s3_sk);
1702
DECLARE_String(test_s3_endpoint);
1703
DECLARE_String(test_s3_region);
1704
DECLARE_String(test_s3_bucket);
1705
DECLARE_String(test_s3_prefix);
1706
#endif
1707
1708
class Register {
1709
public:
1710
    struct Field {
1711
        const char* type = nullptr;
1712
        const char* name = nullptr;
1713
        void* storage = nullptr;
1714
        const char* defval = nullptr;
1715
        bool valmutable = false;
1716
        Field(const char* ftype, const char* fname, void* fstorage, const char* fdefval,
1717
              bool fvalmutable)
1718
5.96k
                : type(ftype),
1719
5.96k
                  name(fname),
1720
5.96k
                  storage(fstorage),
1721
5.96k
                  defval(fdefval),
1722
5.96k
                  valmutable(fvalmutable) {}
1723
    };
1724
1725
public:
1726
    static std::map<std::string, Field>* _s_field_map;
1727
1728
public:
1729
    Register(const char* ftype, const char* fname, void* fstorage, const char* fdefval,
1730
5.95k
             bool fvalmutable) {
1731
5.95k
        if (_s_field_map == nullptr) {
1732
8
            _s_field_map = new std::map<std::string, Field>();
1733
8
        }
1734
5.95k
        Field field(ftype, fname, fstorage, fdefval, fvalmutable);
1735
5.95k
        _s_field_map->insert(std::make_pair(std::string(fname), field));
1736
5.95k
    }
1737
};
1738
1739
// RegisterConfValidator class is used to store validator function of registered config fields in
1740
// Register::_s_field_map.
1741
// If any validator return false when BE bootstart, the bootstart will be terminated.
1742
// If validator return false when use http API to update some config, the config will not
1743
// be modified and the API will return failure.
1744
class RegisterConfValidator {
1745
public:
1746
    // Validator for each config name.
1747
    static std::map<std::string, std::function<bool()>>* _s_field_validator;
1748
1749
public:
1750
120
    RegisterConfValidator(const char* fname, const std::function<bool()>& validator) {
1751
120
        if (_s_field_validator == nullptr) {
1752
8
            _s_field_validator = new std::map<std::string, std::function<bool()>>();
1753
8
        }
1754
        // register validator to _s_field_validator
1755
120
        _s_field_validator->insert(std::make_pair(std::string(fname), validator));
1756
120
    }
1757
};
1758
1759
// configuration properties load from config file.
1760
class Properties {
1761
public:
1762
    // load conf from file, if must_exist is true and file does not exist, return false
1763
    bool load(const char* conf_file, bool must_exist = true);
1764
1765
    // Find the config value by key from `file_conf_map`.
1766
    // If found, set `retval` to the config value,
1767
    // or set `retval` to `defstr`
1768
    // if retval is not set(in case defstr is nullptr), set is_retval_set to false
1769
    template <typename T>
1770
    bool get_or_default(const char* key, const char* defstr, T& retval, bool* is_retval_set,
1771
                        std::string& rawval) const;
1772
1773
    void set(const std::string& key, const std::string& val);
1774
1775
    void set_force(const std::string& key, const std::string& val);
1776
1777
    // dump props to conf file
1778
    Status dump(const std::string& conffile);
1779
1780
private:
1781
    std::map<std::string, std::string> file_conf_map;
1782
};
1783
1784
// full configurations.
1785
extern std::map<std::string, std::string>* full_conf_map;
1786
1787
extern std::mutex custom_conf_lock;
1788
1789
// Init the config from `conf_file`.
1790
// If fill_conf_map is true, the updated config will also update the `full_conf_map`.
1791
// If must_exist is true and `conf_file` does not exist, this function will return false.
1792
// If set_to_default is true, the config value will be set to default value if not found in `conf_file`.
1793
bool init(const char* conf_file, bool fill_conf_map = false, bool must_exist = true,
1794
          bool set_to_default = true);
1795
1796
Status set_config(const std::string& field, const std::string& value, bool need_persist = false,
1797
                  bool force = false);
1798
1799
Status persist_config(const std::string& field, const std::string& value);
1800
1801
std::mutex* get_mutable_string_config_lock();
1802
1803
std::vector<std::vector<std::string>> get_config_info();
1804
1805
Status set_fuzzy_configs();
1806
1807
void update_config(const std::string& field, const std::string& value);
1808
1809
} // namespace config
1810
} // namespace doris