risingwave_expr_impl/scalar/
jsonb_object.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use jsonbb::Builder;
16use risingwave_common::types::{JsonbVal, ListRef};
17use risingwave_common::util::iter_util::ZipEqFast;
18use risingwave_expr::{ExprError, Result, function};
19
20/// Builds a JSON object out of a text array.
21///
22/// The array must have either exactly one dimension with an even number of members,
23/// in which case they are taken as alternating key/value pairs, or two dimensions
24/// such that each inner array has exactly two elements, which are taken as a key/value pair.
25/// All values are converted to JSON strings.
26///
27/// # Examples
28///
29/// ```slt
30/// query T
31/// select jsonb_object('{a, 1, b, def, c, 3.5}' :: text[]);
32/// ----
33/// {"a": "1", "b": "def", "c": "3.5"}
34///
35/// query error array must have even number of elements
36/// select jsonb_object('{a, 1, b, "def", c}' :: text[]);
37///
38/// query error null value not allowed for object key
39/// select jsonb_object(array[null, 'b']);
40///
41/// query T
42/// select jsonb_object(array['a', null]);
43/// ----
44/// {"a": null}
45/// ```
46#[function("jsonb_object(varchar[]) -> jsonb")]
47fn jsonb_object_1d(array: ListRef<'_>) -> Result<JsonbVal> {
48    if array.len() % 2 == 1 {
49        return Err(ExprError::InvalidParam {
50            name: "array",
51            reason: "array must have even number of elements".into(),
52        });
53    }
54    let mut builder = Builder::<Vec<u8>>::new();
55    builder.begin_object();
56    for [key, value] in array.iter().array_chunks() {
57        match key {
58            Some(s) => builder.add_string(s.into_utf8()),
59            None => {
60                return Err(ExprError::InvalidParam {
61                    name: "array",
62                    reason: "null value not allowed for object key".into(),
63                });
64            }
65        }
66        match value {
67            Some(s) => builder.add_string(s.into_utf8()),
68            None => builder.add_null(),
69        }
70    }
71    builder.end_object();
72    Ok(builder.finish().into())
73}
74
75/// Builds a JSON object out of a text array.
76///
77/// The array must have either exactly one dimension with an even number of members,
78/// in which case they are taken as alternating key/value pairs, or two dimensions
79/// such that each inner array has exactly two elements, which are taken as a key/value pair.
80/// All values are converted to JSON strings.
81///
82/// # Examples
83///
84/// ```slt
85/// query T
86/// select jsonb_object('{{a, 1}, {b, def}, {c, 3.5}}' :: text[][]);
87/// ----
88/// {"a": "1", "b": "def", "c": "3.5"}
89///
90/// # FIXME: `null` should be parsed as a null value instead of a "null" string.
91/// # query error null value not allowed for object key
92/// # select jsonb_object('{{a, 1}, {null, "def"}, {c, 3.5}}' :: text[][]);
93///
94/// query error array must have two columns
95/// select jsonb_object('{{a, 1, 2}, {b, "def"}, {c, 3.5}}' :: text[][]);
96/// ```
97#[function("jsonb_object(varchar[][]) -> jsonb")]
98fn jsonb_object_2d(array: ListRef<'_>) -> Result<JsonbVal> {
99    let mut builder = Builder::<Vec<u8>>::new();
100    builder.begin_object();
101    for kv in array.iter() {
102        let Some(kv) = kv else {
103            return Err(ExprError::InvalidParam {
104                name: "array",
105                reason: "Unexpected array element.".into(),
106            });
107        };
108        let kv = kv.into_list();
109        if kv.len() != 2 {
110            return Err(ExprError::InvalidParam {
111                name: "array",
112                reason: "array must have two columns".into(),
113            });
114        }
115        match kv.get(0).unwrap() {
116            Some(s) => builder.add_string(s.into_utf8()),
117            None => {
118                return Err(ExprError::InvalidParam {
119                    name: "array",
120                    reason: "null value not allowed for object key".into(),
121                });
122            }
123        }
124        match kv.get(1).unwrap() {
125            Some(s) => builder.add_string(s.into_utf8()),
126            None => builder.add_null(),
127        }
128    }
129    builder.end_object();
130    Ok(builder.finish().into())
131}
132
133/// This form of `jsonb_object` takes keys and values pairwise from separate text arrays.
134/// Otherwise it is identical to the one-argument form.
135///
136/// # Examples
137///
138/// ```slt
139/// query T
140/// select jsonb_object('{a,b}', '{1,2}');
141/// ----
142/// {"a": "1", "b": "2"}
143///
144/// query error mismatched array dimensions
145/// select jsonb_object('{a,b}', '{1,2,3}');
146///
147/// # FIXME: `null` should be parsed as a null value instead of a "null" string.
148/// # query error null value not allowed for object key
149/// # select jsonb_object('{a,null}', '{1,2}');
150/// ```
151#[function("jsonb_object(varchar[], varchar[]) -> jsonb")]
152fn jsonb_object_kv(keys: ListRef<'_>, values: ListRef<'_>) -> Result<JsonbVal> {
153    if keys.len() != values.len() {
154        return Err(ExprError::InvalidParam {
155            name: "values",
156            reason: "mismatched array dimensions".into(),
157        });
158    }
159    let mut builder = Builder::<Vec<u8>>::new();
160    builder.begin_object();
161    for (key, value) in keys.iter().zip_eq_fast(values.iter()) {
162        match key {
163            Some(s) => builder.add_string(s.into_utf8()),
164            None => {
165                return Err(ExprError::InvalidParam {
166                    name: "keys",
167                    reason: "null value not allowed for object key".into(),
168                });
169            }
170        }
171        match value {
172            Some(s) => builder.add_string(s.into_utf8()),
173            None => builder.add_null(),
174        }
175    }
176    builder.end_object();
177    Ok(builder.finish().into())
178}
risingwave_expr_impl/scalar/jsonb_object.rs

risingwave_expr_impl/scalar/
jsonb_object.rs
