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#[deprecated(
28    since = "0.50.0",
29    note = "Use UnicodeFunctionPlanner and DateTimeFunctionPlanner instead"
30)]
31#[derive(Default, Debug)]
32pub struct UserDefinedFunctionPlanner;
33
34#[expect(deprecated)]
35impl ExprPlanner for UserDefinedFunctionPlanner {
36    #[cfg(feature = "datetime_expressions")]
37    fn plan_extract(&self, args: Vec<Expr>) -> Result<PlannerResult<Vec<Expr>>> {
38        Ok(PlannerResult::Planned(Expr::ScalarFunction(
39            ScalarFunction::new_udf(crate::datetime::date_part(), args),
40        )))
41    }
42
43    #[cfg(feature = "unicode_expressions")]
44    fn plan_position(&self, args: Vec<Expr>) -> Result<PlannerResult<Vec<Expr>>> {
45        Ok(PlannerResult::Planned(Expr::ScalarFunction(
46            ScalarFunction::new_udf(crate::unicode::strpos(), args),
47        )))
48    }
49
50    #[cfg(feature = "unicode_expressions")]
51    fn plan_substring(&self, args: Vec<Expr>) -> Result<PlannerResult<Vec<Expr>>> {
52        Ok(PlannerResult::Planned(Expr::ScalarFunction(
53            ScalarFunction::new_udf(crate::unicode::substr(), args),
54        )))
55    }
56}
datafusion_functions/planner.rs

datafusion_functions/
planner.rs
