Coverage Report

Created: 2026-10-04 16:21

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