Coverage Report

Created: 2026-11-05 09:24

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 <cstddef>
21
#include <cstdint>
22
#include <functional>
23
#include <map>
24
#include <mutex>
25
#include <string>
26
#include <utility>
27
#include <vector>
28
29
#define DECLARE_FIELD(FIELD_TYPE, FIELD_NAME) extern FIELD_TYPE FIELD_NAME
30
31
#define DECLARE_Bool(name) DECLARE_FIELD(bool, name)
32
#define DECLARE_Int16(name) DECLARE_FIELD(int16_t, name)
33
#define DECLARE_Int32(name) DECLARE_FIELD(int32_t, name)
34
#define DECLARE_Int64(name) DECLARE_FIELD(int64_t, name)
35
#define DECLARE_Double(name) DECLARE_FIELD(double, name)
36
#define DECLARE_String(name) DECLARE_FIELD(std::string, name)
37
#define DECLARE_Bools(name) DECLARE_FIELD(std::vector<bool>, name)
38
#define DECLARE_Int16s(name) DECLARE_FIELD(std::vector<int16_t>, name)
39
#define DECLARE_Int32s(name) DECLARE_FIELD(std::vector<int32_t>, name)
40
#define DECLARE_Int64s(name) DECLARE_FIELD(std::vector<int64_t>, name)
41
#define DECLARE_Doubles(name) DECLARE_FIELD(std::vector<double>, name)
42
#define DECLARE_Strings(name) DECLARE_FIELD(std::vector<std::string>, name)
43
#define DECLARE_mBool(name) DECLARE_FIELD(bool, name)
44
#define DECLARE_mInt16(name) DECLARE_FIELD(int16_t, name)
45
#define DECLARE_mInt32(name) DECLARE_FIELD(int32_t, name)
46
#define DECLARE_mInt64(name) DECLARE_FIELD(int64_t, name)
47
#define DECLARE_mDouble(name) DECLARE_FIELD(double, name)
48
#define DECLARE_mString(name) DECLARE_FIELD(std::string, name)
49
50
#define DEFINE_FIELD(FIELD_TYPE, FIELD_NAME, FIELD_DEFAULT, VALMUTABLE)                      \
51
    FIELD_TYPE FIELD_NAME;                                                                   \
52
    static Register reg_##FIELD_NAME(#FIELD_TYPE, #FIELD_NAME, &(FIELD_NAME), FIELD_DEFAULT, \
53
                                     VALMUTABLE);
54
55
#define DEFINE_VALIDATOR(FIELD_NAME, VALIDATOR)              \
56
10.5k
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_42clEi
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_43clEi
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_44clEi
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_45clEi
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_46clEi
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_47clEi
Line
Count
Source
56
16
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_48clEi
Line
Count
Source
56
24
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_49clEi
Line
Count
Source
56
24
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_50clEi
Line
Count
Source
56
24
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_51clEl
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_52clEi
Line
Count
Source
56
24
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_53clEi
Line
Count
Source
56
24
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_54clEi
Line
Count
Source
56
24
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_55clEl
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_56clEi
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_57clEi
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_58clEi
Line
Count
Source
56
32
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_59clEl
Line
Count
Source
56
28
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_60clEi
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_61clEd
Line
Count
Source
56
10.1k
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_63clEl
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_64clEi
Line
Count
Source
56
24
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_66clEl
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_67clEl
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_68clEl
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_69clEl
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_70clEl
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_71clEl
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_72clERKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
56
24
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_73clEl
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_74clEl
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_75clERKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
56
24
    static auto validator_##FIELD_NAME = VALIDATOR;          \
config.cpp:_ZNK5doris6config4$_76clEi
Line
Count
Source
56
8
    static auto validator_##FIELD_NAME = VALIDATOR;          \
57
    static RegisterConfValidator reg_validator_##FIELD_NAME( \
58
8.67k
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_0clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_1clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_2clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_3clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_4clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_5clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_6clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_7clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_8clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config3$_9clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_10clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_11clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_12clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_13clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_14clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_15clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_16clEv
Line
Count
Source
58
22
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_17clEv
Line
Count
Source
58
26
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_18clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_19clEv
Line
Count
Source
58
8.09k
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_21clEv
Line
Count
Source
58
8
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_22clEv
Line
Count
Source
58
8
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_23clEv
Line
Count
Source
58
11
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_24clEv
Line
Count
Source
58
13
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_25clEv
Line
Count
Source
58
11
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_26clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_27clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_29clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_30clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_31clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_32clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_33clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_34clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_35clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_36clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_37clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_38clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
config.cpp:_ZNK5doris6config4$_39clEv
Line
Count
Source
58
16
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
59
60
// DEFINE_ON_UPDATE macro is used to register a callback function that will be called
61
// when the config field is updated at runtime.
62
// The callback function signature is: void callback(T old_value, T new_value)
63
// where T is the type of the config field.
64
// Example:
65
//   DEFINE_ON_UPDATE(my_config, [](int64_t old_val, int64_t new_val) {
66
//       LOG(INFO) << "my_config changed from " << old_val << " to " << new_val;
67
//   });
68
#define DEFINE_ON_UPDATE_IMPL(FIELD_NAME, CALLBACK)                               \
69
2.05k
    static auto on_update_callback_##FIELD_NAME = CALLBACK;                       \
config.cpp:_ZNK5doris6config4$_62clEdd
Line
Count
Source
69
2.03k
    static auto on_update_callback_##FIELD_NAME = CALLBACK;                       \
Unexecuted instantiation: config.cpp:_ZNK5doris6config4$_65clEii
block_file_cache_factory.cpp:_ZNK5doris6config3$_6clEbb
Line
Count
Source
69
17
    static auto on_update_callback_##FIELD_NAME = CALLBACK;                       \
block_file_cache_factory.cpp:_ZNK5doris6config3$_7clEii
Line
Count
Source
69
2
    static auto on_update_callback_##FIELD_NAME = CALLBACK;                       \
block_file_cache_factory.cpp:_ZNK5doris6config3$_8clEll
Line
Count
Source
69
4
    static auto on_update_callback_##FIELD_NAME = CALLBACK;                       \
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_31clEll
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_32clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_33clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_34clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_35clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_36clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_37clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_38clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_39clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_40clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_41clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_42clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_43clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_44clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_45clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_46clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_47clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_48clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_49clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_50clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_51clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_52clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_53clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_54clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_55clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_56clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_57clEii
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_58clEdd
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_59clEdd
70
    static RegisterConfUpdateCallback reg_update_callback_##FIELD_NAME(           \
71
2.04k
            #FIELD_NAME, [](const void* old_ptr, const void* new_ptr) {           \
72
4.09k
                on_update_callback_##FIELD_NAME(                                  \
73
2.04k
                        *reinterpret_cast<const decltype(FIELD_NAME)*>(old_ptr),  \
74
2.04k
                        *reinterpret_cast<const decltype(FIELD_NAME)*>(new_ptr)); \
75
2.04k
            });
config.cpp:_ZNK5doris6config4$_20clEPKvS3_
Line
Count
Source
71
2.03k
            #FIELD_NAME, [](const void* old_ptr, const void* new_ptr) {           \
72
4.07k
                on_update_callback_##FIELD_NAME(                                  \
73
2.03k
                        *reinterpret_cast<const decltype(FIELD_NAME)*>(old_ptr),  \
74
2.03k
                        *reinterpret_cast<const decltype(FIELD_NAME)*>(new_ptr)); \
75
2.03k
            });
Unexecuted instantiation: config.cpp:_ZNK5doris6config4$_28clEPKvS3_
block_file_cache_factory.cpp:_ZNK5doris6config3$_3clEPKvS3_
Line
Count
Source
71
3
            #FIELD_NAME, [](const void* old_ptr, const void* new_ptr) {           \
72
6
                on_update_callback_##FIELD_NAME(                                  \
73
3
                        *reinterpret_cast<const decltype(FIELD_NAME)*>(old_ptr),  \
74
3
                        *reinterpret_cast<const decltype(FIELD_NAME)*>(new_ptr)); \
75
3
            });
block_file_cache_factory.cpp:_ZNK5doris6config3$_4clEPKvS3_
Line
Count
Source
71
2
            #FIELD_NAME, [](const void* old_ptr, const void* new_ptr) {           \
72
4
                on_update_callback_##FIELD_NAME(                                  \
73
2
                        *reinterpret_cast<const decltype(FIELD_NAME)*>(old_ptr),  \
74
2
                        *reinterpret_cast<const decltype(FIELD_NAME)*>(new_ptr)); \
75
2
            });
block_file_cache_factory.cpp:_ZNK5doris6config3$_5clEPKvS3_
Line
Count
Source
71
4
            #FIELD_NAME, [](const void* old_ptr, const void* new_ptr) {           \
72
8
                on_update_callback_##FIELD_NAME(                                  \
73
4
                        *reinterpret_cast<const decltype(FIELD_NAME)*>(old_ptr),  \
74
4
                        *reinterpret_cast<const decltype(FIELD_NAME)*>(new_ptr)); \
75
4
            });
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config3$_2clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config3$_3clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config3$_4clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config3$_5clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config3$_6clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config3$_7clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config3$_8clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config3$_9clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_10clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_11clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_12clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_13clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_14clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_15clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_16clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_17clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_18clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_19clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_20clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_21clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_22clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_23clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_24clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_25clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_26clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_27clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_28clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_29clEPKvS3_
Unexecuted instantiation: exec_env_init.cpp:_ZNK5doris6config4$_30clEPKvS3_
76
77
#define DEFINE_ON_UPDATE(name, callback) DEFINE_ON_UPDATE_IMPL(name, callback)
78
79
#define DEFINE_Int16(name, defaultstr) DEFINE_FIELD(int16_t, name, defaultstr, false)
80
#define DEFINE_Bools(name, defaultstr) DEFINE_FIELD(std::vector<bool>, name, defaultstr, false)
81
#define DEFINE_Doubles(name, defaultstr) DEFINE_FIELD(std::vector<double>, name, defaultstr, false)
82
#define DEFINE_Int16s(name, defaultstr) DEFINE_FIELD(std::vector<int16_t>, name, defaultstr, false)
83
#define DEFINE_Int32s(name, defaultstr) DEFINE_FIELD(std::vector<int32_t>, name, defaultstr, false)
84
#define DEFINE_Int64s(name, defaultstr) DEFINE_FIELD(std::vector<int64_t>, name, defaultstr, false)
85
#define DEFINE_Bool(name, defaultstr) DEFINE_FIELD(bool, name, defaultstr, false)
86
#define DEFINE_Double(name, defaultstr) DEFINE_FIELD(double, name, defaultstr, false)
87
#define DEFINE_Int32(name, defaultstr) DEFINE_FIELD(int32_t, name, defaultstr, false)
88
#define DEFINE_Int64(name, defaultstr) DEFINE_FIELD(int64_t, name, defaultstr, false)
89
#define DEFINE_String(name, defaultstr) DEFINE_FIELD(std::string, name, defaultstr, false)
90
#define DEFINE_Strings(name, defaultstr) \
91
    DEFINE_FIELD(std::vector<std::string>, name, defaultstr, false)
