-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issue-14416 - feat: Add array_min function
- Loading branch information
1 parent
ea788c7
commit c696cbb
Showing
4 changed files
with
269 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| // 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. | ||
|
|
||
| //! [`ScalarUDFImpl`] definitions for array_min function. | ||
| use crate::sort::array_sort_inner; | ||
| use crate::utils::make_scalar_function; | ||
| use arrow_array::{Array, ArrayRef, StringArray}; | ||
| use arrow_schema::DataType; | ||
| use arrow_schema::DataType::{FixedSizeList, LargeList, List}; | ||
| use datafusion_common::cast::as_list_array; | ||
| use datafusion_common::exec_err; | ||
| use datafusion_doc::Documentation; | ||
| use datafusion_expr::{ColumnarValue, Expr, ScalarUDFImpl, Signature, Volatility}; | ||
| use datafusion_macros::user_doc; | ||
| use std::any::Any; | ||
| use std::sync::Arc; | ||
|
|
||
| make_udf_expr_and_func!( | ||
| ArrayMin, | ||
| array_min, | ||
| array, | ||
| "returns the minimum value in the array.", | ||
| array_min_udf | ||
| ); | ||
|
|
||
| #[user_doc( | ||
| doc_section(label = "Array Functions"), | ||
| description = "Returns the minimum value in the array.", | ||
| syntax_example = "array_min(array)", | ||
| sql_example = r#"```sql | ||
| > select array_min([3,1,4,2]); | ||
| +-----------------------------------------+ | ||
| | array_min(List([3,1,4,2])) | | ||
| +-----------------------------------------+ | ||
| | 1 | | ||
| +-----------------------------------------+ | ||
| ```"#, | ||
| argument( | ||
| name = "array", | ||
| description = "Array expression. Can be a constant, column, or function, and any combination of array operators." | ||
| ) | ||
| )] | ||
| #[derive(Debug)] | ||
| pub struct ArrayMin { | ||
| signature: Signature, | ||
| aliases: Vec<String>, | ||
| } | ||
|
|
||
| impl Default for ArrayMin { | ||
| fn default() -> Self { | ||
| Self::new() | ||
| } | ||
| } | ||
|
|
||
| impl ArrayMin { | ||
| pub fn new() -> Self { | ||
| Self { | ||
| signature: Signature::array(Volatility::Immutable), | ||
| aliases: vec!["list_min".to_string()], | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl ScalarUDFImpl for ArrayMin { | ||
| fn as_any(&self) -> &dyn Any { | ||
| self | ||
| } | ||
|
|
||
| fn name(&self) -> &str { | ||
| "array_min" | ||
| } | ||
|
|
||
| fn display_name(&self, args: &[Expr]) -> datafusion_common::Result<String> { | ||
| let args_name = args.iter().map(ToString::to_string).collect::<Vec<_>>(); | ||
| if args_name.len() != 1 { | ||
| return exec_err!("expects 1 arg, got {}", args_name.len()); | ||
| } | ||
|
|
||
| Ok(format!("{}", args_name[0])) | ||
| } | ||
|
|
||
| fn schema_name(&self, args: &[Expr]) -> datafusion_common::Result<String> { | ||
| let args_name = args | ||
| .iter() | ||
| .map(|e| e.schema_name().to_string()) | ||
| .collect::<Vec<_>>(); | ||
| if args_name.len() != 1 { | ||
| return exec_err!("expects 1 arg, got {}", args_name.len()); | ||
| } | ||
|
|
||
| Ok(format!("{}", args_name[0])) | ||
| } | ||
|
|
||
| fn signature(&self) -> &Signature { | ||
| &self.signature | ||
| } | ||
|
|
||
| fn return_type(&self, arg_types: &[DataType]) -> datafusion_common::Result<DataType> { | ||
| match &arg_types[0] { | ||
| List(field) | LargeList(field) | FixedSizeList(field, _) => { | ||
| Ok(field.data_type().clone()) | ||
| } | ||
| _ => exec_err!( | ||
| "Not reachable, data_type should be List, LargeList or FixedSizeList" | ||
| ), | ||
| } | ||
| } | ||
|
|
||
| fn invoke_batch( | ||
| &self, | ||
| args: &[ColumnarValue], | ||
| _number_rows: usize, | ||
| ) -> datafusion_common::Result<ColumnarValue> { | ||
| make_scalar_function(array_min_inner)(args) | ||
| } | ||
|
|
||
| fn aliases(&self) -> &[String] { | ||
| &self.aliases | ||
| } | ||
|
|
||
| fn documentation(&self) -> Option<&Documentation> { | ||
| self.doc() | ||
| } | ||
| } | ||
|
|
||
| /// array_min SQL function | ||
| /// | ||
| /// There is one argument for array_min as the array. | ||
| /// `array_min(array)` | ||
| /// | ||
| /// For example: | ||
| /// > array_min(\[3, 1, 2]) -> 1 | ||
| pub fn array_min_inner(args: &[ArrayRef]) -> datafusion_common::Result<ArrayRef> { | ||
| if args.len() != 1 { | ||
| return exec_err!("array_min needs one argument"); | ||
| } | ||
|
|
||
| match &args[0].data_type() { | ||
| List(_) | LargeList(_) | FixedSizeList(_, _) => { | ||
| let new_args = vec![ | ||
| args[0].clone(), | ||
| Arc::new(StringArray::from_iter(vec![Some("ASC")])), | ||
| Arc::new(StringArray::from_iter(vec![Some("NULLS LAST")])), | ||
| ]; | ||
| array_min_internal(&new_args) | ||
| } | ||
| _ => exec_err!("array_min does not support type: {:?}", args[0].data_type()), | ||
| } | ||
| } | ||
|
|
||
| fn array_min_internal(args: &[ArrayRef]) -> datafusion_common::Result<ArrayRef> { | ||
| let sorted_array = array_sort_inner(args)?; | ||
| let result_array = as_list_array(&sorted_array)?.value(0); | ||
| if result_array.is_empty() { | ||
| return exec_err!("array_min needs one argument as non-empty array"); | ||
| } | ||
| let min_result = result_array.slice(0, 1); | ||
| Ok(min_result) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters