risingwave_expr_impl/scalar/
array_remove.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 risingwave_common::array::{ListRef, ListValue};
16use risingwave_common::types::ScalarRefImpl;
17use risingwave_expr::function;
18
19/// Removes all elements equal to the given value from the array.
20/// Note the behavior is slightly different from PG.
21///
22/// Examples:
23///
24/// ```slt
25/// query T
26/// select array_remove(array[array[1],array[2],array[3],array[2],null], array[1]);
27/// ----
28/// {{2},{3},{2},NULL}
29///
30/// query T
31/// select array_remove(array[array[1],array[2],array[3],array[2],null], array[2]);
32/// ----
33/// {{1},{3},NULL}
34///
35/// query T
36/// select array_remove(array[array[1],array[2],array[3],array[2],null], null);
37/// ----
38/// {{1},{2},{3},{2}}
39///
40/// query T
41/// select array_remove(array[array[1],array[2],array[3],array[2],null], array[4]);
42/// ----
43/// {{1},{2},{3},{2},NULL}
44///
45/// query T
46/// select array_remove(null, 1);
47/// ----
48/// NULL
49///
50/// query T
51/// select array_remove(ARRAY[array[1],array[2],array[3],array[2],null], array[3.14]);
52/// ----
53/// {{1},{2},{3},{2},NULL}
54///
55/// query T
56/// select array_remove(array[1,NULL,NULL,3], NULL);
57/// ----
58/// {1,3}
59///
60/// statement error
61/// select array_remove(array[array[1],array[2],array[3],array[2],null], 1);
62///
63/// statement error
64/// select array_remove(array[array[1],array[2],array[3],array[2],null], array[array[3]]);
65///
66/// statement error
67/// select array_remove(ARRAY[array[1],array[2],array[3],array[2],null], array[true]);
68/// ```
69#[function("array_remove(anyarray, any) -> anyarray")]
70fn array_remove(array: ListRef<'_>, elem: Option<ScalarRefImpl<'_>>) -> ListValue {
71    ListValue::from_datum_iter(&array.data_type(), array.iter().filter(|x| x != &elem))
72}
risingwave_expr_impl/scalar/array_remove.rs

risingwave_expr_impl/scalar/
array_remove.rs
