datafusion_functions/
planner.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18//! SQL planning extensions like [`UserDefinedFunctionPlanner`]
19
20use datafusion_common::Result;
21use datafusion_expr::{
22    expr::ScalarFunction,
23    planner::{ExprPlanner, PlannerResult},
24    Expr,
25};
26
27#[derive(Default, Debug)]
28pub struct UserDefinedFunctionPlanner;
29
30impl ExprPlanner for UserDefinedFunctionPlanner {
31    #[cfg(feature = "datetime_expressions")]
32    fn plan_extract(&self, args: Vec<Expr>) -> Result<PlannerResult<Vec<Expr>>> {
33        Ok(PlannerResult::Planned(Expr::ScalarFunction(
34            ScalarFunction::new_udf(crate::datetime::date_part(), args),
35        )))
36    }
37
38    #[cfg(feature = "unicode_expressions")]
39    fn plan_position(&self, args: Vec<Expr>) -> Result<PlannerResult<Vec<Expr>>> {
40        Ok(PlannerResult::Planned(Expr::ScalarFunction(
41            ScalarFunction::new_udf(crate::unicode::strpos(), args),
42        )))
43    }
44
45    #[cfg(feature = "unicode_expressions")]
46    fn plan_substring(&self, args: Vec<Expr>) -> Result<PlannerResult<Vec<Expr>>> {
47        Ok(PlannerResult::Planned(Expr::ScalarFunction(
48            ScalarFunction::new_udf(crate::unicode::substr(), args),
49        )))
50    }
51}