-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
rewrite_expr.rs
321 lines (297 loc) · 10.7 KB
/
rewrite_expr.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
//! Analyzer rule for to replace operators with function calls (e.g `||` to array_concat`)
use std::sync::Arc;
use datafusion_common::config::ConfigOptions;
use datafusion_common::tree_node::TreeNodeRewriter;
use datafusion_common::utils::list_ndims;
use datafusion_common::DFSchema;
use datafusion_common::DFSchemaRef;
use datafusion_common::Result;
use datafusion_expr::expr::ScalarFunction;
use datafusion_expr::expr_rewriter::rewrite_preserving_name;
use datafusion_expr::utils::merge_schema;
use datafusion_expr::BuiltinScalarFunction;
use datafusion_expr::Operator;
use datafusion_expr::ScalarFunctionDefinition;
use datafusion_expr::{BinaryExpr, Expr, LogicalPlan};
use super::AnalyzerRule;
#[derive(Default)]
pub struct OperatorToFunction {}
impl OperatorToFunction {
pub fn new() -> Self {
Self {}
}
}
impl AnalyzerRule for OperatorToFunction {
fn name(&self) -> &str {
"operator_to_function"
}
fn analyze(&self, plan: LogicalPlan, _: &ConfigOptions) -> Result<LogicalPlan> {
analyze_internal(&plan)
}
}
fn analyze_internal(plan: &LogicalPlan) -> Result<LogicalPlan> {
// optimize child plans first
let new_inputs = plan
.inputs()
.iter()
.map(|p| analyze_internal(p))
.collect::<Result<Vec<_>>>()?;
// get schema representing all available input fields. This is used for data type
// resolution only, so order does not matter here
let mut schema = merge_schema(new_inputs.iter().collect());
if let LogicalPlan::TableScan(ts) = plan {
let source_schema =
DFSchema::try_from_qualified_schema(&ts.table_name, &ts.source.schema())?;
schema.merge(&source_schema);
}
let mut expr_rewrite = OperatorToFunctionRewriter {
schema: Arc::new(schema),
};
let new_expr = plan
.expressions()
.into_iter()
.map(|expr| {
// ensure names don't change:
// https://github.com/apache/arrow-datafusion/issues/3555
rewrite_preserving_name(expr, &mut expr_rewrite)
})
.collect::<Result<Vec<_>>>()?;
plan.with_new_exprs(new_expr, new_inputs)
}
pub(crate) struct OperatorToFunctionRewriter {
pub(crate) schema: DFSchemaRef,
}
impl TreeNodeRewriter for OperatorToFunctionRewriter {
type N = Expr;
fn mutate(&mut self, expr: Expr) -> Result<Expr> {
match expr {
Expr::BinaryExpr(BinaryExpr {
ref left,
op,
ref right,
}) => {
if let Some(fun) = rewrite_array_concat_operator_to_func_for_column(
left.as_ref(),
op,
right.as_ref(),
self.schema.as_ref(),
)?
.or_else(|| {
rewrite_array_concat_operator_to_func(
left.as_ref(),
op,
right.as_ref(),
)
}) {
// Convert &Box<Expr> -> Expr
let left = (**left).clone();
let right = (**right).clone();
return Ok(Expr::ScalarFunction(ScalarFunction {
func_def: ScalarFunctionDefinition::BuiltIn(fun),
args: vec![left, right],
}));
}
Ok(expr)
}
_ => Ok(expr),
}
}
}
/// Summary of the logic below:
///
/// 1) array || array -> array concat
///
/// 2) array || scalar -> array append
///
/// 3) scalar || array -> array prepend
///
/// 4) (arry concat, array append, array prepend) || array -> array concat
///
/// 5) (arry concat, array append, array prepend) || scalar -> array append
fn rewrite_array_concat_operator_to_func(
left: &Expr,
op: Operator,
right: &Expr,
) -> Option<BuiltinScalarFunction> {
// Convert `Array StringConcat Array` to ScalarFunction::ArrayConcat
if op != Operator::StringConcat {
return None;
}
match (left, right) {
// Chain concat operator (a || b) || array,
// (arry concat, array append, array prepend) || array -> array concat
(
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::ArrayConcat),
args: _left_args,
}),
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::MakeArray),
args: _right_args,
}),
)
| (
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::ArrayAppend),
args: _left_args,
}),
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::MakeArray),
args: _right_args,
}),
)
| (
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::ArrayPrepend),
args: _left_args,
}),
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::MakeArray),
args: _right_args,
}),
) => Some(BuiltinScalarFunction::ArrayConcat),
// Chain concat operator (a || b) || scalar,
// (arry concat, array append, array prepend) || scalar -> array append
(
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::ArrayConcat),
args: _left_args,
}),
_scalar,
)
| (
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::ArrayAppend),
args: _left_args,
}),
_scalar,
)
| (
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::ArrayPrepend),
args: _left_args,
}),
_scalar,
) => Some(BuiltinScalarFunction::ArrayAppend),
// array || array -> array concat
(
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::MakeArray),
args: _left_args,
}),
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::MakeArray),
args: _right_args,
}),
) => Some(BuiltinScalarFunction::ArrayConcat),
// array || scalar -> array append
(
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::MakeArray),
args: _left_args,
}),
_right_scalar,
) => Some(BuiltinScalarFunction::ArrayAppend),
// scalar || array -> array prepend
(
_left_scalar,
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::MakeArray),
args: _right_args,
}),
) => Some(BuiltinScalarFunction::ArrayPrepend),
_ => None,
}
}
/// Summary of the logic below:
///
/// 1) (arry concat, array append, array prepend) || column -> (array append, array concat)
///
/// 2) column1 || column2 -> (array prepend, array append, array concat)
fn rewrite_array_concat_operator_to_func_for_column(
left: &Expr,
op: Operator,
right: &Expr,
schema: &DFSchema,
) -> Result<Option<BuiltinScalarFunction>> {
if op != Operator::StringConcat {
return Ok(None);
}
match (left, right) {
// Column cases:
// 1) array_prepend/append/concat || column
(
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::ArrayPrepend),
args: _left_args,
}),
Expr::Column(c),
)
| (
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::ArrayAppend),
args: _left_args,
}),
Expr::Column(c),
)
| (
Expr::ScalarFunction(ScalarFunction {
func_def:
ScalarFunctionDefinition::BuiltIn(BuiltinScalarFunction::ArrayConcat),
args: _left_args,
}),
Expr::Column(c),
) => {
let d = schema.field_from_column(c)?.data_type();
let ndim = list_ndims(d);
match ndim {
0 => Ok(Some(BuiltinScalarFunction::ArrayAppend)),
_ => Ok(Some(BuiltinScalarFunction::ArrayConcat)),
}
}
// 2) select column1 || column2
(Expr::Column(c1), Expr::Column(c2)) => {
let d1 = schema.field_from_column(c1)?.data_type();
let d2 = schema.field_from_column(c2)?.data_type();
let ndim1 = list_ndims(d1);
let ndim2 = list_ndims(d2);
match (ndim1, ndim2) {
(0, _) => Ok(Some(BuiltinScalarFunction::ArrayPrepend)),
(_, 0) => Ok(Some(BuiltinScalarFunction::ArrayAppend)),
_ => Ok(Some(BuiltinScalarFunction::ArrayConcat)),
}
}
_ => Ok(None),
}
}