92
#define DEFINE_mBool(name, defaultstr) DEFINE_FIELD(bool, name, defaultstr, true)
93
#define DEFINE_mInt16(name, defaultstr) DEFINE_FIELD(int16_t, name, defaultstr, true)
94
#define DEFINE_mInt32(name, defaultstr) DEFINE_FIELD(int32_t, name, defaultstr, true)
95
#define DEFINE_mInt64(name, defaultstr) DEFINE_FIELD(int64_t, name, defaultstr, true)
96
#define DEFINE_mDouble(name, defaultstr) DEFINE_FIELD(double, name, defaultstr, true)
97
#define DEFINE_mString(name, defaultstr) DEFINE_FIELD(std::string, name, defaultstr, true)
98
#define DEFINE_Validator(name, validator) DEFINE_VALIDATOR(name, validator)
99
100
namespace doris {
101
class Status;
102
103
// If you want to modify the value of config, please go to common/config.cpp to modify.
104
namespace config {
105
// Dir of custom config file
106
DECLARE_String(custom_config_dir);
107
108
// Dir of jdbc drivers
109
DECLARE_String(jdbc_drivers_dir);
110
111
// cluster id
112
DECLARE_Int32(cluster_id);
113
// port on which BackendService is exported
114
DECLARE_Int32(be_port);
115
116
// port for brpc
117
DECLARE_Int32(brpc_port);
118
119
// port for arrow flight sql
120
// Default -1, do not start arrow flight sql server.
121
DECLARE_Int32(arrow_flight_sql_port);
122
123
// Validate Arrow input buffers in opted-in Arrow readers before converting them to Doris columns.
124
DECLARE_Bool(enable_arrow_input_validation);
125
126
// port for cdc client scan oltp cdc data
127
DECLARE_Int32(cdc_client_port);
128
129
// JVM options passed to cdc_client (whitespace-separated). Inserted before -jar.
130
DECLARE_String(cdc_client_java_opts);
131
132
// If the external client cannot directly access priority_networks, set public_host to be accessible
133
// to external client.
134
// There are usually two usage scenarios:
135
// 1. in production environment, it is often inconvenient to expose Doris BE nodes to the external network.
136
// However, a reverse proxy (such as Nginx) can be added to all Doris BE nodes, and the external client will be
137
// randomly routed to a Doris BE node when connecting to Nginx. set public_host to the host of Nginx.
138
// 2. if priority_networks is an internal network IP, and BE node has its own independent external IP,
139
// but Doris currently does not support modifying priority_networks, setting public_host to the real external IP.
140
DECLARE_mString(public_host);
141
142
// If the BE node is connected to the external network through a reverse proxy like Nginx
143
// and need to use Arrow Flight SQL, should add a server in Nginx to reverse proxy
144
// `Nginx:arrow_flight_sql_proxy_port` to `BE_priority_networks:arrow_flight_sql_port`. For example:
145
// upstream arrowflight {
146
//    server 10.16.10.8:8069;
147
//    server 10.16.10.8:8068;
148
//}
149
// server {
150
//    listen 8167 http2;
151
//    listen [::]:8167 http2;
152
//    server_name doris.arrowflight.com;
153
// }
154
DECLARE_Int32(arrow_flight_sql_proxy_port);
155
156
// the number of bthreads for brpc, the default value is set to -1,
157
// which means the number of bthreads is #cpu-cores
158
DECLARE_Int32(brpc_num_threads);
159
DECLARE_Int32(brpc_idle_timeout_sec);
160
161
// Maximum number of multi-dimensional bvar samples exported by /brpc_metrics.
162
DECLARE_String(bvar_max_dump_multi_dimension_metric_num);
163
164
// Declare a selection strategy for those servers have many ips.
165
// Note that there should at most one ip match this list.
166
// This is a list in semicolon-delimited format, in CIDR notation, e.g. 10.10.10.0/24
167
// If no ip match this rule, will choose one randomly.
168
DECLARE_String(priority_networks);
169
170
// performance moderate or compact, only tcmalloc compile
171
DECLARE_String(memory_mode);
172
173
// if true, process memory limit and memory usage based on cgroup memory info.
174
DECLARE_mBool(enable_use_cgroup_memory_info);
175
176
// process memory limit specified as number of bytes
177
// ('<int>[bB]?'), megabytes ('<float>[mM]'), gigabytes ('<float>[gG]'),
178
// or percentage of the physical memory ('<int>%').
179
// defaults to bytes if no unit is given"
180
// must larger than 0. and if larger than physical memory size,
181
// it will be set to physical memory size.
182
DECLARE_String(mem_limit);
183
184
// Soft memory limit as a fraction of hard memory limit.
185
DECLARE_Double(soft_mem_limit_frac);
186
187
// Cache capacity reduce mem limit as a fraction of soft mem limit.
188
DECLARE_mDouble(cache_capacity_reduce_mem_limit_frac);
189
190
// Schema change memory limit as a fraction of soft memory limit.
191
DECLARE_Double(schema_change_mem_limit_frac);
192
193
// Many modern allocators (for example) do not do a mremap for
194
// realloc, even in case of large enough chunks of memory. Although this allows
195
// you to increase performance and reduce memory consumption during realloc.
196
// To fix this, we do mremap manually if the chunk of memory is large enough.
197
//
198
// The threshold (128 MB, 128 * (1ULL << 20)) is chosen quite large, since changing the address
199
// space is very slow, especially in the case of a large number of threads. We
200
// expect that the set of operations mmap/something to do/mremap can only be
201
// performed about 1000 times per second.
202
//
203
// P.S. This is also required, because tcmalloc can not allocate a chunk of
204
// memory greater than 16 GB.
205
DECLARE_mInt64(mmap_threshold); // bytes
206
207
// When hash table capacity is greater than 2^double_grow_degree(default 2G), grow when 75% of the capacity is satisfied.
208
// Increase can reduce the number of hash table resize, but may waste more memory.
209
DECLARE_mInt32(hash_table_double_grow_degree);
210
211
// The max fill rate for hash table
212
DECLARE_mInt32(max_fill_rate);
213
214
DECLARE_mInt32(double_resize_threshold);
215
216
// The maximum low water mark of the system `/proc/meminfo/MemAvailable`, Unit byte, default -1.
217
// if it is -1, then low water mark = min(MemTotal - MemLimit, MemTotal * 5%), which is 3.2G on a 64G machine.
218
// Turn up max. more memory buffers will be reserved for Memory GC.
219
// Turn down max. will use as much memory as possible.
220
// note that: `max_` prefix should be removed, but keep it for compatibility.
221
DECLARE_Int64(max_sys_mem_available_low_water_mark_bytes);
222
223
// reserve a small amount of memory so we do not trigger MinorGC
224
DECLARE_Int64(memtable_limiter_reserved_memory_bytes);
225
226
// The size of the memory that gc wants to release each time, as a percentage of the mem limit.
227
DECLARE_mString(process_minor_gc_size);
228
DECLARE_mString(process_full_gc_size);
229
230
// gc will release cache, cancel task, and task will wait for gc to release memory,
231
// default gc strategy is conservative, if you want to exclude the interference of gc, let it be true
232
DECLARE_mBool(disable_memory_gc);
233
234
// for the query being canceled,
235
// if (current time - cancel start time) < revoke_memory_max_tolerance_ms, the query memory is counted in `freed_memory`,
236
// and the query memory is expected to be released soon.
237
// if > revoke_memory_max_tolerance_ms, the query memory will not be counted in `freed_memory`,
238
// and the query may be blocked during the cancel process. skip this query and continue to cancel other queries.
239
DECLARE_mInt64(revoke_memory_max_tolerance_ms);
240
241
// if false, turn off all stacktrace
242
DECLARE_mBool(enable_stacktrace);
243
244
// when alloc memory larger than stacktrace_in_alloc_large_memory_bytes, default 2G - 1,
245
// if alloc successful, will print a warning with stacktrace, but not prevent memory alloc.
246
// if alloc failed using Doris Allocator, will print stacktrace in error log.
247
// if is -1, disable print stacktrace when alloc large memory.
248
DECLARE_mInt64(stacktrace_in_alloc_large_memory_bytes);
249
250
// when alloc memory larger than crash_in_alloc_large_memory_bytes will crash, default -1 means disabled.
251
// if you need a core dump to analyze large memory allocation,
252
// modify this parameter to crash when large memory allocation occur will help
253
DECLARE_mInt64(crash_in_alloc_large_memory_bytes);
254
255
// The actual meaning of this parameter is `debug_memory`.
256
// 1. crash in memory tracker inaccurate, if memory tracker value is inaccurate, BE will crash.
257
//    usually used in test environments, default value is false.
258
// 2. print more memory logs.
259
DECLARE_mBool(crash_in_memory_tracker_inaccurate);
260
261
// default is true. if any memory tracking in Orphan mem tracker will report error.
262
// !! not modify the default value of this conf!! otherwise memory errors cannot be detected in time.
263
// allocator free memory not need to check, because when the thread memory tracker label is Orphan,
264
// use the tracker saved in Allocator.
265
DECLARE_mBool(enable_memory_orphan_check);
266
267
// The maximum time a thread waits for a full GC. Currently only query will wait for full gc.
268
DECLARE_mInt32(thread_wait_gc_max_milliseconds);
269
270
// reach mem limit, don't serialize in batch
271
DECLARE_mInt64(pre_serialize_keys_limit_bytes);
272
273
// the port heartbeat service used
274
DECLARE_Int32(heartbeat_service_port);
275
// the count of heart beat service
276
DECLARE_Int32(heartbeat_service_thread_count);
277
// the count of thread to create table
278
DECLARE_Int32(create_tablet_worker_count);
279
// the count of thread to drop table
280
DECLARE_Int32(drop_tablet_worker_count);
281
// the count of thread to batch load
282
DECLARE_Int32(push_worker_count_normal_priority);
283
// the count of thread to high priority batch load
284
DECLARE_Int32(push_worker_count_high_priority);
285
// the count of thread to publish version
286
DECLARE_Int32(publish_version_worker_count);
287
// the count of tablet thread to publish version
288
DECLARE_Int32(tablet_publish_txn_max_thread);
289
// the timeout of EnginPublishVersionTask
290
DECLARE_Int32(publish_version_task_timeout_s);
291
// the count of thread to calc delete bitmap
292
DECLARE_Int32(calc_delete_bitmap_max_thread);
293
// the num of threads to calc delete bitmap when building rowset
294
DECLARE_Int32(calc_delete_bitmap_for_load_max_thread);
295
// the count of thread to calc delete bitmap worker, only used for cloud
296
DECLARE_Int32(calc_delete_bitmap_worker_count);
297
// the count of thread to calc tablet delete bitmap task, only used for cloud
298
DECLARE_Int32(calc_tablet_delete_bitmap_task_max_thread);
299
// the count of thread to clear transaction task
300
DECLARE_Int32(clear_transaction_task_worker_count);
301
// the count of thread to delete
302
DECLARE_Int32(delete_worker_count);
303
// the count of thread to alter table
304
DECLARE_Int32(alter_tablet_worker_count);
305
// the count of thread to alter index
306
DECLARE_Int32(alter_index_worker_count);
307
// the count of thread to clone
308
DECLARE_Int32(clone_worker_count);
309
// the count of thread to clone
310
DECLARE_Int32(storage_medium_migrate_count);
311
// the count of thread to check consistency
312
DECLARE_Int32(check_consistency_worker_count);
313
// the count of thread to upload
314
DECLARE_Int32(upload_worker_count);
315
// the count of thread to download
316
DECLARE_Int32(download_worker_count);
317
// the count of thread to make snapshot
318
DECLARE_Int32(make_snapshot_worker_count);
319
// the count of thread to release snapshot
320
DECLARE_Int32(release_snapshot_worker_count);
321
// the count of thread to make committed rowsets visible in cloud mode
322
DECLARE_Int32(cloud_make_committed_rs_visible_worker_count);
323
// report random wait a little time to avoid FE receiving multiple be reports at the same time.
324
// do not set it to false for production environment
325
DECLARE_mBool(report_random_wait);
326
// the interval time(seconds) for agent report tasks signature to FE
327
DECLARE_mInt32(report_task_interval_seconds);
328
// the interval time(seconds) for agent report disk state to FE
329
DECLARE_mInt32(report_disk_state_interval_seconds);
330
// the interval time(seconds) for agent report olap table to FE
331
DECLARE_mInt32(report_tablet_interval_seconds);
332
// Per-list cap: a report carries at most 2 * report_active_tablet_max_num entries
333
// (one top-N list for queries, one for loads).
334
//
335
// Sizing against fe cloud_active_partition_scheduling_topn: FE reserves only topn/2 for the
336
// query bucket and backfills whatever the load bucket leaves free from the query list, so
337
// one dimension can claim the whole budget. The worst case -- the cluster's entire hot set
338
// on a single BE -- therefore wants this >= topn. The default is deliberately half of the
339
// FE default instead: FE merges across backends, so it takes a one-BE hot set for the cap
340
// to bind at all, and paying 2x the report size on every BE in every cluster to cover that
341
// is not worth it. Raise it if you raise the FE value, or if a BE reports
342
// report.active_tablet_truncated far above zero.
343
DECLARE_mInt32(report_active_tablet_max_num);
344
// Only tablets queried / loaded within this window are reported as active.
345
DECLARE_mInt32(report_active_tablet_window_second);
346
// the max download speed(KB/s)
347
DECLARE_mInt32(max_download_speed_kbps);
348
// download low speed limit(KB/s)
349
DECLARE_mInt32(download_low_speed_limit_kbps);
350
// download low speed time(seconds)
351
DECLARE_mInt32(download_low_speed_time);
352
// whether to download small files in batch.
353
DECLARE_mBool(enable_batch_download);
354
// whether to enable stream load forward endpoint for cloud group commit
355
DECLARE_mBool(enable_group_commit_streamload_be_forward);
356
// whether to check md5sum when download
357
DECLARE_mBool(enable_download_md5sum_check);
358
// download binlog meta timeout
359
DECLARE_mInt32(download_binlog_meta_timeout_ms);
360
// the interval time(seconds) for agent report index policy to FE
361
DECLARE_mInt32(report_index_policy_interval_seconds);
362
363
// deprecated, use env var LOG_DIR in be.conf
364
DECLARE_String(sys_log_dir);
365
// for udf
366
DECLARE_String(user_function_dir);
367
// INFO, WARNING, ERROR, FATAL
368
DECLARE_String(sys_log_level);
369
// TIME-DAY, TIME-HOUR, SIZE-MB-nnn
370
DECLARE_String(sys_log_roll_mode);
371
// log roll num
372
DECLARE_Int32(sys_log_roll_num);
373
// verbose log
374
DECLARE_Strings(sys_log_verbose_modules);
375
// verbose log level
376
DECLARE_Int32(sys_log_verbose_level);
377
// verbose log FLAGS_v
378
DECLARE_Int32(sys_log_verbose_flags_v);
379
// log buffer level
380
DECLARE_String(log_buffer_level);
381
// log enable custom date time format
382
DECLARE_Bool(sys_log_enable_custom_date_time_format);
383
// log custom date time format (https://en.cppreference.com/w/cpp/io/manip/put_time)
384
DECLARE_String(sys_log_custom_date_time_format);
385
// log custom date time milliseconds format (fmt::format)
386
DECLARE_String(sys_log_custom_date_time_ms_format);
387
388
// number of threads available to serve backend execution requests
389
DECLARE_Int32(be_service_threads);
390
391
// interval between profile reports; in seconds
392
DECLARE_mInt32(pipeline_status_report_interval);
393
// Time slice for pipeline task execution (ms)
394
DECLARE_mInt32(pipeline_task_exec_time_slice);
395
396
// task executor min concurrency per task
397
DECLARE_mInt32(task_executor_min_concurrency_per_task);
398
// task executor max concurrency per task
399
DECLARE_mInt32(task_executor_max_concurrency_per_task);
400
// task task executor inital split max concurrency per task, later concurrency may be adjusted dynamically
401
DECLARE_mInt32(task_executor_initial_max_concurrency_per_task);
402
// Enable task executor in internal table scan.
403
DECLARE_Bool(enable_task_executor_in_internal_table);
404
// Enable task executor in external table scan.
405
DECLARE_Bool(enable_task_executor_in_external_table);
406
407
// number of scanner thread pool size for olap table
408
// and the min thread num of remote scanner thread pool
409
DECLARE_mInt32(doris_scanner_thread_pool_thread_num);
410
DECLARE_mInt32(doris_scanner_min_thread_pool_thread_num);
411
// number of batch size to fetch the remote split source
412
DECLARE_mInt32(remote_split_source_batch_size);
413
// max number of remote scanner thread pool size
414
// if equal to -1, value is std::max(512, CpuInfo::num_cores() * 10)
415
DECLARE_Int32(doris_max_remote_scanner_thread_pool_thread_num);
416
// number of olap scanner thread pool queue size
417
DECLARE_Int32(doris_scanner_thread_pool_queue_size);
418
// default thrift client connect timeout(in seconds)
419
DECLARE_mInt32(thrift_connect_timeout_seconds);
420
// default thrift client retry interval (in milliseconds)
421
DECLARE_mInt64(thrift_client_retry_interval_ms);
422
// max message size of thrift request
423
// default: 100 * 1024 * 1024
424
DECLARE_mInt32(thrift_max_message_size);
425
// max bytes number for single scan range, used in segmentv2
426
DECLARE_mInt32(doris_scan_range_max_mb);
427
// single read execute fragment row number
428
DECLARE_mInt32(doris_scanner_row_num);
429
// single read execute fragment row bytes
430
DECLARE_mInt32(doris_scanner_row_bytes);
431
// single read execute fragment max run time millseconds
432
DECLARE_mInt32(doris_scanner_max_run_time_ms);
433
// (Advanced) Maximum size of per-query receive-side buffer
434
DECLARE_mInt32(exchg_node_buffer_size_bytes);
435
DECLARE_mInt32(exchg_buffer_queue_capacity_factor);
436
437
// memory_limitation_per_thread_for_schema_change_bytes unit bytes
438
DECLARE_mInt64(memory_limitation_per_thread_for_schema_change_bytes);
439
440
// all cache prune interval, used by GC and periodic thread.
441
DECLARE_mInt32(cache_prune_interval_sec);
442
DECLARE_mInt32(cache_periodic_prune_stale_sweep_sec);
443
// the clean interval of tablet lookup cache
444
DECLARE_mInt32(tablet_lookup_cache_stale_sweep_time_sec);
445
DECLARE_mInt32(point_query_row_cache_stale_sweep_time_sec);
446
DECLARE_mInt32(disk_stat_monitor_interval);
447
DECLARE_mInt32(unused_rowset_monitor_interval);
448
DECLARE_mInt32(quering_rowsets_evict_interval);
449
DECLARE_String(storage_root_path);
450
DECLARE_mString(broken_storage_path);
451
DECLARE_Int32(min_active_scan_threads);
452
DECLARE_Int32(min_active_file_scan_threads);
453
454
// Config is used to check incompatible old format hdr_ format
455
// whether doris uses strict way. When config is true, process will log fatal
456
// and exit. When config is false, process will only log warning.
457
DECLARE_Bool(storage_strict_check_incompatible_old_format);
458
459
// BE process will exit if the percentage of error disk reach this value.
460
DECLARE_mInt32(max_percentage_of_error_disk);
461
DECLARE_mInt32(default_num_rows_per_column_file_block);
462
// pending data policy
463
DECLARE_mInt32(pending_data_expire_time_sec);
464
// inc_rowset snapshot rs sweep time interval
465
DECLARE_mInt32(tablet_rowset_stale_sweep_time_sec);
466
// tablet stale rowset sweep by threshold size
467
DECLARE_Bool(tablet_rowset_stale_sweep_by_size);
468
DECLARE_mInt32(tablet_rowset_stale_sweep_threshold_size);
469
// garbage sweep policy
470
DECLARE_Int32(max_garbage_sweep_interval);
471
DECLARE_Int32(min_garbage_sweep_interval);
472
// garbage sweep every batch will sleep 1ms
473
DECLARE_mInt32(garbage_sweep_batch_size);
474
DECLARE_mInt32(snapshot_expire_time_sec);
475
// It is only a recommended value. When the disk space is insufficient,
476
// the file storage period under trash dose not have to comply with this parameter.
477
DECLARE_mInt32(trash_file_expire_time_sec);
478
// minimum file descriptor number
479
// modify them upon necessity
480
DECLARE_Int32(min_file_descriptor_number);
481
DECLARE_mBool(disable_segment_cache);
482
// Enable checking segment rows consistency between rowset meta and segment footer
483
DECLARE_mBool(enable_segment_rows_consistency_check);
484
DECLARE_mBool(enable_segment_rows_check_core);
485
// ATTENTION: For test only. In test environment, there are no historical data,
486
// so all rowset meta should have segment rows info.
487
DECLARE_mBool(fail_when_segment_rows_not_in_rowset_meta);
488
DECLARE_String(row_cache_mem_limit);
489
490
// Cache for storage page size
491
DECLARE_String(storage_page_cache_limit);
492
// Shard size for page cache, the value must be power of two.
493
// It's recommended to set it to a value close to the number of BE cores in order to reduce lock contentions.
494
DECLARE_Int32(storage_page_cache_shard_size);
495
DECLARE_mInt32(file_cache_mem_storage_shard_num);
496
// Percentage for index page cache
497
// all storage page cache will be divided into data_page_cache and index_page_cache
498
DECLARE_Int32(index_page_cache_percentage);
499
// whether to disable page cache feature in storage
500
// TODO delete it. Divided into Data page, Index page, pk index page
501
DECLARE_Bool(disable_storage_page_cache);
502
// whether to disable row cache feature in storage
503
DECLARE_mBool(disable_storage_row_cache);
504
// Parquet page cache: threshold ratio for caching decompressed vs compressed pages
505
// If uncompressed_size / compressed_size <= threshold, cache decompressed;
506
// otherwise cache compressed if enable_parquet_cache_compressed_pages = true
507
DECLARE_Double(parquet_page_cache_decompress_threshold);
508
// Parquet page cache: whether to enable caching compressed pages (when ratio exceeds threshold)
509
DECLARE_Bool(enable_parquet_cache_compressed_pages);
510
// whether to disable pk page cache feature in storage
511
DECLARE_Bool(disable_pk_storage_page_cache);
512
513
// Cache for mow primary key storage page size, it's seperated from
514
// storage_page_cache_limit
515
DECLARE_String(pk_storage_page_cache_limit);
516
// data page size for primary key index
517
DECLARE_Int32(primary_key_data_page_size);
518
519
// inc_rowset snapshot rs sweep time interval
520
DECLARE_mInt32(data_page_cache_stale_sweep_time_sec);
521
DECLARE_mInt32(index_page_cache_stale_sweep_time_sec);
522
// great impact on the performance of MOW, so it can be longer.
523
DECLARE_mInt32(pk_index_page_cache_stale_sweep_time_sec);
524
525
DECLARE_mBool(enable_low_cardinality_optimize);
526
DECLARE_Bool(enable_low_cardinality_cache_code);
527
528
// Adaptive batch size: dynamically adjust SegmentIterator chunk row count using EWMA
529
// so that each output block stays close to preferred_block_size_bytes.
530
// When false, the fixed batch_size row behaviour is preserved.
531
DECLARE_mBool(enable_adaptive_batch_size);
532
533
// be policy
534
// whether check compaction checksum
535
DECLARE_mBool(enable_compaction_checksum);
536
// whether disable automatic compaction task
537
DECLARE_mBool(disable_auto_compaction);
538
// whether enable vertical compaction
539
DECLARE_mBool(enable_vertical_compaction);
540
// whether enable ordered data compaction
541
DECLARE_mBool(enable_ordered_data_compaction);
542
// In vertical compaction, column number for every group
543
DECLARE_mInt32(vertical_compaction_num_columns_per_group);
544
// In vertical compaction, max memory usage for row_source_buffer
545
DECLARE_Int32(vertical_compaction_max_row_source_memory_mb);
546
// In vertical compaction, max dest segment file size
547
DECLARE_mInt64(vertical_compaction_max_segment_size);
548
// Threshold for sparse column compaction optimization (average bytes per row)
549
// Density threshold for sparse column compaction optimization
550
// density = (total_cells - null_cells) / total_cells, smaller means more sparse
551
// When density <= threshold, enable sparse optimization
552
// 0 = disable optimization, 1 = always enable
553
// Default 1 means always enable sparse optimization
554
DECLARE_mDouble(sparse_column_compaction_threshold_percent);
555
// Enable RLE batch Put optimization for compaction
556
DECLARE_mBool(enable_rle_batch_put_optimization);
557
558
// If enabled, segments will be flushed column by column
559
DECLARE_mBool(enable_vertical_segment_writer);
560
561
// In ordered data compaction, min segment size for input rowset
562
DECLARE_mInt32(ordered_data_compaction_min_segment_size);
563
564
// This config can be set to limit thread number in compaction thread pool.
565
DECLARE_mInt32(max_base_compaction_threads);
566
DECLARE_mInt32(max_cumu_compaction_threads);
567
568
DECLARE_Bool(enable_base_compaction_idle_sched);
569
DECLARE_mInt64(base_compaction_min_rowset_num);
570
DECLARE_mInt64(base_compaction_max_compaction_score);
571
DECLARE_mInt64(mow_base_compaction_max_compaction_score);
572
DECLARE_mDouble(base_compaction_min_data_ratio);
573
DECLARE_mInt64(base_compaction_dup_key_max_file_size_mbytes);
574
575
DECLARE_Bool(enable_skip_tablet_compaction);
576
DECLARE_mInt32(skip_tablet_compaction_second);
577
// output rowset of cumulative compaction total disk size exceed this config size,
578
// this rowset will be given to base compaction, unit is m byte.
579
DECLARE_mInt64(compaction_promotion_size_mbytes);
580
581
// output rowset of cumulative compaction total disk size exceed this config ratio of
582
// base rowset's total disk size, this rowset will be given to base compaction. The value must be between
583
// 0 and 1.
584
DECLARE_mDouble(compaction_promotion_ratio);
585
586
// the smallest size of rowset promotion. When the rowset is less than this config, this
587
// rowset will be not given to base compaction. The unit is m byte.
588
DECLARE_mInt64(compaction_promotion_min_size_mbytes);
589
590
// When output rowset of cumulative compaction total version count (end_version - start_version)
591
// exceed this config count, the rowset will be moved to base compaction.
592
// NOTE: this config only works for unique key merge-on-write tables. The default maximum value
593
// disables version-count-based promotion while retaining the option to enable it when needed.
594
DECLARE_mInt64(compaction_promotion_version_count);
595
596
// The lower bound size to do cumulative compaction. When total disk size of candidate rowsets is less than
597
// this size, size_based policy may not do to cumulative compaction. The unit is m byte.
598
DECLARE_mInt64(compaction_min_size_mbytes);
599
600
// cumulative compaction policy: min and max delta file's number
601
DECLARE_mInt64(cumulative_compaction_min_deltas);
602
DECLARE_mInt64(cumulative_compaction_max_deltas);
603
DECLARE_mInt32(cumulative_compaction_max_deltas_factor);
604
605
// This config can be set to limit thread number in  multiget thread pool.
606
DECLARE_mInt32(multi_get_max_threads);
607
608
// The upper limit of "permits" held by all compaction tasks. This config can be set to limit memory consumption for compaction.
609
DECLARE_mInt64(total_permits_for_compaction_score);
610
611
// sleep interval in ms after generated compaction tasks
612
DECLARE_mInt32(generate_compaction_tasks_interval_ms);
613
614
// Compaction task number per disk.
615
// Must be greater than 2, because Base compaction and Cumulative compaction have at least one thread each.
616
DECLARE_mInt32(compaction_task_num_per_disk);
617
// compaction thread num for fast disk(typically .SSD), must be greater than 2.
618
DECLARE_mInt32(compaction_task_num_per_fast_disk);
619
620
// How many rounds of cumulative compaction for each round of base compaction when compaction tasks generation.
621
DECLARE_mInt32(cumulative_compaction_rounds_for_each_base_compaction_round);
622
623
// Minimum number of threads required in the thread pool to activate the large cumu compaction delay strategy.
624
// The delay strategy is only applied when the thread pool has at least this many threads.
625
DECLARE_mInt32(large_cumu_compaction_task_min_thread_num);
626
// Maximum size threshold (in bytes) for input rowsets. Compaction tasks with input size
627
// exceeding this threshold will be delayed when thread pool is near capacity. Default 100MB.
628
DECLARE_mInt32(large_cumu_compaction_task_bytes_threshold);
629
// Maximum row count threshold for compaction input. Compaction tasks with row count
630
// exceeding this threshold will be delayed when thread pool is near capacity. Default 1 million.
631
DECLARE_mInt32(large_cumu_compaction_task_row_num_threshold);
632
633
// Not compact the invisible versions, but with some limitations:
634
// if not timeout, keep no more than compaction_keep_invisible_version_max_count versions;
635
// if timeout, keep no more than compaction_keep_invisible_version_min_count versions.
636
DECLARE_mInt32(compaction_keep_invisible_version_timeout_sec);
637
DECLARE_mInt32(compaction_keep_invisible_version_min_count);
638
DECLARE_mInt32(compaction_keep_invisible_version_max_count);
639
640
// Threshold to logging compaction trace, in seconds.
641
DECLARE_mInt32(base_compaction_trace_threshold);
642
DECLARE_mInt32(cumulative_compaction_trace_threshold);
643
DECLARE_mBool(disable_compaction_trace_log);
644
645
DECLARE_mBool(enable_compaction_task_tracker);
646
DECLARE_mInt32(compaction_task_tracker_max_records);
647
648
// Interval to picking rowset to compact, in seconds
649
DECLARE_mInt64(pick_rowset_to_compact_interval_sec);
650
651
// Compaction priority schedule
652
DECLARE_mBool(enable_compaction_priority_scheduling);
653
DECLARE_mInt32(low_priority_compaction_task_num_per_disk);
654
DECLARE_mInt32(low_priority_compaction_score_threshold);
655
656
// Thread count to do tablet meta checkpoint, -1 means use the data directories count.
657
DECLARE_Int32(max_meta_checkpoint_threads);
658
659
// Threshold to logging agent task trace, in seconds.
660
DECLARE_mInt32(agent_task_trace_threshold_sec);
661
662
// This config can be set to limit thread number in tablet migration thread pool.
663
DECLARE_Int32(min_tablet_migration_threads);
664
DECLARE_Int32(max_tablet_migration_threads);
665
666
DECLARE_mInt32(finished_migration_tasks_size);
667
// If size less than this, the remaining rowsets will be force to complete
668
DECLARE_mInt32(migration_remaining_size_threshold_mb);
669
// If the task runs longer than this time, the task will be terminated, in seconds.
670
// timeout = std::max(migration_task_timeout_secs,  tablet size / 1MB/s)
671
DECLARE_mInt32(migration_task_timeout_secs);
672
// timeout for try_lock migration lock
673
DECLARE_Int64(migration_lock_timeout_ms);
674
675
// Port to start debug webserver on
676
DECLARE_Int32(webserver_port);
677
// TLS module enable flag
678
DECLARE_Bool(enable_tls);
679
// Path of TLS certificate
680
DECLARE_String(tls_certificate_path);
681
// Path of TLS private key
682
DECLARE_String(tls_private_key_path);
683
// Password for encrypted TLS private key
684
DECLARE_String(tls_private_key_password);
685
// TLS peer verification mode
686
DECLARE_String(tls_verify_mode);
687
// Path of TLS CA certificate
688
DECLARE_String(tls_ca_certificate_path);
689
// TLS certificate reload interval, in seconds
690
DECLARE_Int32(tls_cert_refresh_interval_seconds);
691
// Comma-separated excluded server protocols: brpc,thrift,http,arrowflight
692
DECLARE_String(tls_excluded_protocols);
693
// Required peer certificate DNS SAN allowlist for private protocols, syntax: brpc=a.com;thrift=b.com.
694
// Empty means allow all peers. Once configured, the list acts as an allowlist and only peers whose
695
// DNS SAN matches at least one configured entry for that protocol are allowed.
696
DECLARE_String(tls_peer_cert_required_san_dns);
697
// Https enable flag
698
DECLARE_Bool(enable_https);
699
// Path of certificate
700
DECLARE_String(ssl_certificate_path);
701
// Path of private key
702
DECLARE_String(ssl_private_key_path);
703
// Whether to check authorization
704
DECLARE_Bool(enable_all_http_auth);
705
// Number of webserver workers
706
DECLARE_Int32(webserver_num_workers);
707
708
// Async replies: stream load only now
709
// reply wait timeout only happens if:
710
// 1. Stream load fragment execution times out
711
//    HTTP request freed → stream load canceled
712
// 2. Client disconnects
713
DECLARE_mInt32(async_reply_timeout_s);
714
715
DECLARE_Bool(enable_single_replica_load);
716
// Number of download workers for single replica load
717
DECLARE_Int32(single_replica_load_download_num_workers);
718
719
// Used for mini Load. mini load data file will be removed after this time.
720
DECLARE_Int64(load_data_reserve_hours);
721
// log error log will be removed after this time
722
DECLARE_mInt64(load_error_log_reserve_hours);
723
// error log size limit, default 200MB
724
DECLARE_mInt64(load_error_log_limit_bytes);
725
726
// Dedicated load cancellation workers, default 32. Must be positive; requires a restart.
727
DECLARE_Int32(brpc_load_light_work_pool_threads);
728
// Queue capacity for the dedicated load cancellation pool.
729
// -1 selects max(1024, CPU cores * 32) queued requests. Requires a restart.
730
DECLARE_Int32(brpc_load_light_work_pool_max_queue_size);
731
732
// be brpc interface is classified into two categories: light and heavy
733
// each category has diffrent thread number
734
// threads to handle heavy api interface, such as transmit_block etc
735
DECLARE_Int32(brpc_heavy_work_pool_threads);
736
DECLARE_Int32(brpc_peer_fetch_pool_threads);
737
// threads to handle light api interface, such as exec_plan_fragment_prepare/exec_plan_fragment_start
738
DECLARE_Int32(brpc_light_work_pool_threads);
739
DECLARE_Int32(brpc_heavy_work_pool_max_queue_size);
740
DECLARE_Int32(brpc_peer_fetch_pool_max_queue_size);
741
DECLARE_Int32(brpc_light_work_pool_max_queue_size);
742
DECLARE_mBool(enable_bthread_transmit_block);
743
DECLARE_Int32(brpc_arrow_flight_work_pool_threads);
744
DECLARE_Int32(brpc_arrow_flight_work_pool_max_queue_size);
745
746
// The maximum amount of data that can be processed by a stream load
747
DECLARE_mInt64(streaming_load_max_mb);
748
// Some data formats, such as JSON, cannot be streamed.
749
// Therefore, it is necessary to limit the maximum number of
750
// such data when using stream load to prevent excessive memory consumption.
751
DECLARE_mInt64(streaming_load_json_max_mb);
752
// the alive time of a TabletsChannel.
753
// If the channel does not receive any data till this time,
754
// the channel will be removed.
755
DECLARE_mInt32(streaming_load_rpc_max_alive_time_sec);
756
// the timeout of a rpc to open the tablet writer in remote BE.
757
// short operation time, can set a short timeout
758
DECLARE_Int32(tablet_writer_open_rpc_timeout_sec);
759
// You can ignore brpc error '[E1011]The server is overcrowded' when writing data.
760
DECLARE_mBool(tablet_writer_ignore_eovercrowded);
761
DECLARE_mInt32(slave_replica_writer_rpc_timeout_sec);
762
// Whether to enable stream load record function, the default is false.
763
// False: disable stream load record
764
DECLARE_mBool(enable_stream_load_record);
765
// Whether to enable stream load record to audit log table, the default is true.
766
DECLARE_mBool(enable_stream_load_record_to_audit_log_table);
767
// the maximum bytes of a batch of stream load records to audit log table
768
DECLARE_mInt64(stream_load_record_batch_bytes);
769
// the interval to send a batch of stream load records to audit log table
770
DECLARE_mInt64(stream_load_record_batch_interval_secs);
771
// batch size of stream load record reported to FE
772
DECLARE_mInt32(stream_load_record_batch_size);
773
// expire time of stream load record in rocksdb.
774
DECLARE_Int32(stream_load_record_expire_time_secs);
775
// time interval to clean expired stream load records
776
DECLARE_mInt64(clean_stream_load_record_interval_secs);
777
// enable stream load commit txn on BE directly, bypassing FE. Only for cloud.
778
DECLARE_mBool(enable_stream_load_commit_txn_on_be);
779
// The buffer size to store stream table function schema info
780
DECLARE_Int64(stream_tvf_buffer_size);
781
782
// request cdc client timeout
783
DECLARE_mInt32(request_cdc_client_timeout_ms);
784
785
// OlapTableSink sender's send interval, should be less than the real response time of a tablet writer rpc.
786
// You may need to lower the speed when the sink receiver bes are too busy.
787
DECLARE_mInt32(olap_table_sink_send_interval_microseconds);
788
// For auto partition, the send interval will multiply the factor
789
DECLARE_mDouble(olap_table_sink_send_interval_auto_partition_factor);
790
791
// Fragment thread pool
792
DECLARE_Int32(fragment_mgr_async_work_pool_thread_num_min);
793
DECLARE_Int32(fragment_mgr_async_work_pool_thread_num_max);
794
DECLARE_Int32(fragment_mgr_async_work_pool_queue_size);
795
796
// Control the number of disks on the machine.  If 0, this comes from the system settings.
797
DECLARE_Int32(num_disks);
798
// The read size is the size of the reads sent to os.
799
// There is a trade off of latency and throughout, trying to keep disks busy but
800
// not introduce seeks.  The literature seems to agree that with 8 MB reads, random
801
// io and sequential io perform similarly.
802
DECLARE_Int32(read_size);       // 8 * 1024 * 1024, Read Size (in bytes)
803
DECLARE_Int32(min_buffer_size); // 1024, The minimum read buffer size (in bytes)
804
805
// for pprof
806
DECLARE_String(pprof_profile_dir);
807
// for jeprofile in jemalloc
808
DECLARE_mString(jeprofile_dir);
809
// Purge all unused dirty pages for all arenas.
810
DECLARE_mBool(enable_je_purge_dirty_pages);
811
// Jemalloc `arenas.dirty_decay_ms`, equal to `dirty_decay_ms` in JEMALLOC_CONF in be.conf.
812
DECLARE_mInt32(je_dirty_decay_ms);
813
814
// to forward compatibility, will be removed later
815
DECLARE_mBool(enable_token_check);
816
817
// to open/close system metrics
818
DECLARE_Bool(enable_system_metrics);
819
820
// Number of cores Doris will used, this will effect only when it's greater than 0.
821
// Otherwise, Doris will use all cores returned from "/proc/cpuinfo".
822
DECLARE_Int32(num_cores);
823
824
// When BE start, If there is a broken disk, BE process will exit by default.
825
// Otherwise, we will ignore the broken disk,
826
DECLARE_Bool(ignore_broken_disk);
827
DECLARE_Bool(ignore_file_cache_dir_upgrade_failure);
828
829
// Sleep time in milliseconds between memory maintenance iterations
830
DECLARE_mInt32(memory_maintenance_sleep_time_ms);
831
832
// Memory gc are expensive, wait a while to avoid too frequent.
833
DECLARE_mInt32(memory_gc_sleep_time_ms);
834
835
// max write buffer size before flush, default 200MB
836
DECLARE_mInt64(write_buffer_size);
837
DECLARE_mBool(enable_adaptive_write_buffer_size);
838
// max buffer size used in memtable for the aggregated table, default 400MB
839
DECLARE_mInt64(write_buffer_size_for_agg);
840
841
DECLARE_mInt64(min_write_buffer_size_for_partial_update);
842
// max parallel flush task per memtable writer
843
DECLARE_mInt32(memtable_flush_running_count_limit);
844
845
// maximum sleep time to wait for memory when writing or flushing memtable.
846
DECLARE_mInt32(memtable_wait_for_memory_sleep_time_s);
847
848
DECLARE_Int32(load_process_max_memory_limit_percent); // 50%
849
850
// If the memory consumption of load jobs exceed load_process_max_memory_limit,
851
// all load jobs will hang there to wait for memtable flush. We should have a
852
// soft limit which can trigger the memtable flush for the load channel who
853
// consumes lagest memory size before we reach the hard limit. The soft limit
854
// might avoid all load jobs hang at the same time.
855
DECLARE_Int32(load_process_soft_mem_limit_percent);
856
857
// If load memory consumption is within load_process_safe_mem_permit_percent,
858
// memtable memory limiter will do nothing.
859
DECLARE_Int32(load_process_safe_mem_permit_percent);
860
861
// If there are a lot of memtable memory, then wait them flush finished.
862
DECLARE_mDouble(load_max_wg_active_memtable_percent);
863
864
// result buffer cancelled time (unit: second)
865
DECLARE_mInt32(result_buffer_cancelled_interval_time);
866
867
// arrow flight result sink buffer rows size, default 4096 * 8
868
DECLARE_mInt32(arrow_flight_result_sink_buffer_size_rows);
869
// The timeout for ADBC Client to wait for data using arrow flight reader.
870
// If the query is very complex and no result is generated after this time, consider increasing this timeout.
871
DECLARE_mInt32(arrow_flight_reader_brpc_controller_timeout_ms);
872
873
// the increased frequency of priority for remaining tasks in BlockingPriorityQueue
874
DECLARE_mInt32(priority_queue_remaining_tasks_increased_frequency);
875
876
// sync tablet_meta when modifying meta
877
DECLARE_mBool(sync_tablet_meta);
878
879
// sync a file writer when it is closed
880
DECLARE_mBool(sync_file_on_close);
881
882
// default thrift rpc timeout ms
883
DECLARE_mInt32(thrift_rpc_timeout_ms);
884
885
// txn commit rpc timeout
886
DECLARE_mInt32(txn_commit_rpc_timeout_ms);
887
888
// If set to true, metric calculator will run
889
DECLARE_Bool(enable_metric_calculator);
890
891
// max consumer num in one data consumer group, for routine load
892
DECLARE_mInt32(max_consumer_num_per_group);
893
894
// the max size of thread pool for routine load task.
895
// this should be larger than FE config 'max_routine_load_task_num_per_be' (default 5)
896
DECLARE_Int32(max_routine_load_thread_pool_size);
897
898
// max external scan cache batch count, means cache max_memory_cache_batch_count * batch_size row
899
// default is 20, batch_size's default value is 1024 means 20 * 1024 rows will be cached
900
DECLARE_mInt32(max_memory_sink_batch_count);
901
902
// This configuration is used for the context gc thread schedule period
903
// note: unit is minute, default is 5min
904
DECLARE_mInt32(scan_context_gc_interval_min);
905
906
// es scroll keep-alive
907
DECLARE_String(es_scroll_keepalive);
908
909
// HTTP connection timeout for es
910
DECLARE_mInt32(es_http_timeout_ms);
911
912
// the max client cache number per each host
913
// There are variety of client cache in BE, but currently we use the
914
// same cache size configuration.
915
// TODO(cmy): use different config to set different client cache if necessary.
916
DECLARE_Int32(max_client_cache_size_per_host);
917
918
DECLARE_Int32(max_master_fe_client_cache_size);
919
920
// Dir to save files downloaded by SmallFileMgr
921
DECLARE_String(small_file_dir);
922
// path gc
923
DECLARE_Bool(path_gc_check);
924
DECLARE_mInt32(path_gc_check_interval_second);
925
DECLARE_mInt32(path_gc_check_step);
926
DECLARE_mInt32(path_gc_check_step_interval_ms);
927
928
// The following 2 configs limit the max usage of disk capacity of a data dir.
929
// If both of these 2 threshold reached, no more data can be writen into that data dir.
930
// The percent of max used capacity of a data dir
931
DECLARE_mInt32(storage_flood_stage_usage_percent); // 90%
932
// The min bytes that should be left of a data dir
933
DECLARE_mInt64(storage_flood_stage_left_capacity_bytes); // 1GB
934
// number of thread for flushing memtable per store
935
DECLARE_mInt32(flush_thread_num_per_store);
936
// number of thread for flushing memtable per store, for high priority load task
937
DECLARE_mInt32(high_priority_flush_thread_num_per_store);
938
// number of threads = min(flush_thread_num_per_store * num_store,
939
//                         max_flush_thread_num_per_cpu * num_cpu)
940
DECLARE_mInt32(max_flush_thread_num_per_cpu);
941
// minimum flush threads per cpu when adaptive flush is enabled (default 0.5)
942
DECLARE_mDouble(min_flush_thread_num_per_cpu);
943
944
// Whether to enable adaptive flush thread adjustment
945
DECLARE_mBool(enable_adaptive_flush_threads);
946
947
// Whether to block writes when one table has too many pending flush memtables on this BE.
948
DECLARE_mBool(enable_table_memtable_flush_backpressure);
949
// Max pending flush memtables for one table on this BE before blocking new writes.
950
DECLARE_mInt32(table_memtable_flush_pending_count_limit);
951
952
// config for tablet meta checkpoint
953
DECLARE_mInt32(tablet_meta_checkpoint_min_new_rowsets_num);
954
DECLARE_mInt32(tablet_meta_checkpoint_min_interval_secs);
955
DECLARE_Int32(generate_tablet_meta_checkpoint_tasks_interval_secs);
956
957
// config for default rowset type
958
// Valid configs: ALPHA, BETA
959
DECLARE_String(default_rowset_type);
960
961
// Maximum size of a single message body in all protocols
962
DECLARE_Int64(brpc_max_body_size);
963
// Max unwritten bytes in each socket, if the limit is reached, Socket.Write fails with EOVERCROWDED
964
// Default, if the physical memory is less than or equal to 64G, the value is 1G
965
//          if the physical memory is greater than 64G, the value is physical memory * mem_limit(0.8) / 1024 * 20
966
DECLARE_Int64(brpc_socket_max_unwritten_bytes);
967
// Whether to set FLAGS_usercode_in_pthread to true in brpc
968
DECLARE_mBool(brpc_usercode_in_pthread);
969
// TODO(zxy): expect to be true in v1.3
970
// Whether to embed the ProtoBuf Request serialized string together with Tuple/Block data into
971
// Controller Attachment and send it through http brpc when the length of the Tuple/Block data
972
// is greater than 1.8G. This is to avoid the error of Request length overflow (2G).
973
DECLARE_mBool(transfer_large_data_by_brpc);
974
975
// max number of txns for every txn_partition_map in txn manager
976
// this is a self protection to avoid too many txns saving in manager
977
DECLARE_mInt64(max_runnings_transactions_per_txn_map);
978
979
// tablet_map_lock shard size, the value is 2^n, n=0,1,2,3,4
980
// this is a an enhancement for better performance to manage tablet
981
DECLARE_Int32(tablet_map_shard_size);
982
983
// txn_map_lock shard size, the value is 2^n, n=0,1,2,3,4
984
// this is a an enhancement for better performance to manage txn
985
DECLARE_Int32(txn_map_shard_size);
986
987
// txn_lock shard size, the value is 2^n, n=0,1,2,3,4
988
// this is a an enhancement for better performance to commit and publish txn
989
DECLARE_Int32(txn_shard_size);
990
991
// Whether to continue to start be when load tablet from header failed.
992
DECLARE_Bool(ignore_load_tablet_failure);
993
994
// Whether to continue to start be when load tablet from header failed.
995
DECLARE_mBool(ignore_rowset_stale_unconsistent_delete);
996
997
// Set max cache's size of query results, the unit is M byte
998
DECLARE_Int32(query_cache_max_size_mb);
999
1000
// Cache memory is pruned when reach query_cache_max_size_mb + query_cache_elasticity_size_mb
1001
DECLARE_Int32(query_cache_elasticity_size_mb);
1002
1003
// Maximum number of cache partitions corresponding to a SQL
1004
DECLARE_Int32(query_cache_max_partition_count);
1005
1006
// Maximum number of version of a tablet. If the version num of a tablet exceed limit,
1007
// the load process will reject new incoming load job of this tablet.
1008
// This is to avoid too many version num.
1009
DECLARE_mInt32(max_tablet_version_num);
1010
1011
DECLARE_mInt32(time_series_max_tablet_version_num);
1012
1013
// the max sleep time when meeting high pressure load task
1014
DECLARE_mInt64(max_load_back_pressure_version_wait_time_ms);
1015
// the threshold of rowset number gap that triggers back pressure
1016
DECLARE_mInt64(load_back_pressure_version_threshold);
1017
1018
// Frontend mainly use two thrift sever type: THREAD_POOL, THREADED_SELECTOR. if fe use THREADED_SELECTOR model for thrift server,
1019
// the thrift_server_type_of_fe should be set THREADED_SELECTOR to make be thrift client to fe constructed with TFramedTransport
1020
DECLARE_String(thrift_server_type_of_fe);
1021
1022
// disable zone map index when page row is too few
1023
DECLARE_mInt32(zone_map_row_num_threshold);
1024
1025
// aws sdk log level
1026
//    Off = 0,
1027
//    Fatal = 1,
1028
//    Error = 2,
1029
//    Warn = 3,
1030
//    Info = 4,
1031
//    Debug = 5,
1032
//    Trace = 6
1033
DECLARE_Int32(aws_log_level);
1034
1035
// azure sdk log level
1036
//    Verbose = 1,
1037
//    Informational = 2,
1038
//    Warning = 3,
1039
//    Error = 4
1040
DECLARE_Int32(azure_log_level);
1041
1042
// the buffer size when read data from remote storage like s3
1043
DECLARE_mInt32(remote_storage_read_buffer_mb);
1044
1045
// The minimum length when TCMalloc Hook consumes/releases MemTracker, consume size
1046
// smaller than this value will continue to accumulate. specified as number of bytes.
1047
// Decreasing this value will increase the frequency of consume/release.
1048
// Increasing this value will cause MemTracker statistics to be inaccurate.
1049
DECLARE_mInt32(mem_tracker_consume_min_size_bytes);
1050
1051
// The version information of the tablet will be stored in the memory
1052
// in an adjacency graph data structure.
1053
// And as the new version is written and the old version is deleted,
1054
// the data structure will begin to have empty vertex with no edge associations(orphan vertex).
1055
// This config is used to control that when the proportion of orphan vertex is greater than the threshold,
1056
// the adjacency graph will be rebuilt to ensure that the data structure will not expand indefinitely.
1057
// This config usually only needs to be modified during testing.
1058
// In most cases, it does not need to be modified.
1059
DECLARE_mDouble(tablet_version_graph_orphan_vertex_ratio);
1060
1061
// share delta writers when memtable_on_sink_node = true
1062
DECLARE_Bool(share_delta_writers);
1063
// timeout for open load stream rpc in ms
1064
DECLARE_Int64(open_load_stream_timeout_ms);
1065
// enable write background when using brpc stream
1066
DECLARE_mBool(enable_brpc_stream_write_background);
1067
1068
// brpc streaming max_buf_size in bytes
1069
DECLARE_Int64(load_stream_max_buf_size);
1070
// brpc streaming messages_in_batch
1071
DECLARE_Int32(load_stream_messages_in_batch);
1072
// brpc streaming StreamWait seconds on EAGAIN
1073
DECLARE_Int32(load_stream_eagain_wait_seconds);
1074
// max tasks per flush token in load stream
1075
DECLARE_Int32(load_stream_flush_token_max_tasks);
1076
// max wait flush token time in load stream
1077
DECLARE_Int32(load_stream_max_wait_flush_token_time_ms);
1078
// number of send batch thread pool size
1079
DECLARE_Int32(send_batch_thread_pool_thread_num);
1080
// number of send batch thread pool queue size
1081
DECLARE_Int32(send_batch_thread_pool_queue_size);
1082
1083
// Limit the number of segment of a newly created rowset.
1084
// The newly created rowset may to be compacted after loading,
1085
// so if there are too many segment in a rowset, the compaction process
1086
// will run out of memory.
1087
// When doing compaction, each segment may take at least 1MB buffer.
1088
DECLARE_mInt32(max_segment_num_per_rowset);
1089
1090
// Store segment without compression if a segment is smaller than
1091
// segment_compression_threshold_kb.
1092
DECLARE_mInt32(segment_compression_threshold_kb);
1093
1094
// Time to clean up useless JDBC connection pool cache
1095
DECLARE_mInt32(jdbc_connection_pool_cache_clear_time_sec);
1096
1097
// Global bitmap cache capacity for aggregation cache, size in bytes
1098
DECLARE_Int64(delete_bitmap_agg_cache_capacity);
1099
DECLARE_String(delete_bitmap_dynamic_agg_cache_limit);
1100
DECLARE_mInt32(delete_bitmap_agg_cache_stale_sweep_time_sec);
1101
1102
// A common object cache depends on an Sharded LRU Cache.
1103
DECLARE_mInt32(common_obj_lru_cache_stale_sweep_time_sec);
1104
1105
// reference https://github.com/edenhill/librdkafka/blob/master/INTRODUCTION.md#broker-version-compatibility
1106
// If the dependent kafka broker version older than 0.10.0.0,
1107
// the value of kafka_api_version_request should be false, and the
1108
// value set by the fallback version kafka_broker_version_fallback will be used,
1109
// and the valid values are: 0.9.0.x, 0.8.x.y.
1110
DECLARE_String(kafka_api_version_request);
1111
DECLARE_String(kafka_broker_version_fallback);
1112
DECLARE_mString(kafka_debug);
1113
1114
// The number of pool siz of routine load consumer.
1115
// If you meet the error describe in https://github.com/edenhill/librdkafka/issues/3608
1116
// Change this size to 0 to fix it temporarily.
1117
DECLARE_mInt32(routine_load_consumer_pool_size);
1118
1119
// the timeout of condition variable wait in blocking_get and blocking_put
1120
DECLARE_mInt32(blocking_queue_cv_wait_timeout_ms);
1121
1122
// Used in single-stream-multi-table load. When receive a batch of messages from kafka,
1123
// if the size of batch is more than this threshold, we will request plans for all related tables.
1124
DECLARE_Int32(multi_table_batch_plan_threshold);
1125
1126
// Used in single-stream-multi-table load. When receiving a batch of messages from Kafka,
1127
// if the size of the table wait for plan is more than this threshold, we will request plans for all related tables.
1128
// The param is aimed to avoid requesting and executing too many plans at once.
1129
// Performing small batch processing on multiple tables during the loaded process can reduce the pressure of a single RPC
1130
// and improve the real-time processing of data.
1131
DECLARE_Int32(multi_table_max_wait_tables);
1132
1133
// When the timeout of a load task is less than this threshold,
1134
// Doris treats it as a high priority task.
1135
// high priority tasks use a separate thread pool for flush and do not block rpc by memory cleanup logic.
1136
// this threshold is mainly used to identify routine load tasks and should not be modified if not necessary.
1137
DECLARE_mInt32(load_task_high_priority_threshold_second);
1138
1139
// The min timeout of load rpc (add batch, close)
1140
// Because a load rpc may be blocked for a while.
1141
// Increase this config may avoid rpc timeout.
1142
DECLARE_mInt32(min_load_rpc_timeout_ms);
1143
1144
// use which protocol to access function service, candicate is baidu_std/h2:grpc
1145
DECLARE_String(function_service_protocol);
1146
1147
// use which load balancer to select server to connect
1148
DECLARE_String(rpc_load_balancer);
1149
1150
// a soft limit of string type length, the hard limit is 2GB - 4, but if too long will cause very low performance,
1151
// so we set a soft limit, default is 1MB
1152
DECLARE_mInt32(string_type_length_soft_limit_bytes);
1153
1154
// Threshold fo reading a small file into memory
1155
DECLARE_mInt32(in_memory_file_size);
1156
1157
// Max size of parquet page header in bytes
1158
DECLARE_mInt32(parquet_header_max_size_mb);
1159
// Max size of parquet file metadata in bytes
1160
DECLARE_mInt64(parquet_metadata_size_limit);
1161
// Max buffer size for parquet row group
1162
DECLARE_mInt32(parquet_rowgroup_max_buffer_mb);
1163
// Max buffer size for parquet chunk column
1164
DECLARE_mInt32(parquet_column_max_buffer_mb);
1165
// Merge small IO, the max amplified read ratio
1166
DECLARE_mDouble(max_amplified_read_ratio);
1167
// Equivalent min size of each IO that can reach the maximum storage speed limit
1168
// 1MB for oss, 8KB for hdfs
1169
DECLARE_mInt32(merged_oss_min_io_size);
1170
DECLARE_mInt32(merged_hdfs_min_io_size);
1171
1172
// OrcReader
1173
DECLARE_mInt32(orc_natural_read_size_mb);
1174
DECLARE_mInt64(big_column_size_buffer);
1175
DECLARE_mInt64(small_column_size_buffer);
1176
1177
DECLARE_mInt32(runtime_filter_sampling_frequency);
1178
DECLARE_mInt32(execution_max_rpc_timeout_sec);
1179
DECLARE_mBool(execution_ignore_eovercrowded);
1180
1181
// cooldown task configs
1182
DECLARE_Int32(cooldown_thread_num);
1183
DECLARE_mInt64(generate_cooldown_task_interval_sec);
1184
DECLARE_mInt32(remove_unused_remote_files_interval_sec); // 6h
1185
DECLARE_mInt32(confirm_unused_remote_files_interval_sec);
1186
DECLARE_Int32(cold_data_compaction_thread_num);
1187
DECLARE_mInt32(cold_data_compaction_interval_sec);
1188
DECLARE_mInt32(cold_data_compaction_score_threshold);
1189
1190
DECLARE_Int32(min_s3_file_system_thread_num);
1191
DECLARE_Int32(max_s3_file_system_thread_num);
1192
1193
// Thread pool for S3 reads in cross-CG peer winner race.
1194
// Max should match max_concurrent_peer_races so the pool never fills up under normal operation.
1195
DECLARE_Int32(min_peer_race_s3_thread_num);
1196
DECLARE_Int32(max_peer_race_s3_thread_num);
1197
1198
DECLARE_Bool(enable_time_lut);
1199
DECLARE_mBool(enable_simdjson_reader);
1200
1201
DECLARE_mBool(enable_query_like_bloom_filter);
1202
// number of s3 scanner thread pool size
1203
DECLARE_Int32(doris_remote_scanner_thread_pool_thread_num);
1204
// number of s3 scanner thread pool queue size
1205
DECLARE_Int32(doris_remote_scanner_thread_pool_queue_size);
1206
1207
// limit the queue of pending batches which will be sent by a single nodechannel
1208
DECLARE_mInt64(nodechannel_pending_queue_max_bytes);
1209
1210
// The batch size for sending data by brpc streaming client
1211
DECLARE_mInt64(brpc_streaming_client_batch_bytes);
1212
DECLARE_mInt64(block_cache_wait_timeout_ms);
1213
1214
DECLARE_Bool(enable_brpc_builtin_services);
1215
1216
DECLARE_Bool(enable_brpc_connection_check);
1217
1218
DECLARE_mInt64(brpc_connection_check_timeout_ms);
1219
1220
// Max waiting time to wait the "plan fragment start" rpc.
1221
// If timeout, the fragment will be cancelled.
1222
// This parameter is usually only used when the FE loses connection,
1223
// and the BE can automatically cancel the relevant fragment after the timeout,
1224
// so as to avoid occupying the execution thread for a long time.
1225
DECLARE_mInt32(max_fragment_start_wait_time_seconds);
1226
1227
DECLARE_Int32(fragment_mgr_cancel_worker_interval_seconds);
1228
1229
// Node role tag for backend. Mix role is the default role, and computation role have no
1230
// any tablet.
1231
DECLARE_String(be_node_role);
1232
1233
// Hide webserver page for safety.
1234
// Hide the be config page for webserver.
1235
DECLARE_Bool(hide_webserver_config_page);
1236
1237
DECLARE_Bool(enable_segcompaction);
1238
1239
// Max number of segments allowed in a single segcompaction task.
1240
DECLARE_mInt32(segcompaction_batch_size);
1241
1242
// Max row count allowed in a single source segment, bigger segments will be skipped.
1243
DECLARE_Int32(segcompaction_candidate_max_rows);
1244
1245
// Max file size allowed in a single source segment, bigger segments will be skipped.
1246
DECLARE_Int64(segcompaction_candidate_max_bytes);
1247
1248
// Max total row count allowed in a single segcompaction task.
1249
DECLARE_Int32(segcompaction_task_max_rows);
1250
1251
// Max total file size allowed in a single segcompaction task.
1252
DECLARE_Int64(segcompaction_task_max_bytes);
1253
1254
// Global segcompaction thread pool size.
1255
DECLARE_mInt32(segcompaction_num_threads);
1256
1257
// enable java udf and jdbc scannode
1258
DECLARE_Bool(enable_java_support);
1259
1260
// enable python udf
1261
DECLARE_Bool(enable_python_udf_support);
1262
// python env mode, options: conda, venv
1263
DECLARE_String(python_env_mode);
1264
// root path of conda runtime, python_env_mode should be conda
1265
DECLARE_String(python_conda_root_path);
1266
// root path of venv runtime, python_env_mode should be venv
1267
DECLARE_String(python_venv_root_path);
1268
// python interpreter paths used by venv, e.g. /usr/bin/python3.7:/usr/bin/python3.6
1269
DECLARE_String(python_venv_interpreter_paths);
1270
// max python processes in global shared pool, each version can have up to this many processes
1271
DECLARE_mInt32(max_python_process_num);
1272
// Memory limit in bytes for all Python UDF processes; warning is logged when exceeded
1273
DECLARE_mInt64(python_udf_processes_memory_limit_bytes);
1274
1275
// Set config randomly to check more issues in github workflow
1276
DECLARE_Bool(enable_fuzzy_mode);
1277
1278
DECLARE_Bool(enable_graceful_exit_check);
1279
1280
DECLARE_Bool(enable_debug_points);
1281
1282
DECLARE_Int32(pipeline_executor_size);
1283
DECLARE_Int32(blocking_pipeline_executor_size);
1284
1285
// Lance shared session and optional Foyer data-file cache.
1286
DECLARE_Int64(lance_index_cache_size_bytes);
1287
DECLARE_Int64(lance_metadata_cache_size_bytes);
1288
// Runtime BTree selection uses page metadata and preserves the explicit fragment domain.
1289
DECLARE_Bool(enable_lance_scalar_index_auto_selection);
1290
DECLARE_Bool(enable_lance_data_cache);
1291
DECLARE_String(lance_data_cache_path);
1292
DECLARE_Int64(lance_data_cache_disk_capacity_bytes);
1293
DECLARE_Int64(lance_data_cache_read_block_size_bytes);
1294
DECLARE_Int64(lance_data_cache_memory_capacity_bytes);
1295
1296
// I/O buffering budget per Lance scanner, applied when a new scanner is created.
1297
DECLARE_mInt64(lance_io_buffer_size_bytes);
1298
1299
// Read-ahead limits per Lance scanner, applied when a new scanner is created.
1300
DECLARE_mInt32(lance_batch_readahead);
1301
DECLARE_mInt32(lance_fragment_readahead);
1302
1303
// block file cache
1304
DECLARE_Bool(enable_file_cache);
1305
DECLARE_mBool(enable_file_cache_write_from_s3_file_writer);
1306
// format: [{"path":"/path/to/file_cache","total_size":21474836480,"query_limit":10737418240}]
1307
// format: [{"path":"/path/to/file_cache","total_size":21474836480,"query_limit":10737418240},{"path":"/path/to/file_cache2","total_size":21474836480,"query_limit":10737418240}]
1308
// format: [{"path":"/path/to/file_cache","total_size":21474836480,"query_limit":10737418240, "ttl_percent":50, "normal_percent":40, "disposable_percent":5, "index_percent":5}]
1309
// format: [{"path": "xxx", "total_size":53687091200, "storage": "memory"}]
1310
// Note1: storage is "disk" by default
1311
// Note2: when the storage is "memory", the path is ignored. So you can set xxx to anything you like
1312
// and doris will just reset the path to "memory" internally.
1313
// In a very wierd case when your storage is disk, and the directory, by accident, is named
1314
// "memory" for some reason, you should write the path as:
1315
//     {"path": "memory", "total_size":53687091200, "storage": "disk"}
1316
// or use the default storage value:
1317
//     {"path": "memory", "total_size":53687091200}
1318
// Both will use the directory "memory" on the disk instead of the real RAM.
1319
DECLARE_String(file_cache_path);
1320
DECLARE_Int64(file_cache_each_block_size);
1321
DECLARE_Bool(clear_file_cache);
1322
DECLARE_mBool(enable_file_cache_query_limit);
1323
DECLARE_mBool(enable_file_cache_query_limit_segment_meta);
1324
DECLARE_Int32(file_cache_enter_disk_resource_limit_mode_percent);
1325
DECLARE_Int32(file_cache_exit_disk_resource_limit_mode_percent);
1326
DECLARE_mBool(enable_evict_file_cache_in_advance);
1327
DECLARE_mInt32(file_cache_enter_need_evict_cache_in_advance_percent);
1328
DECLARE_mInt32(file_cache_exit_need_evict_cache_in_advance_percent);
1329
DECLARE_mInt32(file_cache_evict_in_advance_interval_ms);
1330
DECLARE_mInt64(file_cache_evict_in_advance_batch_bytes);
1331
DECLARE_mInt64(file_cache_evict_in_advance_recycle_keys_num_threshold);
1332
DECLARE_mBool(enable_read_cache_file_directly);
1333
DECLARE_Bool(file_cache_enable_evict_from_other_queue_by_size);
1334
// If true, evict the ttl cache using LRU when full.
1335
// Otherwise, only expiration can evict ttl and new data won't add to cache when full.
1336
DECLARE_Bool(enable_ttl_cache_evict_using_lru);
1337
DECLARE_mBool(enbale_dump_error_file);
1338
// limit the max size of error log on disk
1339
DECLARE_mInt64(file_cache_error_log_limit_bytes);
1340
DECLARE_mInt64(cache_lock_wait_long_tail_threshold_us);
1341
DECLARE_mInt64(cache_lock_held_long_tail_threshold_us);
1342
// Base compaction may retrieve and produce some less frequently accessed data,
1343
// potentially affecting the file cache hit rate.
1344
// This configuration determines whether to retain the output within the file cache.
1345
// Make your choice based on the following considerations:
1346
// If your file cache is ample enough to accommodate all the data in your database,
1347
// enable this option; otherwise, it is recommended to leave it disabled.
1348
DECLARE_mBool(enable_file_cache_keep_base_compaction_output);
1349
DECLARE_mBool(enable_file_cache_adaptive_write);
1350
DECLARE_mDouble(file_cache_keep_base_compaction_output_min_hit_ratio);
1351
DECLARE_mDouble(file_cache_meta_store_vs_file_system_diff_num_threshold);
1352
DECLARE_mDouble(file_cache_keep_schema_change_output_min_hit_ratio);
1353
DECLARE_mDouble(file_cache_leak_fs_to_meta_ratio_threshold);
1354
DECLARE_mInt64(file_cache_leak_scan_interval_seconds);
1355
DECLARE_mInt32(file_cache_leak_scan_batch_files);
1356
DECLARE_mInt32(file_cache_leak_scan_pause_ms);
1357
DECLARE_mInt64(file_cache_leak_grace_seconds);
1358
DECLARE_mInt64(file_cache_remove_block_qps_limit);
1359
DECLARE_mInt64(file_cache_background_gc_interval_ms);
1360
DECLARE_mInt64(file_cache_background_block_lru_update_interval_ms);
1361
DECLARE_mInt64(file_cache_background_block_lru_update_qps_limit);
1362
DECLARE_mInt64(file_cache_background_block_lru_update_queue_max_size);
1363
DECLARE_mBool(enable_file_cache_async_touch_on_get_or_set);
1364
DECLARE_mBool(enable_reader_dryrun_when_download_file_cache);
1365
DECLARE_mInt64(file_cache_background_monitor_interval_ms);
1366
DECLARE_mInt64(file_cache_background_ttl_gc_interval_ms);
1367
DECLARE_mInt64(file_cache_background_ttl_info_update_interval_ms);
1368
DECLARE_mInt64(file_cache_background_tablet_id_flush_interval_ms);
1369
DECLARE_mInt64(file_cache_background_ttl_gc_batch);
1370
DECLARE_Int32(file_cache_downloader_thread_num_min);
1371
DECLARE_Int32(file_cache_downloader_thread_num_max);
1372
// used to persist lru information before be reboot and load the info back
1373
DECLARE_mInt64(file_cache_background_lru_dump_interval_ms);
1374
// dump queue only if the queue update specific times through several dump intervals
1375
DECLARE_mInt64(file_cache_background_lru_dump_update_cnt_threshold);
1376
// max LRU entries to dump for each queue, 0 disables LRU log recording, dumping and restoring
1377
DECLARE_mInt64(file_cache_background_lru_dump_tail_record_num);
1378
DECLARE_mInt64(file_cache_background_lru_log_queue_max_size);
1379
DECLARE_mInt64(file_cache_background_lru_log_replay_interval_ms);
1380
DECLARE_mBool(enable_evaluate_shadow_queue_diff);
1381
1382
DECLARE_mBool(file_cache_enable_only_warm_up_idx);
1383
1384
// async file cache write
1385
DECLARE_mBool(enable_async_file_cache_write);
1386
DECLARE_mInt32(async_file_cache_write_workers_per_disk);
1387
DECLARE_mInt64(async_file_cache_write_max_pending_bytes);
1388
DECLARE_mBool(enable_async_file_cache_write_inflight_write_buffer_index);
1389
DECLARE_Int32(async_file_cache_write_inflight_write_buffer_index_shard_count);
1390
1391
// inverted index searcher cache
1392
// cache entry stay time after lookup
1393
DECLARE_mInt32(index_cache_entry_stay_time_after_lookup_s);
1394
// cache entry that have not been visited for a certain period of time can be cleaned up by GC thread
1395
DECLARE_mInt32(inverted_index_cache_stale_sweep_time_sec);
1396
// inverted index searcher cache size
1397
DECLARE_String(inverted_index_searcher_cache_limit);
1398
DECLARE_mBool(enable_write_index_searcher_cache);
1399
DECLARE_Bool(enable_inverted_index_cache_check_timestamp);
1400
DECLARE_mBool(enable_inverted_index_correct_term_write);
1401
DECLARE_Int32(inverted_index_fd_number_limit_percent); // 50%
1402
DECLARE_Int32(inverted_index_query_cache_shards);
1403
// When the candidate row bitmap of a segment scan is smaller than
1404
// num_rows * this ratio, it is pushed down into inverted index queries so
1405
// doc-list intersection and verification run only over the candidates
1406
// (see IndexQueryContext::candidate_rows). <= 0 disables the pushdown.
1407
DECLARE_mDouble(inverted_index_candidate_pushdown_ratio);
1408
double get_inverted_index_candidate_pushdown_ratio();
1409
1410
// inverted index match bitmap cache size
1411
DECLARE_String(inverted_index_query_cache_limit);
1412
1413
// Build-only CommonGrams kill switch. Logical index writers snapshot it at construction; changing
1414
// it affects only writers created after the transition and never changes query/cache semantics.
1415
// Release-calibrated query-planner coefficients. Both remain mutable for controlled recalibration.
1416
1417
// Whether LIKE/REGEXP tries to compile a constant pattern into a gram boolean query pushed down
1418
// to a gram-family inverted index (master switch). Turning it off behaves as if the index did
1419
// not exist -- it only gives up the speedup, it never changes query results.
1420
//
1421
// A pattern is compiled against the gram scheme the segment itself carries, read back from the
1422
// core metadata of the physical index the query is about to read, so the scheme can never
1423
// disagree with the one the writer used -- a policy that was dropped and recreated with different
1424
// properties does not affect segments already written.
1425
DECLARE_mBool(enable_gram_index_regexp);
1426
1427
// Gram query cost gate in basis points of segment rows. Zero disables it and 10000
1428
// or more never fires. Skipping pruning still preserves query results.
1429
DECLARE_mInt32(gram_index_max_candidate_ratio_bp);
1430
1431
// Row floor below which the candidate ratio gate above is not applied at all. A small segment's
1432
// entire gram index is a few KB and one or two requests, so giving up there saves nothing
1433
// measurable while throwing away the pruning the index really does deliver; the ratio only starts
1434
// to mean something at a size where the skipped index IO can outweigh the rows it stops
1435
// eliminating. The default is one Roaring container's worth of rows (65536). 0 applies the ratio
1436
// at every segment size.
1437
DECLARE_mInt32(gram_index_candidate_ratio_min_rows);
1438
1439
// Solve each segment's gram boundary rate from its sampled bytes to meet the coverage target.
1440
DECLARE_mBool(enable_gram_index_adaptive_density);
1441
// The promise the solve keeps, not a tuning pair: literals of at least this many bytes are
1442
// findable, for this share of the column's own windows of that length. Both are dimensionless
1443
// and the same on every dataset; what varies is the density they resolve to.
1444
DECLARE_mInt32(gram_index_min_literal_bytes);
1445
DECLARE_mInt32(gram_index_density_coverage_permille);
1446
// How much of a segment is held back to solve on. The sample is buffered rather than
1447
// tokenized, so this is a transient memory cost and a bound on how long the write path waits
1448
// before it can cut anything; the histogram behind the solve is a fixed 256 KB regardless.
1449
DECLARE_mInt64(gram_index_density_sample_bytes);
1450
1451
// condition cache limit
1452
DECLARE_Int16(condition_cache_limit);
1453
1454
// inverted index
1455
DECLARE_mDouble(inverted_index_ram_buffer_size);
1456
DECLARE_mInt32(inverted_index_max_buffered_docs);
1457
// G16-h: zstd levels for SNII dict blocks / prx windows. Default 3 (the
1458
// all-level-3 evaluation showed level 9 buys <=6.3% index size for 17-24%
1459
// import CPU; see the DEFINEs in config.cpp).
1460
DECLARE_mInt32(snii_dict_block_zstd_level);
1461
DECLARE_mInt32(snii_prx_zstd_level);
1462
// A .prx window is stored zstd-compressed only if that frame is smaller than the PFOR one by at
1463
// least this percentage; 0 picks the smaller frame. Negative (the default) lets each index choose
1464
// within a size budget. Affects segments written from now on.
1465
DECLARE_mInt32(snii_prx_zstd_min_saving_percent);
1466
// Patch C: prx zstd level for DIRECT-LOAD segments only (default 3, cheaper
1467
// import); compaction rewrites at snii_prx_zstd_level so settled segments are
1468
// unaffected. Full contract at the DEFINE in config.cpp.
1469
DECLARE_mInt32(snii_prx_zstd_level_direct_load);
1470
// A SNII batch read of at most this many physical segments (and 256 KiB) is read on the calling
1471
// thread when the index file is on the local filesystem and recent small reads were fast, i.e. hit
1472
// the page cache. 0 always fans out to the buffered-reader prefetch pool.
1473
DECLARE_mInt32(snii_inline_read_max_segments);
1474
// G16-d: target SNII dict block size in bytes; 0 = format default (64 KiB).
1475
// Bigger blocks -> better per-block zstd on the dict region, larger cold
1476
// fetch+decompress unit per dict-block miss. Write side only.
1477
DECLARE_mInt32(snii_target_dict_block_bytes);
1478
// Maximum process-memory share for SNII index builds. Above this share, writers with reclaimable posting arenas receive spill requests; zero disables the share trigger but keeps process-pressure backstops.
1479
DECLARE_mInt32(snii_index_build_max_memory_limit_percent);
1480
// Minimum reclaimable posting-arena size for a forced spill. Requests below this floor remain pending until the arena grows enough.
1481
DECLARE_mInt64(snii_forced_spill_min_arena_bytes);
1482
// Maximum active inputs per spill-run merge. Zero leaves fan-in to workspace and file-descriptor limits.
1483
DECLARE_mInt32(snii_spill_max_run_files_per_buffer);
1484
// Shared posting-workspace budget for spill, merge, and encoding.
1485
DECLARE_mInt64(snii_postings_workspace_bytes);
1486
// dict path for chinese analyzer
1487
DECLARE_String(inverted_index_dict_path);
1488
DECLARE_Int32(inverted_index_read_buffer_size);
1489
// tree depth for bkd index
1490
DECLARE_Int32(max_depth_in_bkd_tree);
1491
// index compaction
1492
DECLARE_mBool(inverted_index_compaction_enable);
1493
// Only for debug, do not use in production
1494
DECLARE_mBool(debug_inverted_index_compaction);
1495
// index by RAM directory
1496
DECLARE_mBool(inverted_index_ram_dir_enable);
1497
// wheather index by RAM directory when base compaction
1498
DECLARE_mBool(inverted_index_ram_dir_enable_when_base_compaction);
1499
// Norms cost one byte per segment row, including rows that hold no value for the field. A segment
1500
// holds one index per variant path, so writing norms for them costs rows * paths bytes. Turn this on
1501
// to leave norms out of every index on a variant path, whatever its "norms" property says; BM25
1502
// scoring (score()) on those indexes then fails.
1503
DECLARE_mBool(inverted_index_skip_norms_for_variant);
1504
// use num_broadcast_buffer blocks as buffer to do broadcast
1505
DECLARE_Int32(num_broadcast_buffer);
1506
1507
// max depth of expression tree allowed.
1508
DECLARE_Int32(max_depth_of_expr_tree);
1509
1510
// Report a tablet as bad when io errors occurs more than this value.
1511
DECLARE_mInt64(max_tablet_io_errors);
1512
1513
// Report a tablet as bad when its path not found
1514
DECLARE_Int32(tablet_path_check_interval_seconds);
1515
DECLARE_mInt32(tablet_path_check_batch_size);
1516
1517
// it must be larger than or equal to 5MB
1518
DECLARE_mInt64(s3_write_buffer_size);
1519
// Log interval when doing s3 upload task
1520
DECLARE_mInt32(s3_file_writer_log_interval_second);
1521
// the max number of cached file handle for block segemnt
1522
DECLARE_mInt64(file_cache_max_file_reader_cache_size);
1523
DECLARE_mInt64(hdfs_write_batch_buffer_size_mb);
1524
//enable shrink memory
1525
DECLARE_mBool(enable_shrink_memory);
1526
1527
// max number of segment cache
1528
DECLARE_Int32(segment_cache_capacity);
1529
DECLARE_Int32(segment_cache_fd_percentage);
1530
DECLARE_Int32(segment_cache_memory_percentage);
1531
DECLARE_Bool(enable_segment_cache_prune);
1532
1533
DECLARE_mInt32(estimated_mem_per_column_reader);
1534
1535
// enable binlog
1536
DECLARE_Bool(enable_feature_binlog);
1537
1538
// enable set in BitmapValue
1539
DECLARE_Bool(enable_set_in_bitmap_value);
1540
1541
// max number of hdfs file handle in cache
1542
DECLARE_Int64(max_hdfs_file_handle_cache_num);
1543
DECLARE_Int32(max_hdfs_file_handle_cache_time_sec);
1544
1545
// max number of meta info of external files, such as parquet footer
1546
DECLARE_Int64(max_external_file_meta_cache_num);
1547
// Apply delete pred in cumu compaction
1548
DECLARE_mBool(enable_delete_when_cumu_compaction);
1549
1550
// max_write_buffer_number for rocksdb
1551
DECLARE_Int32(rocksdb_max_write_buffer_number);
1552
1553
// Convert date 0000-00-00 to 0000-01-01. It's recommended to set to false.
1554
DECLARE_mBool(allow_zero_date);
1555
// Allow invalid decimalv2 literal for compatible with old version. Recommend set it false strongly.
1556
DECLARE_mBool(allow_invalid_decimalv2_literal);
1557
// Allow to specify kerberos credentials cache path.
1558
DECLARE_mString(kerberos_ccache_path);
1559
// set krb5.conf path, use "/etc/krb5.conf" by default
1560
DECLARE_mString(kerberos_krb5_conf_path);
1561
// the interval for renew kerberos ticket cache
1562
DECLARE_mInt32(kerberos_refresh_interval_second);
1563
1564
// JDK-8153057: avoid StackOverflowError thrown from the UncaughtExceptionHandler in thread "process reaper"
1565
DECLARE_mBool(jdk_process_reaper_use_default_stack_size);
1566
1567
DECLARE_mBool(enable_address_sanitizers_with_stack_trace);
1568
1569
// DISABLED: Don't resolve location info.
1570
// FAST: Perform CU lookup using .debug_aranges (might be incomplete).
1571
// FULL: Scan all CU in .debug_info (slow!) on .debug_aranges lookup failure.
1572
// FULL_WITH_INLINE: Scan .debug_info (super slower, use with caution) for inline functions in addition to FULL.
1573
DECLARE_mString(dwarf_location_info_mode);
1574
1575
// the ratio of _prefetch_size/_batch_size in AutoIncIDBuffer
1576
DECLARE_mInt64(auto_inc_prefetch_size_ratio);
1577
1578
// the ratio of _low_level_water_level_mark/_batch_size in AutoIncIDBuffer
1579
DECLARE_mInt64(auto_inc_low_water_level_mark_size_ratio);
1580
1581
// number of threads that fetch auto-inc ranges from FE
1582
DECLARE_mInt64(auto_inc_fetch_thread_num);
1583
// Max connection cache num for point lookup queries
1584
DECLARE_mInt64(lookup_connection_cache_capacity);
1585
// Number of reusable result blocks retained by each point lookup cache entry, in [1, 32].
1586
DECLARE_mInt32(lookup_connection_cache_block_pool_size);
1587
size_t get_lookup_connection_cache_block_pool_size();
1588
1589
// level of compression when using LZ4_HC, whose defalut value is LZ4HC_CLEVEL_DEFAULT
1590
DECLARE_mInt64(LZ4_HC_compression_level);
1591
// Threshold of a column as sparse column
1592
// Notice: TEST ONLY
1593
DECLARE_mBool(variant_use_cloud_schema_dict_cache);
1594
// Threshold to estimate a column is sparsed
1595
// Notice: TEST ONLY
1596
DECLARE_mInt64(variant_threshold_rows_to_estimate_sparse_column);
1597
// Max json key length in bytes when parsing json into variant subcolumns/jsonb.
1598
DECLARE_mInt32(variant_max_json_key_length);
1599
// Controls storage-layer parse target for plain non-doc VARIANT columns:
1600
// 0 = auto, 1 = force parse-time subcolumns, 2 = force doc-value KV staging.
1601
DECLARE_mInt32(variant_storage_parse_mode);
1602
// Enable vertical compact subcolumns of variant column
1603
DECLARE_mBool(enable_vertical_compact_variant_subcolumns);
1604
DECLARE_mBool(enable_variant_doc_sparse_write_subcolumns);
1605
// Maximum depth of nested arrays to track with NestedGroup
1606
// Reserved for future use when NestedGroup expansion moves to storage layer
1607
DECLARE_mInt32(variant_nested_group_max_depth);
1608
// When true, discard scalar data that conflicts with NestedGroup array<object>
1609
// data at the same path. This simplifies compaction by always prioritizing
1610
// nested structure over scalar. When false, report an error on conflict.
1611
DECLARE_mBool(variant_nested_group_discard_scalar_on_conflict);
1612
1613
DECLARE_mBool(enable_merge_on_write_correctness_check);
1614
// USED FOR DEBUGING
1615
// core directly if the compaction found there's duplicate key on mow table
1616
DECLARE_mBool(enable_mow_compaction_correctness_check_core);
1617
// USED FOR DEBUGING
1618
// let compaction fail if the compaction found there's duplicate key on mow table
1619
DECLARE_mBool(enable_mow_compaction_correctness_check_fail);
1620
// rowid conversion correctness check when compaction for mow table
1621
DECLARE_mBool(enable_rowid_conversion_correctness_check);
1622
// missing rows correctness check when compaction for mow table
1623
DECLARE_mBool(enable_missing_rows_correctness_check);
1624
// When the number of missing versions is more than this value, do not directly
1625
// retry the publish and handle it through async publish.
1626
DECLARE_mInt32(mow_publish_max_discontinuous_version_num);
1627
// When the size of primary keys in memory exceeds this value, finish current segment
1628
// and create a new segment, used in compaction.
1629
DECLARE_mInt64(mow_primary_key_index_max_size_in_memory);
1630
// When the version is not continuous for MOW table in publish phase and the gap between
1631
// current txn's publishing version and the max version of the tablet exceeds this value,
1632
// don't print warning log
1633
DECLARE_mInt32(publish_version_gap_logging_threshold);
1634
// get agg by cache for mow table
1635
DECLARE_mBool(enable_mow_get_agg_by_cache);
1636
// get agg correctness check for mow table
1637
DECLARE_mBool(enable_mow_get_agg_correctness_check_core);
1638
DECLARE_mBool(enable_agg_and_remove_pre_rowsets_delete_bitmap);
1639
DECLARE_mBool(enable_check_agg_and_remove_pre_rowsets_delete_bitmap);
1640
DECLARE_mBool(enable_remove_agg_pre_rowsets_delete_bitmap_by_keys);
1641
DECLARE_mBool(enable_remove_pre_rowsets_delete_bitmap_by_keys);
1642
1643
// The secure path with user files, used in the `local` table function.
1644
DECLARE_String(user_files_secure_path);
1645
1646
// If fe's frontend info has not been updated for more than fe_expire_duration_seconds, it will be regarded
1647
// as an abnormal fe, this will cause be to cancel this fe's related query.
1648
DECLARE_Int32(fe_expire_duration_seconds);
1649
1650
// If use stop_be.sh --grace, then BE has to wait all running queries to stop to avoiding running query failure
1651
// , but if the waiting time exceed the limit, then be will exit directly.
1652
// During this period, FE will not send any queries to BE and waiting for all running queries to stop.
1653
DECLARE_Int32(grace_shutdown_wait_seconds);
1654
// When using the graceful stop feature, after the main process waits for
1655
// all currently running tasks to finish, it will continue to wait for
1656
// an additional period to ensure that queries still running on other nodes have also completed.
1657
// Since a BE node cannot detect the task execution status on other BE nodes,
1658
// you may need to increase this threshold to allow for a longer waiting time.
1659
DECLARE_Int32(grace_shutdown_post_delay_seconds);
1660
1661
// BitmapValue serialize version.
1662
DECLARE_Int16(bitmap_serialize_version);
1663
1664
// group commit config
1665
DECLARE_String(group_commit_wal_path);
1666
DECLARE_Int32(group_commit_replay_wal_retry_num);
1667
DECLARE_Int32(group_commit_replay_wal_retry_interval_seconds);
1668
DECLARE_Int32(group_commit_replay_wal_retry_interval_max_seconds);
1669
DECLARE_mInt32(group_commit_relay_wal_threads);
1670
// This config can be set to limit thread number in group commit request fragment thread pool.
1671
DECLARE_mInt32(group_commit_insert_threads);
1672
DECLARE_mInt32(group_commit_memory_rows_for_max_filter_ratio);
1673
DECLARE_Bool(wait_internal_group_commit_finish);
1674
// Max size(bytes) of group commit queues, used for mem back pressure.
1675
DECLARE_mInt32(group_commit_queue_mem_limit);
1676
// Max size(bytes) or percentage(%) of wal disk usage, used for disk space back pressure, default 10% of the disk available space.
1677
// group_commit_wal_max_disk_limit=1024 or group_commit_wal_max_disk_limit=10% can be automatically identified.
1678
DECLARE_mString(group_commit_wal_max_disk_limit);
1679
DECLARE_Bool(group_commit_wait_replay_wal_finish);
1680
// Max WAL count for one table before rejecting async group commit loads. 0 means no limit.
1681
DECLARE_mInt32(group_commit_max_wal_num_per_table);
1682
// Max time(ms) to wait for creating group commit plan fragment. 0 means no timeout.
1683
DECLARE_mInt32(group_commit_create_plan_timeout_ms);
1684
1685
// The configuration item is used to lower the priority of the scanner thread,
1686
// typically employed to ensure CPU scheduling for write operations.
1687
// Default is 0, which is default value of thread nice value, increase this value
1688
// to lower the priority of scan threads
1689
DECLARE_Int32(scan_thread_nice_value);
1690
// Used to modify the recycle interval of tablet schema cache
1691
DECLARE_mInt32(tablet_schema_cache_recycle_interval);
1692
// Granularity is at the column level
1693
DECLARE_mInt32(tablet_schema_cache_capacity);
1694
1695
// Use `LOG(FATAL)` to replace `throw` when true
1696
DECLARE_mBool(exit_on_exception);
1697
1698
// cgroup
1699
DECLARE_String(doris_cgroup_cpu_path);
1700
DECLARE_mBool(enable_be_proc_monitor);
1701
DECLARE_mInt32(be_proc_monitor_interval_ms);
1702
DECLARE_Int32(workload_group_metrics_interval_ms);
1703
DECLARE_Int32(workload_policy_check_interval_ms);
1704
1705
// This config controls whether the s3 file writer would flush cache asynchronously
1706
DECLARE_Bool(enable_flush_file_cache_async);
1707
1708
// Ingest binlog work pool size
1709
DECLARE_Int32(ingest_binlog_work_pool_size);
1710
1711
// Ingest binlog with persistent connection
1712
DECLARE_Bool(enable_ingest_binlog_with_persistent_connection);
1713
1714
// Log ingest binlog elapsed threshold, -1 means no log
1715
DECLARE_mInt64(ingest_binlog_elapsed_threshold_ms);
1716
1717
// Download binlog rate limit, unit is KB/s
1718
DECLARE_Int32(download_binlog_rate_limit_kbs);
1719
1720
DECLARE_mInt32(buffered_reader_read_timeout_ms);
1721
1722
// whether to enable /api/snapshot api
1723
DECLARE_Bool(enable_snapshot_action);
1724
1725
// The max columns size for a tablet schema
1726
DECLARE_mInt32(variant_max_merged_tablet_schema_size);
1727
1728
DECLARE_mInt64(local_exchange_buffer_mem_limit);
1729
1730
DECLARE_mInt64(enable_debug_log_timeout_secs);
1731
1732
DECLARE_mBool(enable_column_type_check);
1733
1734
// Tolerance for the number of partition id 0 in rowset, default 0
1735
DECLARE_Int32(ignore_invalid_partition_id_rowset_num);
1736
1737
DECLARE_mInt32(report_query_statistics_interval_ms);
1738
DECLARE_mInt32(query_statistics_reserve_timeout_ms);
1739
DECLARE_mInt32(report_exec_status_thread_num);
1740
1741
// consider two high usage disk at the same available level if they do not exceed this diff.
1742
DECLARE_mDouble(high_disk_avail_level_diff_usages);
1743
1744
// create tablet in partition random robin idx lru size, default 10000
1745
DECLARE_Int32(partition_disk_index_lru_size);
1746
DECLARE_String(spill_storage_root_path);
1747
// Spill storage limit specified as number of bytes
1748
// ('<int>[bB]?'), megabytes ('<float>[mM]'), gigabytes ('<float>[gG]'),
1749
// or percentage of capaity ('<int>%').
1750
// Defaults to bytes if no unit is given.
1751
// Must larger than 0.
1752
// If specified as percentage, the final limit value is:
1753
//   disk_capacity_bytes * storage_flood_stage_usage_percent * spill_storage_limit
1754
DECLARE_String(spill_storage_limit);
1755
DECLARE_mInt32(spill_gc_interval_ms);
1756
DECLARE_mInt32(spill_gc_work_time_ms);
1757
// Maximum size of each spill part file before rotation (bytes). Default 1GB.
1758
DECLARE_mInt64(spill_file_part_size_bytes);
1759
DECLARE_Int64(spill_in_paused_queue_timeout_ms);
1760
DECLARE_Int64(wait_cancel_release_memory_ms);
1761
1762
DECLARE_mBool(check_segment_when_build_rowset_meta);
1763
1764
DECLARE_Int32(num_query_ctx_map_partitions);
1765
1766
DECLARE_mBool(enable_s3_rate_limiter);
1767
DECLARE_mInt64(s3_get_bucket_tokens);
1768
DECLARE_mInt64(s3_get_token_per_second);
1769
DECLARE_mInt64(s3_get_token_limit);
1770
1771
DECLARE_mInt64(s3_put_bucket_tokens);
1772
DECLARE_mInt64(s3_put_token_per_second);
1773
DECLARE_mInt64(s3_put_token_limit);
1774
DECLARE_mInt64(s3_rate_limiter_log_interval);
1775
1776
// CPU-aware S3 rate limiter: GET/PUT QPS per CPU core. A negative value means unset and
1777
// falls back to the legacy absolute token configs above; 0 disables QPS limiting.
1778
DECLARE_mInt64(s3_get_requests_per_second_per_core);
1779
DECLARE_mInt64(s3_put_requests_per_second_per_core);
1780
// Hard caps for the CPU-derived GET/PUT QPS. A non-positive value means no cap.
1781
DECLARE_mInt64(s3_get_requests_per_second_max);
1782
DECLARE_mInt64(s3_put_requests_per_second_max);
1783
// GET/PUT bytes per second per CPU core. A non-positive value disables byte-rate limiting.
1784
DECLARE_mInt64(s3_get_bytes_per_second_per_core);
1785
DECLARE_mInt64(s3_put_bytes_per_second_per_core);
1786
// Hard caps for the CPU-derived GET/PUT bytes/s. A non-positive value means no cap.
1787
DECLARE_mInt64(s3_get_bytes_per_second_max);
1788
DECLARE_mInt64(s3_put_bytes_per_second_max);
1789
// Override for cores used to derive effective limits: a non-positive value means auto-detect.
1790
DECLARE_mInt32(s3_rate_limiter_cpu_cores_override);
1791
// max s3 client retry times
1792
DECLARE_mInt32(max_s3_client_retry);
1793
// When meet s3 429 error, the "get" request will
1794
// sleep s3_read_base_wait_time_ms (*1, *2, *3, *4) ms
1795
// get try again.
1796
// The max sleep time is s3_read_max_wait_time_ms
1797
// and the max retry time is max_s3_client_retry
1798
DECLARE_mInt32(s3_read_base_wait_time_ms);
1799
DECLARE_mInt32(s3_read_max_wait_time_ms);
1800
DECLARE_mBool(enable_s3_object_check_after_upload);
1801
DECLARE_mInt32(aws_client_request_timeout_ms);
1802
1803
// write as inverted index tmp directory
1804
DECLARE_String(tmp_file_dir);
1805
1806
// the directory for storing the trino-connector plugins.
1807
DECLARE_String(trino_connector_plugin_dir);
1808
1809
// the file paths(one or more) of CA cert, splite using ";" aws s3 lib use it to init s3client
1810
DECLARE_mString(ca_cert_file_paths);
1811
1812
/** Table sink configurations(currently contains only external table types) **/
1813
// Minimum data processed to scale writers in exchange when non partition writing
1814
DECLARE_mInt64(table_sink_non_partition_write_scaling_data_processed_threshold);
1815
// Minimum data processed to trigger skewed partition rebalancing in exchange when partition writing
1816
DECLARE_mInt64(table_sink_partition_write_min_data_processed_rebalance_threshold);
1817
// Minimum partition data processed to rebalance writers in exchange when partition writing
1818
DECLARE_mInt64(table_sink_partition_write_min_partition_data_processed_rebalance_threshold);
1819
// Maximum processed partition nums of per writer when partition writing
1820
DECLARE_mInt32(table_sink_partition_write_max_partition_nums_per_writer);
1821
1822
/** Hive sink configurations **/
1823
DECLARE_mInt64(hive_sink_max_file_size);
1824
1825
/** Iceberg sink configurations **/
1826
DECLARE_mInt64(iceberg_sink_max_file_size);
1827
1828
/** Paimon sink configurations **/
1829
// Hard upper bound for Doris-managed Paimon write-buffer memory per JNI writer.
1830
DECLARE_mInt64(paimon_jni_writer_memory_pool_limit_bytes);
1831
1832
// Number of open tries, default 1 means only try to open once.
1833
// Retry the Open num_retries time waiting 100 milliseconds between retries.
1834
DECLARE_mInt32(thrift_client_open_num_tries);
1835
1836
// Default HTTP scheme used by S3Client when the endpoint has no scheme.
1837
DECLARE_String(s3_client_http_scheme);
1838
1839
DECLARE_mBool(ignore_schema_change_check);
1840
1841
/** Only use in fuzzy test **/
1842
DECLARE_mInt64(string_overflow_size);
1843
1844
// The min thread num for BufferedReaderPrefetchThreadPool
1845
DECLARE_Int64(num_buffered_reader_prefetch_thread_pool_min_thread);
1846
// The max thread num for BufferedReaderPrefetchThreadPool
1847
DECLARE_Int64(num_buffered_reader_prefetch_thread_pool_max_thread);
1848
1849
DECLARE_mBool(enable_segment_prefetch_verbose_log);
1850
// The thread num for SegmentPrefetchThreadPool
1851
DECLARE_Int64(segment_prefetch_thread_pool_thread_num_min);
1852
DECLARE_Int64(segment_prefetch_thread_pool_thread_num_max);
1853
1854
DECLARE_mInt32(segment_file_cache_consume_rowids_batch_size);
1855
// Enable segment file cache block prefetch for query
1856
DECLARE_mBool(enable_query_segment_file_cache_prefetch);
1857
// Number of blocks to prefetch ahead in segment iterator for query
1858
DECLARE_mInt32(query_segment_file_cache_prefetch_block_size);
1859
// Enable segment file cache block prefetch for compaction
1860
DECLARE_mBool(enable_compaction_segment_file_cache_prefetch);
1861
// Number of blocks to prefetch ahead in segment iterator for compaction
1862
DECLARE_mInt32(compaction_segment_file_cache_prefetch_block_size);
1863
// The min thread num for S3FileUploadThreadPool
1864
DECLARE_Int64(num_s3_file_upload_thread_pool_min_thread);
1865
// The max thread num for S3FileUploadThreadPool
1866
DECLARE_Int64(num_s3_file_upload_thread_pool_max_thread);
1867
// The maximum jvm heap usage ratio for hdfs write workload
1868
DECLARE_mDouble(max_hdfs_wirter_jni_heap_usage_ratio);
1869
// The sleep milliseconds duration when hdfs write exceeds the maximum usage
1870
DECLARE_mInt64(hdfs_jni_write_sleep_milliseconds);
1871
// The max retry times when hdfs write failed
1872
DECLARE_mInt64(hdfs_jni_write_max_retry_time);
1873
1874
// The min thread num for NonBlockCloseThreadPool
1875
DECLARE_Int64(min_nonblock_close_thread_num);
1876
// The max thread num for NonBlockCloseThreadPool
1877
DECLARE_Int64(max_nonblock_close_thread_num);
1878
// The possibility that mem allocator throws an exception during memory allocation
1879
// This config is for test usage, be careful when changing it.
1880
DECLARE_mDouble(mem_alloc_fault_probability);
1881
// The time out milliseconds for remote fetch schema RPC
1882
DECLARE_mInt64(fetch_remote_schema_rpc_timeout_ms);
1883
// The size of the local buffer for S3FileSytem's upload function
1884
1885
DECLARE_Int64(s3_file_system_local_upload_buffer_size);
1886
1887
//JVM monitoring enable. To prevent be from crashing due to jvm compatibility issues.
1888
DECLARE_Bool(enable_jvm_monitor);
1889
1890
// Num threads to load data dirs, default value -1 indicates the same number of threads as the number of data dirs
1891
DECLARE_Int32(load_data_dirs_threads);
1892
1893
// Skip loading stale rowset meta when initializing `TabletMeta` from protobuf
1894
DECLARE_mBool(skip_loading_stale_rowset_meta);
1895
// Whether to use file to record log. When starting BE with --console,
1896
// all logs will be written to both standard output and file.
1897
// Disable this option will no longer use file to record log.
1898
// Only works when starting BE with --console.
1899
DECLARE_Bool(enable_file_logger);
1900
1901
// Enable partition column fallback when partition columns are missing from file
1902
DECLARE_Bool(enable_iceberg_partition_column_fallback);
1903
1904
// The minimum row group size when exporting Parquet files.
1905
DECLARE_Int64(min_row_group_size);
1906
1907
DECLARE_mInt64(compaction_memory_bytes_limit);
1908
1909
DECLARE_mInt64(compaction_batch_size);
1910
1911
DECLARE_mBool(enable_parquet_page_index);
1912
1913
// Wheather to ignore not found file in external teble(eg, hive)
1914
// Default is true, if set to false, the not found file will result in query failure.
1915
DECLARE_mBool(ignore_not_found_file_in_external_table);
1916
1917
DECLARE_mBool(enable_hdfs_mem_limiter);
1918
1919
// Define how many percent data in hashtable bigger than limit
1920
// we should do agg limit opt
1921
DECLARE_mInt16(topn_agg_limit_multiplier);
1922
1923
DECLARE_mInt64(tablet_meta_serialize_size_limit);
1924
1925
DECLARE_mInt64(pipeline_task_leakage_detect_period_secs);
1926
// To be compatible with hadoop's block compression
1927
DECLARE_mInt32(snappy_compression_block_size);
1928
DECLARE_mInt32(lz4_compression_block_size);
1929
1930
DECLARE_mBool(enable_pipeline_task_leakage_detect);
1931
1932
DECLARE_mInt32(check_score_rounds_num);
1933
1934
// MB
1935
DECLARE_Int32(query_cache_size);
1936
DECLARE_Bool(force_regenerate_rowsetid_on_start_error);
1937
1938
// Enable validation to check the correctness of table size.
1939
DECLARE_Bool(enable_table_size_correctness_check);
1940
// Enable sleep 5s between delete cumulative compaction.
1941
DECLARE_mBool(enable_sleep_between_delete_cumu_compaction);
1942
1943
DECLARE_mInt32(compaction_num_per_round);
1944
DECLARE_mInt32(max_automatic_compaction_num_per_round);
1945
1946
DECLARE_mInt32(check_tablet_delete_bitmap_interval_seconds);
1947
DECLARE_mInt32(check_tablet_delete_bitmap_score_top_n);
1948
DECLARE_mBool(enable_check_tablet_delete_bitmap_score);
1949
DECLARE_mInt32(schema_dict_cache_capacity);
1950
1951
// whether to prune rows with delete sign = 1 in base compaction
1952
// ATTN: this config is only for test
1953
DECLARE_mBool(enable_prune_delete_sign_when_base_compaction);
1954
1955
DECLARE_mBool(enable_mow_verbose_log);
1956
1957
DECLARE_mInt32(tablet_sched_delay_time_ms);
1958
DECLARE_mInt32(load_trigger_compaction_version_percent);
1959
DECLARE_mInt64(base_compaction_interval_seconds_since_last_operation);
1960
DECLARE_mBool(enable_compaction_pause_on_high_memory);
1961
1962
DECLARE_mBool(enable_quorum_success_write);
1963
DECLARE_mDouble(quorum_success_max_wait_multiplier);
1964
DECLARE_mInt64(quorum_success_min_wait_seconds);
1965
DECLARE_mInt32(quorum_success_remaining_timeout_seconds);
1966
1967
DECLARE_mBool(enable_calc_delete_bitmap_between_segments_concurrently);
1968
1969
DECLARE_mBool(enable_update_delete_bitmap_kv_check_core);
1970
1971
DECLARE_mBool(enable_fetch_rowsets_from_peer_replicas);
1972
// the max length of segments key bounds, in bytes
1973
// ATTENTION: as long as this conf has ever been enabled, cluster downgrade and backup recovery will no longer be supported.
1974
DECLARE_mInt32(segments_key_bounds_truncation_threshold);
1975
// ATTENTION: for test only, use random segments key bounds truncation threshold every time
1976
DECLARE_mBool(random_segments_key_bounds_truncation);
1977
1978
// If true, non-MOW rowsets store a single aggregated [rowset_min, rowset_max]
1979
// key-bounds entry instead of per-segment bounds, to reduce meta size on cloud FDB.
1980
DECLARE_mBool(enable_aggregate_non_mow_key_bounds);
1981
1982
DECLARE_mBool(enable_auto_clone_on_compaction_missing_version);
1983
1984
DECLARE_mBool(enable_auto_clone_on_mow_publish_missing_version);
1985
1986
// p0, daily, rqg, external
1987
DECLARE_String(fuzzy_test_type);
1988
1989
// The maximum csv line reader output buffer size
1990
DECLARE_mInt64(max_csv_line_reader_output_buffer_size);
1991
1992
// Maximum number of OpenMP threads available for concurrent index builds.
1993
// -1 means auto: use 80% of detected CPU cores.
1994
DECLARE_Int32(omp_threads_limit);
1995
// The capacity of segment partial column cache, used to cache column readers for each segment.
1996
DECLARE_mInt32(max_segment_partial_column_cache_size);
1997
// Cache for ANN index IVF on-disk list data.
1998
// Default "70%" means 70% of total physical memory.
1999
DECLARE_String(ann_index_ivf_list_cache_limit);
2000
// Stale sweep time for ANN index IVF list cache in seconds.
2001
DECLARE_mInt32(ann_index_ivf_list_cache_stale_sweep_time_sec);
2002
// Minimum segment rows required to persist an ANN index.
2003
DECLARE_mInt64(ann_index_build_min_segment_rows);
2004
2005
DECLARE_mBool(enable_prefill_output_dbm_agg_cache_after_compaction);
2006
DECLARE_mBool(enable_prefill_all_dbm_agg_cache_after_compaction);
2007
2008
DECLARE_mBool(enable_wal_tde);
2009
2010
DECLARE_mBool(print_stack_when_cache_miss);
2011
2012
DECLARE_mBool(read_cluster_cache_opt_verbose_log);
2013
2014
DECLARE_mString(aws_credentials_provider_version);
2015
2016
// Concurrency stats dump configuration
2017
DECLARE_mBool(enable_concurrency_stats_dump);
2018
DECLARE_mInt32(concurrency_stats_dump_interval_ms);
2019
2020
DECLARE_mBool(cloud_mow_sync_rowsets_when_load_txn_begin);
2021
2022
DECLARE_mBool(enable_cloud_make_rs_visible_on_be);
2023
DECLARE_mInt32(file_handles_deplenish_frequency_times);
2024
2025
#ifdef BE_TEST
2026
// test s3
2027
DECLARE_String(test_s3_resource);
2028
DECLARE_String(test_s3_ak);
2029
DECLARE_String(test_s3_sk);
2030
DECLARE_String(test_s3_endpoint);
2031
DECLARE_String(test_s3_region);
2032
DECLARE_String(test_s3_bucket);
2033
DECLARE_String(test_s3_prefix);
2034
#endif
2035
2036
class Register {
2037
public:
2038
    struct Field {
2039
        const char* type = nullptr;
2040
        const char* name = nullptr;
2041
        void* storage = nullptr;
2042
        const char* defval = nullptr;
2043
        bool valmutable = false;
2044
        Field(const char* ftype, const char* fname, void* fstorage, const char* fdefval,
2045
              bool fvalmutable)
2046
8.34k
                : type(ftype),
2047
8.34k
                  name(fname),
2048
8.34k
                  storage(fstorage),
2049
8.34k
                  defval(fdefval),
2050
8.34k
                  valmutable(fvalmutable) {}
2051
    };
2052
2053
public:
2054
    static std::map<std::string, Field>* _s_field_map;
2055
2056
public:
2057
    Register(const char* ftype, const char* fname, void* fstorage, const char* fdefval,
2058
8.33k
             bool fvalmutable) {
2059
8.33k
        if (_s_field_map == nullptr) {
2060
9
            _s_field_map = new std::map<std::string, Field>();
2061
9
        }
2062
8.33k
        Field field(ftype, fname, fstorage, fdefval, fvalmutable);
2063
8.33k
        _s_field_map->insert(std::make_pair(std::string(fname), field));
2064
8.33k
    }
2065
};
2066
2067
// RegisterConfValidator class is used to store validator function of registered config fields in
2068
// Register::_s_field_map.
2069
// If any validator return false when BE bootstart, the bootstart will be terminated.
2070
// If validator return false when use http API to update some config, the config will not
2071
// be modified and the API will return failure.
2072
class RegisterConfValidator {
2073
public:
2074
    // Validator for each config name.
2075
    static std::map<std::string, std::function<bool()>>* _s_field_validator;
2076
2077
public:
2078
343
    RegisterConfValidator(const char* fname, const std::function<bool()>& validator) {
2079
343
        if (_s_field_validator == nullptr) {
2080
9
            _s_field_validator = new std::map<std::string, std::function<bool()>>();
2081
9
        }
2082
        // register validator to _s_field_validator
2083
343
        _s_field_validator->insert(std::make_pair(std::string(fname), validator));
2084
343
    }
2085
};
2086
2087
// RegisterConfUpdateCallback class is used to store callback functions that will be called
2088
// when a config field is updated at runtime.
2089
// The callback function takes two void pointers: old_value and new_value.
2090
// The actual type casting is done in the DEFINE_ON_UPDATE macro.
2091
class RegisterConfUpdateCallback {
2092
public:
2093
    using CallbackFunc = std::function<void(const void* old_ptr, const void* new_ptr)>;
2094
    // Callback map for each config name.
2095
    static std::map<std::string, CallbackFunc>* _s_field_update_callback;
2096
2097
public:
2098
310
    RegisterConfUpdateCallback(const char* fname, const CallbackFunc& callback) {
2099
310
        if (_s_field_update_callback == nullptr) {
2100
9
            _s_field_update_callback = new std::map<std::string, CallbackFunc>();
2101
9
        }
2102
        // register callback to _s_field_update_callback
2103
310
        _s_field_update_callback->insert(std::make_pair(std::string(fname), callback));
2104
310
    }
2105
};
2106
2107
// configuration properties load from config file.
2108
class Properties {
2109
public:
2110
    // load conf from file, if must_exist is true and file does not exist, return false
2111
    bool load(const char* conf_file, bool must_exist = true);
2112
2113
    // Find the config value by key from `file_conf_map`.
2114
    // If found, set `retval` to the config value,
2115
    // or set `retval` to `defstr`
2116
    // if retval is not set(in case defstr is nullptr), set is_retval_set to false
2117
    template <typename T>
2118
    bool get_or_default(const char* key, const char* defstr, T& retval, bool* is_retval_set,
2119
                        std::string& rawval) const;
2120
2121
    void set(const std::string& key, const std::string& val);
2122
2123
    void set_force(const std::string& key, const std::string& val);
2124
2125
    // dump props to conf file
2126
    Status dump(const std::string& conffile);
2127
2128
private:
2129
    std::map<std::string, std::string> file_conf_map;
2130
};
2131
2132
// full configurations.
2133
extern std::map<std::string, std::string>* full_conf_map;
2134
2135
extern std::mutex custom_conf_lock;
2136
2137
// Init the config from `conf_file`.
2138
// If fill_conf_map is true, the updated config will also update the `full_conf_map`.
2139
// If must_exist is true and `conf_file` does not exist, this function will return false.
2140
// If set_to_default is true, the config value will be set to default value if not found in `conf_file`.
2141
bool init(const char* conf_file, bool fill_conf_map = false, bool must_exist = true,
2142
          bool set_to_default = true);
2143
2144
Status set_config(const std::string& field, const std::string& value, bool need_persist = false,
2145
                  bool force = false);
2146
2147
Status persist_config(const std::string& field, const std::string& value);
2148
2149
std::mutex* get_mutable_string_config_lock();
2150
2151
std::vector<std::vector<std::string>> get_config_info();
2152
2153
Status set_fuzzy_configs();
2154
2155
void update_config(const std::string& field, const std::string& value);
2156
2157
} // namespace config
2158
} // namespace doris