feat: Implement Spark bin function
#20479
+244
−20
There are no files selected for viewing
This file contains hidden or 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,177 @@ | ||
| // 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::array::{ArrayRef, AsArray, StringArray}; | ||
| use arrow::datatypes::{ | ||
| DataType, Decimal32Type, Decimal64Type, Field, FieldRef, Float16Type, Float32Type, | ||
| Float64Type, Int8Type, Int16Type, Int32Type, Int64Type, | ||
| }; | ||
| use bigdecimal::ToPrimitive; | ||
| use datafusion::logical_expr::{ColumnarValue, Signature, TypeSignature, Volatility}; | ||
| use datafusion_common::types::{NativeType, logical_int64}; | ||
| use datafusion_common::utils::take_function_args; | ||
| use datafusion_common::{Result, internal_err}; | ||
| use datafusion_expr::{Coercion, ScalarFunctionArgs, ScalarUDFImpl, TypeSignatureClass}; | ||
| use datafusion_functions::utils::make_scalar_function; | ||
| use std::any::Any; | ||
| use std::sync::Arc; | ||
|
|
||
| /// Spark-compatible `bin` expression | ||
| /// <https://spark.apache.org/docs/latest/api/sql/index.html#bin> | ||
| #[derive(Debug, PartialEq, Eq, Hash)] | ||
| pub struct SparkBin { | ||
| signature: Signature, | ||
| } | ||
|
|
||
| impl Default for SparkBin { | ||
| fn default() -> Self { | ||
| Self::new() | ||
| } | ||
| } | ||
|
|
||
| impl SparkBin { | ||
| pub fn new() -> Self { | ||
| Self { | ||
| signature: Signature::one_of( | ||
| vec![TypeSignature::Coercible(vec![Coercion::new_implicit( | ||
| TypeSignatureClass::Native(logical_int64()), | ||
| vec![TypeSignatureClass::Numeric], | ||
| NativeType::Int64, | ||
| )])], | ||
| Volatility::Immutable, | ||
| ), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl ScalarUDFImpl for SparkBin { | ||
| fn as_any(&self) -> &dyn Any { | ||
| self | ||
| } | ||
|
|
||
| fn name(&self) -> &str { | ||
| "bin" | ||
| } | ||
|
|
||
| fn signature(&self) -> &Signature { | ||
| &self.signature | ||
| } | ||
|
|
||
| fn return_type(&self, _arg_types: &[DataType]) -> Result<DataType> { | ||
| internal_err!("return_field_from_args should be used instead") | ||
| } | ||
|
|
||
| fn return_field_from_args( | ||
| &self, | ||
| args: datafusion_expr::ReturnFieldArgs, | ||
| ) -> Result<FieldRef> { | ||
| Ok(Arc::new(Field::new( | ||
| self.name(), | ||
| DataType::Utf8, | ||
| args.arg_fields[0].is_nullable(), | ||
| ))) | ||
| } | ||
|
|
||
| fn invoke_with_args(&self, args: ScalarFunctionArgs) -> Result<ColumnarValue> { | ||
| make_scalar_function(spark_bin_inner, vec![])(&args.args) | ||
| } | ||
| } | ||
|
|
||
| pub fn spark_bin_inner(arg: &[ArrayRef]) -> Result<ArrayRef> { | ||
| let [array] = take_function_args("bin", arg)?; | ||
| match &array.data_type() { | ||
| DataType::Int8 => { | ||
| let result: StringArray = array | ||
| .as_primitive::<Int8Type>() | ||
| .iter() | ||
| .map(|opt| opt.map(|value| spark_bin(value.into()))) | ||
| .collect(); | ||
| Ok(Arc::new(result)) | ||
| } | ||
| DataType::Int16 => { | ||
| let result: StringArray = array | ||
| .as_primitive::<Int16Type>() | ||
| .iter() | ||
| .map(|opt| opt.map(|value| spark_bin(value.into()))) | ||
| .collect(); | ||
| Ok(Arc::new(result)) | ||
| } | ||
| DataType::Int32 => { | ||
| let result: StringArray = array | ||
| .as_primitive::<Int32Type>() | ||
| .iter() | ||
| .map(|opt| opt.map(|value| spark_bin(value.into()))) | ||
| .collect(); | ||
| Ok(Arc::new(result)) | ||
| } | ||
| DataType::Int64 => { | ||
| let result: StringArray = array | ||
| .as_primitive::<Int64Type>() | ||
| .iter() | ||
| .map(|opt| opt.map(spark_bin)) | ||
| .collect(); | ||
| Ok(Arc::new(result)) | ||
| } | ||
| DataType::Float16 => { | ||
| let result: StringArray = array | ||
| .as_primitive::<Float16Type>() | ||
| .iter() | ||
| .map(|opt| opt.map(|value| spark_bin(value.to_i64().unwrap()))) | ||
| .collect(); | ||
| Ok(Arc::new(result)) | ||
| } | ||
| DataType::Float32 => { | ||
| let result: StringArray = array | ||
| .as_primitive::<Float32Type>() | ||
| .iter() | ||
| .map(|opt| opt.map(|value| spark_bin(value.to_i64().unwrap()))) | ||
| .collect(); | ||
| Ok(Arc::new(result)) | ||
| } | ||
| DataType::Float64 => { | ||
| let result: StringArray = array | ||
| .as_primitive::<Float64Type>() | ||
| .iter() | ||
| .map(|opt| opt.map(|value| spark_bin(value.to_i64().unwrap()))) | ||
| .collect(); | ||
| Ok(Arc::new(result)) | ||
| } | ||
| DataType::Decimal32(_, _) => { | ||
| let result: StringArray = array | ||
| .as_primitive::<Decimal32Type>() | ||
| .iter() | ||
| .map(|opt| opt.map(|value| spark_bin(value.into()))) | ||
| .collect(); | ||
| Ok(Arc::new(result)) | ||
| } | ||
| DataType::Decimal64(_, _) => { | ||
| let result: StringArray = array | ||
| .as_primitive::<Decimal64Type>() | ||
| .iter() | ||
| .map(|opt| opt.map(spark_bin)) | ||
| .collect(); | ||
| Ok(Arc::new(result)) | ||
| } | ||
| data_type => { | ||
| internal_err!("bin does not support: {data_type}") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fn spark_bin(value: i64) -> String { | ||
| format!("{value:b}") | ||
| } |
This file contains hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spark supports decimal, we should add this support to this PR as well