Coverage Report

Created: 2026-09-14 17:23

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/util/jsonb_utils.h
Line
Count
Source
1
/*
2
 *  Copyright (c) 2014, Facebook, Inc.
3
 *  All rights reserved.
4
 *
5
 *  This source code is licensed under the BSD-style license found in the
6
 *  LICENSE file in the root directory of this source tree. An additional grant
7
 *  of patent rights can be found in the PATENTS file in the same directory.
8
 *
9
 */
10
11
/*
12
 * This header file defines miscellaneous utility classes.
13
 *
14
 * @author Tian Xia <tianx@fb.com>
15
 *
16
 *  this file is copied from 
17
 * https://github.com/facebook/mysql-5.6/blob/fb-mysql-5.6.35/fbson/FbsonUtil.h
18
 * and modified by Doris
19
 */
20
21
#ifndef JSONB_JSONBUTIL_H
22
#define JSONB_JSONBUTIL_H
23
24
#include "common/status.h"
25
#include "util/jsonb_document.h"
26
#include "util/jsonb_stream.h"
27
28
namespace doris {
29
30
39.3k
#define OUT_BUF_SIZE 1024
31
32
/*
33
 * JsonbToJson converts an JsonbValue object to a JSON string.
34
 */
35
class JsonbToJson {
36
public:
37
39.3k
    JsonbToJson() : os_(buffer_, OUT_BUF_SIZE) {}
38
39
    // get json string
40
37.8k
    std::string to_json_string(const char* data, size_t size) {
41
37.8k
        const JsonbDocument* pdoc;
42
37.8k
        THROW_IF_ERROR(doris::JsonbDocument::checkAndCreateDocument(data, size, &pdoc));
43
37.8k
        return to_json_string(pdoc->getValue());
44
37.8k
    }
45
46
39.3k
    std::string to_json_string(const JsonbValue* val) {
47
39.3k
        os_.clear();
48
39.3k
        os_.seekp(0);
49
50
39.3k
        if (val) {
51
39.3k
            intern_json(val);
52
39.3k
        }
53
54
39.3k
        os_.put(0);
55
56
39.3k
        std::string json_string {os_.getBuffer()};
57
39.3k
        return json_string;
58
39.3k
    }
59
60
37.7k
    static std::string jsonb_to_json_string(const char* data, size_t size) {
61
37.7k
        JsonbToJson jsonb_to_json;
62
37.7k
        return jsonb_to_json.to_json_string(data, size);
63
37.7k
    }
64
65
private:
66
    // recursively convert JsonbValue
67
111k
    void intern_json(const JsonbValue* val) {
68
111k
        switch (val->type) {
69
3.21k
        case JsonbType::T_Null: {
70
3.21k
            os_.write("null", 4);
71
3.21k
            break;
72
0
        }
73
3.20k
        case JsonbType::T_True: {
74
3.20k
            os_.write("true", 4);
75
3.20k
            break;
76
0
        }
77
3.06k
        case JsonbType::T_False: {
78
3.06k
            os_.write("false", 5);
79
3.06k
            break;
80
0
        }
81
12.6k
        case JsonbType::T_Int8: {
82
12.6k
            os_.write(val->unpack<JsonbInt8Val>()->val());
83
12.6k
            break;
84
0
        }
85
13.0k
        case JsonbType::T_Int16: {
86
13.0k
            os_.write(val->unpack<JsonbInt16Val>()->val());
87
13.0k
            break;
88
0
        }
89
1.96k
        case JsonbType::T_Int32: {
90
1.96k
            os_.write(val->unpack<JsonbInt32Val>()->val());
91
1.96k
            break;
92
0
        }
93
2.58k
        case JsonbType::T_Int64: {
94
2.58k
            os_.write(val->unpack<JsonbInt64Val>()->val());
95
2.58k
            break;
96
0
        }
97
6.74k
        case JsonbType::T_Double: {
98
6.74k
            os_.write(val->unpack<JsonbDoubleVal>()->val());
99
6.74k
            break;
100
0
        }
101
2
        case JsonbType::T_Float: {
102
2
            os_.write(val->unpack<JsonbFloatVal>()->val());
103
2
            break;
104
0
        }
105
2.07k
        case JsonbType::T_Int128: {
106
2.07k
            os_.write(val->unpack<JsonbInt128Val>()->val());
107
2.07k
            break;
108
0
        }
109
31.4k
        case JsonbType::T_String: {
110
31.4k
            string_to_json(val->unpack<JsonbStringVal>()->getBlob(),
111
31.4k
                           val->unpack<JsonbStringVal>()->length());
112
31.4k
            break;
113
0
        }
114
0
        case JsonbType::T_Binary: {
115
0
            os_.write("\"<BINARY>", 9);
116
0
            os_.write(val->unpack<JsonbBinaryVal>()->getBlob(),
117
0
                      val->unpack<JsonbBinaryVal>()->getBlobLen());
118
0
            os_.write("<BINARY>\"", 9);
119
0
            break;
120
0
        }
121
19.3k
        case JsonbType::T_Object: {
122
19.3k
            object_to_json(val->unpack<ObjectVal>());
123
19.3k
            break;
124
0
        }
125
11.6k
        case JsonbType::T_Array: {
126
11.6k
            array_to_json(val->unpack<ArrayVal>());
127
11.6k
            break;
128
0
        }
129
30
        case JsonbType::T_Decimal32: {
130
30
            const auto* decimal_val = val->unpack<JsonbDecimal32>();
131
30
            decimal_to_json(Decimal32 {decimal_val->val()}, decimal_val->precision,
132
30
                            decimal_val->scale);
133
30
            break;
134
0
        }
135
31
        case JsonbType::T_Decimal64: {
136
31
            const auto* decimal_val = val->unpack<JsonbDecimal64>();
137
31
            decimal_to_json(Decimal64 {decimal_val->val()}, decimal_val->precision,
138
31
                            decimal_val->scale);
139
31
            break;
140
0
        }
141
40
        case JsonbType::T_Decimal128: {
142
40
            const auto* decimal_val = val->unpack<JsonbDecimal128>();
143
40
            decimal_to_json(Decimal128V3 {decimal_val->val()}, decimal_val->precision,
144
40
                            decimal_val->scale);
145
40
            break;
146
0
        }
147
1
        case JsonbType::T_Decimal256: {
148
1
            const auto* decimal_val = val->unpack<JsonbDecimal256>();
149
1
            decimal_to_json(Decimal256 {decimal_val->val()}, decimal_val->precision,
150
1
                            decimal_val->scale);
151
1
            break;
152
0
        }
153
0
        default:
154
0
            break;
155
111k
        }
156
111k
    }
157
158
69.6k
    void string_to_json(const char* str, size_t len) {
159
69.6k
        os_.put('"');
160
69.6k
        if (nullptr == str) {
161
2.20k
            os_.put('"');
162
2.20k
            return;
163
2.20k
        }
164
67.4k
        char char_buffer[16];
165
6.55M
        for (const char* ptr = str; ptr != str + len && *ptr; ++ptr) {
166
6.48M
            if ((unsigned char)*ptr > 31 && *ptr != '\"' && *ptr != '\\') {
167
6.48M
                os_.put(*ptr);
168
6.48M
            } else {
169
139
                os_.put('\\');
170
139
                unsigned char token;
171
139
                switch (token = *ptr) {
172
16
                case '\\':
173
16
                    os_.put('\\');
174
16
                    break;
175
106
                case '\"':
176
106
                    os_.put('\"');
177
106
                    break;
178
3
                case '\b':
179
3
                    os_.put('b');
180
3
                    break;
181
3
                case '\f':
182
3
                    os_.put('f');
183
3
                    break;
184
7
                case '\n':
185
7
                    os_.put('n');
186
7
                    break;
187
5
                case '\r':
188
5
                    os_.put('r');
189
5
                    break;
190
1
                case '\t':
191
1
                    os_.put('t');
192
1
                    break;
193
0
                default: {
194
0
                    int char_num = snprintf(char_buffer, sizeof(char_buffer), "u%04x", token);
195
0
                    os_.write(char_buffer, char_num);
196
0
                    break;
197
0
                }
198
139
                }
199
139
            }
200
6.48M
        }
201
67.4k
        os_.put('"');
202
67.4k
    }
203
204
    // convert object
205
19.3k
    void object_to_json(const ObjectVal* val) {
206
19.3k
        os_.put('{');
207
208
19.3k
        auto iter = val->begin();
209
19.3k
        auto iter_fence = val->end();
210
211
57.5k
        while (iter < iter_fence) {
212
            // write key
213
38.1k
            if (iter->klen()) {
214
35.9k
                string_to_json(iter->getKeyStr(), iter->klen());
215
35.9k
            } else {
216
                // NOTE: we use sMaxKeyId to represent an empty key. see jsonb_writer.h
217
2.20k
                if (iter->getKeyId() == JsonbKeyValue::sMaxKeyId) {
218
2.20k
                    string_to_json(nullptr, 0);
219
2.20k
                } else {
220
1
                    os_.write(iter->getKeyId());
221
1
                }
222
2.20k
            }
223
38.1k
            os_.put(':');
224
225
            // convert value
226
38.1k
            intern_json(iter->value());
227
228
38.1k
            ++iter;
229
38.1k
            if (iter != iter_fence) {
230
20.4k
                os_.put(',');
231
20.4k
            }
232
38.1k
        }
233
234
19.3k
        assert(iter == iter_fence);
235
236
19.3k
        os_.put('}');
237
19.3k
    }
238
239
    // convert array to json
240
11.6k
    void array_to_json(const ArrayVal* val) {
241
11.6k
        os_.put('[');
242
243
11.6k
        auto iter = val->begin();
244
11.6k
        auto iter_fence = val->end();
245
246
45.2k
        while (iter != iter_fence) {
247
            // convert value
248
33.5k
            intern_json((const JsonbValue*)iter);
249
33.5k
            ++iter;
250
33.5k
            if (iter != iter_fence) {
251
23.3k
                os_.put(',');
252
23.3k
            }
253
33.5k
        }
254
255
11.6k
        assert(iter == iter_fence);
256
257
11.6k
        os_.put(']');
258
11.6k
    }
259
260
    template <JsonbDecimalType T>
261
    void decimal_to_json(const T& value, const uint32_t precision, const uint32_t scale);
262
263
    JsonbOutStream os_;
264
    char buffer_[OUT_BUF_SIZE];
265
};
266
267
} // namespace doris
268
269
#endif // JSONB_JSONBUTIL_H