Coverage Report

Created: 2026-06-02 17:50

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
69.1k
#define OUT_BUF_SIZE 1024
31
32
/*
33
 * JsonbToJson converts an JsonbValue object to a JSON string.
34
 */
35
class JsonbToJson {
36
public:
37
69.1k
    JsonbToJson() : os_(buffer_, OUT_BUF_SIZE) {}
38
39
    // get json string
40
52.3k
    std::string to_json_string(const char* data, size_t size) {
41
52.3k
        const JsonbDocument* pdoc;
42
52.3k
        THROW_IF_ERROR(doris::JsonbDocument::checkAndCreateDocument(data, size, &pdoc));
43
52.3k
        return to_json_string(pdoc->getValue());
44
52.3k
    }
45
46
69.1k
    std::string to_json_string(const JsonbValue* val) {
47
69.1k
        os_.clear();
48
69.1k
        os_.seekp(0);
49
50
69.1k
        if (val) {
51
69.1k
            intern_json(val);
52
69.1k
        }
53
54
69.1k
        os_.put(0);
55
56
69.1k
        std::string json_string {os_.getBuffer()};
57
69.1k
        return json_string;
58
69.1k
    }
59
60
52.3k
    static std::string jsonb_to_json_string(const char* data, size_t size) {
61
52.3k
        JsonbToJson jsonb_to_json;
62
52.3k
        return jsonb_to_json.to_json_string(data, size);
63
52.3k
    }
64
65
private:
66
    // recursively convert JsonbValue
67
409k
    void intern_json(const JsonbValue* val) {
68
409k
        switch (val->type) {
69
474
        case JsonbType::T_Null: {
70
474
            os_.write("null", 4);
71
474
            break;
72
0
        }
73
26.0k
        case JsonbType::T_True: {
74
26.0k
            os_.write("true", 4);
75
26.0k
            break;
76
0
        }
77
5.51k
        case JsonbType::T_False: {
78
5.51k
            os_.write("false", 5);
79
5.51k
            break;
80
0
        }
81
8.80k
        case JsonbType::T_Int8: {
82
8.80k
            os_.write(val->unpack<JsonbInt8Val>()->val());
83
8.80k
            break;
84
0
        }
85
24.6k
        case JsonbType::T_Int16: {
86
24.6k
            os_.write(val->unpack<JsonbInt16Val>()->val());
87
24.6k
            break;
88
0
        }
89
86
        case JsonbType::T_Int32: {
90
86
            os_.write(val->unpack<JsonbInt32Val>()->val());
91
86
            break;
92
0
        }
93
16.8k
        case JsonbType::T_Int64: {
94
16.8k
            os_.write(val->unpack<JsonbInt64Val>()->val());
95
16.8k
            break;
96
0
        }
97
164
        case JsonbType::T_Double: {
98
164
            os_.write(val->unpack<JsonbDoubleVal>()->val());
99
164
            break;
100
0
        }
101
2
        case JsonbType::T_Float: {
102
2
            os_.write(val->unpack<JsonbFloatVal>()->val());
103
2
            break;
104
0
        }
105
3
        case JsonbType::T_Int128: {
106
3
            os_.write(val->unpack<JsonbInt128Val>()->val());
107
3
            break;
108
0
        }
109
208k
        case JsonbType::T_String: {
110
208k
            string_to_json(val->unpack<JsonbStringVal>()->getBlob(),
111
208k
                           val->unpack<JsonbStringVal>()->length());
112
208k
            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
90.4k
        case JsonbType::T_Object: {
122
90.4k
            object_to_json(val->unpack<ObjectVal>());
123
90.4k
            break;
124
0
        }
125
27.8k
        case JsonbType::T_Array: {
126
27.8k
            array_to_json(val->unpack<ArrayVal>());
127
27.8k
            break;
128
0
        }
129
1
        case JsonbType::T_Decimal32: {
130
1
            const auto* decimal_val = val->unpack<JsonbDecimal32>();
131
1
            decimal_to_json(Decimal32 {decimal_val->val()}, decimal_val->precision,
132
1
                            decimal_val->scale);
133
1
            break;
134
0
        }
135
1
        case JsonbType::T_Decimal64: {
136
1
            const auto* decimal_val = val->unpack<JsonbDecimal64>();
137
1
            decimal_to_json(Decimal64 {decimal_val->val()}, decimal_val->precision,
138
1
                            decimal_val->scale);
139
1
            break;
140
0
        }
141
2
        case JsonbType::T_Decimal128: {
142
2
            const auto* decimal_val = val->unpack<JsonbDecimal128>();
143
2
            decimal_to_json(Decimal128V3 {decimal_val->val()}, decimal_val->precision,
144
2
                            decimal_val->scale);
145
2
            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
409k
        }
156
409k
    }
157
158
496k
    void string_to_json(const char* str, size_t len) {
159
496k
        os_.put('"');
160
496k
        if (nullptr == str) {
161
1
            os_.put('"');
162
1
            return;
163
1
        }
164
496k
        char char_buffer[16];
165
11.8M
        for (const char* ptr = str; ptr != str + len && *ptr; ++ptr) {
166
11.3M
            if ((unsigned char)*ptr > 31 && *ptr != '\"' && *ptr != '\\') {
167
11.2M
                os_.put(*ptr);
168
11.2M
            } else {
169
33.8k
                os_.put('\\');
170
33.8k
                unsigned char token;
171
33.8k
                switch (token = *ptr) {
172
92
                case '\\':
173
92
                    os_.put('\\');
174
92
                    break;
175
3.27k
                case '\"':
176
3.27k
                    os_.put('\"');
177
3.27k
                    break;
178
1
                case '\b':
179
1
                    os_.put('b');
180
1
                    break;
181
1
                case '\f':
182
1
                    os_.put('f');
183
1
                    break;
184
27.4k
                case '\n':
185
27.4k
                    os_.put('n');
186
27.4k
                    break;
187
193
                case '\r':
188
193
                    os_.put('r');
189
193
                    break;
190
516
                case '\t':
191
516
                    os_.put('t');
192
516
                    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
33.8k
                }
199
33.8k
            }
200
11.3M
        }
201
494k
        os_.put('"');
202
494k
    }
203
204
    // convert object
205
90.4k
    void object_to_json(const ObjectVal* val) {
206
90.4k
        os_.put('{');
207
208
90.4k
        auto iter = val->begin();
209
90.4k
        auto iter_fence = val->end();
210
211
378k
        while (iter < iter_fence) {
212
            // write key
213
288k
            if (iter->klen()) {
214
288k
                string_to_json(iter->getKeyStr(), iter->klen());
215
288k
            } else {
216
                // NOTE: we use sMaxKeyId to represent an empty key. see jsonb_writer.h
217
5
                if (iter->getKeyId() == JsonbKeyValue::sMaxKeyId) {
218
1
                    string_to_json(nullptr, 0);
219
4
                } else {
220
4
                    os_.write(iter->getKeyId());
221
4
                }
222
5
            }
223
288k
            os_.put(':');
224
225
            // convert value
226
288k
            intern_json(iter->value());
227
228
288k
            ++iter;
229
288k
            if (iter != iter_fence) {
230
197k
                os_.put(',');
231
197k
            }
232
288k
        }
233
234
90.4k
        assert(iter == iter_fence);
235
236
90.4k
        os_.put('}');
237
90.4k
    }
238
239
    // convert array to json
240
27.8k
    void array_to_json(const ArrayVal* val) {
241
27.8k
        os_.put('[');
242
243
27.8k
        auto iter = val->begin();
244
27.8k
        auto iter_fence = val->end();
245
246
80.2k
        while (iter != iter_fence) {
247
            // convert value
248
52.3k
            intern_json((const JsonbValue*)iter);
249
52.3k
            ++iter;
250
52.3k
            if (iter != iter_fence) {
251
24.5k
                os_.put(',');
252
24.5k
            }
253
52.3k
        }
254
255
27.8k
        assert(iter == iter_fence);
256
257
27.8k
        os_.put(']');
258
27.8k
    }
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