Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove physical expr of NamedStructField, convert to get_field function call #9563

Merged
merged 18 commits into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions datafusion-cli/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 8 additions & 7 deletions datafusion/core/src/physical_planner.rs
Original file line number Diff line number Diff line change
Expand Up @@ -207,10 +207,13 @@ fn create_physical_name(e: &Expr, is_first_expr: bool) -> Result<String> {
let expr = create_physical_name(expr, false)?;
Ok(format!("{expr} IS NOT UNKNOWN"))
}
Expr::GetIndexedField(GetIndexedField { expr, field }) => {
let expr = create_physical_name(expr, false)?;
let name = match field {
GetFieldAccess::NamedStructField { name } => format!("{expr}[{name}]"),
Expr::GetIndexedField(GetIndexedField { expr: _, field }) => {
match field {
GetFieldAccess::NamedStructField { name: _ } => {
unreachable!(
"NamedStructField should have been rewritten in OperatorToFunction"
)
}
GetFieldAccess::ListIndex { key: _ } => {
unreachable!(
"ListIndex should have been rewritten in OperatorToFunction"
Expand All @@ -222,12 +225,10 @@ fn create_physical_name(e: &Expr, is_first_expr: bool) -> Result<String> {
stride: _,
} => {
unreachable!(
"ListIndex should have been rewritten in OperatorToFunction"
"ListRange should have been rewritten in OperatorToFunction"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

)
}
};

Ok(name)
}
Expr::ScalarFunction(fun) => {
// function should be resolved during `AnalyzerRule`s
Expand Down
139 changes: 139 additions & 0 deletions datafusion/functions/src/core/getfield.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
// 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.

use arrow::datatypes::DataType;
use arrow_array::{Scalar, StringArray};
use datafusion_common::cast::{as_map_array, as_struct_array};
use datafusion_common::{exec_err, ExprSchema, Result, ScalarValue};
use datafusion_expr::field_util::GetFieldAccessSchema;
use datafusion_expr::{ColumnarValue, Expr, ExprSchemable};
use datafusion_expr::{ScalarUDFImpl, Signature, Volatility};
use std::any::Any;

#[derive(Debug)]
pub struct GetFieldFunc {
signature: Signature,
}

impl GetFieldFunc {
pub fn new() -> Self {
Self {
signature: Signature::any(2, Volatility::Immutable),
Copy link
Contributor

@jayzhan211 jayzhan211 Mar 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it seems the signature should be struct and utf8. But, we can set it to Any and utf8 for now.

Copy link
Contributor Author

@yyy1000 yyy1000 Mar 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it can also be Map and utf8.
A question for me is how to specify the Any as the param in Signature?
I tried Signature::exact(vec![Any, DataType::Utf8], Volatility::Immutable) but it said

expected value, found trait Any not a value

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should keep it as any(2) for now. I forgot that it is better to introduce signature only if we need type coercion.

}
}
}
impl Default for GetFieldFunc {
fn default() -> Self {
Self::new()
}
}

// get_field(struct_array, field_name)
impl ScalarUDFImpl for GetFieldFunc {
fn as_any(&self) -> &dyn Any {
self
}
fn name(&self) -> &str {
"get_field"
}

fn signature(&self) -> &Signature {
&self.signature
}

fn return_type(&self, _: &[DataType]) -> Result<DataType> {
todo!()
}

fn return_type_from_exprs(
&self,
args: &[Expr],
schema: &dyn ExprSchema,
_arg_types: &[DataType],
) -> Result<DataType> {
if args.len() != 2 {
return exec_err!(
"get_field function requires 2 arguments, got {}",
args.len()
);
}

let name = match &args[1] {
Expr::Literal(name) => name,
_ => {
return exec_err!(
"get_field function requires the argument field_name to be a string"
);
}
};
let access_schema = GetFieldAccessSchema::NamedStructField { name: name.clone() };
let arg_dt = args[0].get_type(schema)?;
access_schema
.get_accessed_field(&arg_dt)
.map(|f| f.data_type().clone())
}

fn invoke(&self, args: &[ColumnarValue]) -> Result<ColumnarValue> {
if args.len() != 2 {
return exec_err!(
"get_field function requires 2 arguments, got {}",
args.len()
);
}

let arr;
let array = match &args[0] {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe try values_to_arrays?

ColumnarValue::Array(array) => array,
ColumnarValue::Scalar(scalar) => {
arr = scalar.clone().to_array()?;
&arr
}
};
let name = match &args[1] {
ColumnarValue::Scalar(name) => name,
_ => {
return exec_err!(
"get_field function requires the argument field_name to be a string"
);
}
};
match (array.data_type(), name) {
(DataType::Map(_, _), ScalarValue::Utf8(Some(k))) => {
let map_array = as_map_array(array.as_ref())?;
let key_scalar = Scalar::new(StringArray::from(vec![k.clone()]));
let keys = arrow::compute::kernels::cmp::eq(&key_scalar, map_array.keys())?;
let entries = arrow::compute::filter(map_array.entries(), &keys)?;
let entries_struct_array = as_struct_array(entries.as_ref())?;
Ok(ColumnarValue::Array(entries_struct_array.column(1).clone()))
}
(DataType::Struct(_), ScalarValue::Utf8(Some(k))) => {
let as_struct_array = as_struct_array(&array)?;
match as_struct_array.column_by_name(k) {
None => exec_err!(
"get indexed field {k} not found in struct"),
Some(col) => Ok(ColumnarValue::Array(col.clone()))
}
}
(DataType::Struct(_), name) => exec_err!(
"get indexed field is only possible on struct with utf8 indexes. \
Tried with {name:?} index"),
(dt, name) => exec_err!(
"get indexed field is only possible on lists with int64 indexes or struct \
with utf8 indexes. Tried {dt:?} with {name:?} index"),
}
}
}
7 changes: 5 additions & 2 deletions datafusion/functions/src/core/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,26 @@
//! "core" DataFusion functions

mod arrowtypeof;
pub mod getfield;
mod nullif;
mod nvl;
mod nvl2;
pub mod r#struct;
mod r#struct;

// create UDFs
make_udf_function!(nullif::NullIfFunc, NULLIF, nullif);
make_udf_function!(nvl::NVLFunc, NVL, nvl);
make_udf_function!(nvl2::NVL2Func, NVL2, nvl2);
make_udf_function!(arrowtypeof::ArrowTypeOfFunc, ARROWTYPEOF, arrow_typeof);
make_udf_function!(r#struct::StructFunc, STRUCT, r#struct);
make_udf_function!(getfield::GetFieldFunc, GET_FIELD, get_field);

// Export the functions out of this package, both as expr_fn as well as a list of functions
export_functions!(
(nullif, arg_1 arg_2, "returns NULL if value1 equals value2; otherwise it returns value1. This can be used to perform the inverse operation of the COALESCE expression."),
(nvl, arg_1 arg_2, "returns value2 if value1 is NULL; otherwise it returns value1"),
(nvl2, arg_1 arg_2 arg_3, "Returns value2 if value1 is not NULL; otherwise, it returns value3."),
(arrow_typeof, arg_1, "Returns the Arrow type of the input expression."),
(r#struct, args, "Returns a struct with the given arguments")
(r#struct, args, "Returns a struct with the given arguments"),
(get_field, arg_1 arg_2, "Returns the value of the field with the given name from the struct")
);
8 changes: 1 addition & 7 deletions datafusion/functions/src/core/struct.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ fn struct_expr(args: &[ColumnarValue]) -> Result<ColumnarValue> {
Ok(ColumnarValue::Array(array_struct(arrays.as_slice())?))
}
#[derive(Debug)]
pub struct StructFunc {
pub(super) struct StructFunc {
signature: Signature,
}

Expand All @@ -73,12 +73,6 @@ impl StructFunc {
}
}

impl Default for StructFunc {
fn default() -> Self {
Self::new()
}
}

impl ScalarUDFImpl for StructFunc {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last PR I make StructFunc pub so I add the Default trait, but since #9546 (comment) it will not be needed.

fn as_any(&self) -> &dyn Any {
self
Expand Down
1 change: 1 addition & 0 deletions datafusion/optimizer/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ async-trait = { workspace = true }
chrono = { workspace = true }
datafusion-common = { workspace = true, default-features = true }
datafusion-expr = { workspace = true }
datafusion-functions = { workspace = true }
Copy link
Contributor

@alamb alamb Mar 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is very important to not add this dependency -- we are triyng to make the core not know about the functions

I think #9583 will let us avoid it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, I can wait on it and use that function.

datafusion-functions-array = { workspace = true, optional = true }
datafusion-physical-expr = { workspace = true }
hashbrown = { version = "0.14", features = ["raw"] }
Expand Down
17 changes: 14 additions & 3 deletions datafusion/optimizer/src/analyzer/rewrite_expr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

//! Analyzer rule for to replace operators with function calls (e.g `||` to array_concat`)

#[cfg(feature = "array_expressions")]
use std::sync::Arc;

use super::AnalyzerRule;
Expand All @@ -30,11 +29,11 @@ use datafusion_common::{DFSchema, 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::GetFieldAccess;
use datafusion_expr::GetIndexedField;
#[cfg(feature = "array_expressions")]
use datafusion_expr::{BinaryExpr, Operator, ScalarFunctionDefinition};
use datafusion_expr::{BuiltinScalarFunction, ScalarUDF};
use datafusion_expr::{Expr, LogicalPlan};
#[cfg(feature = "array_expressions")]
use datafusion_functions_array::expr_fn::{array_append, array_concat, array_prepend};
Expand Down Expand Up @@ -137,6 +136,19 @@ impl TreeNodeRewriter for OperatorToFunctionRewriter {
}) = expr
{
match field {
GetFieldAccess::NamedStructField { name, .. } => {
let expr = *expr.clone();
let name = name.clone();
let args = vec![expr, Expr::Literal(name)];
return Ok(Transformed::yes(Expr::ScalarFunction(
ScalarFunction::new_udf(
Arc::new(ScalarUDF::new_from_impl(
datafusion_functions::core::getfield::GetFieldFunc::new(),
)),
args,
),
)));
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know the method from #9546 (comment), but it seems that here it can't get the context_provider?

Copy link
Contributor

@jayzhan211 jayzhan211 Mar 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only sql crate can get it directly, or any other crate that has context

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could implement this rewrite more easily using the API proposed in #9583 (so you could use datafusion_functions directly)

GetFieldAccess::ListIndex { ref key } => {
let expr = *expr.clone();
let key = *key.clone();
Expand All @@ -159,7 +171,6 @@ impl TreeNodeRewriter for OperatorToFunctionRewriter {
ScalarFunction::new(BuiltinScalarFunction::ArraySlice, args),
)));
}
_ => {}
}
}

Expand Down
Loading
Loading