datafusion-ffi 55.0.0

// 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 std::sync::Arc;

use arrow_schema::DataType;
use datafusion_catalog::TableFunctionImpl;
use datafusion_common::ScalarValue;
use datafusion_common::config::ConfigOptions;
use datafusion_expr::sort_properties::ExprProperties;
use datafusion_expr::{
    AggregateUDF, ColumnarValue, ExpressionPlacement, ScalarFunctionArgs, ScalarUDF,
    ScalarUDFImpl, Signature, Volatility, WindowUDF,
};
use datafusion_functions::math::abs::AbsFunc;
use datafusion_functions::math::random::RandomFunc;
use datafusion_functions_aggregate::first_last::FirstValue;
use datafusion_functions_aggregate::stddev::Stddev;
use datafusion_functions_aggregate::sum::Sum;
use datafusion_functions_table::generate_series::RangeFunc;
use datafusion_functions_window::rank::Rank;

use crate::proto::logical_extension_codec::FFI_LogicalExtensionCodec;
use crate::udaf::FFI_AggregateUDF;
use crate::udf::FFI_ScalarUDF;
use crate::udtf::FFI_TableFunction;
use crate::udwf::FFI_WindowUDF;

pub(crate) extern "C" fn create_ffi_abs_func() -> FFI_ScalarUDF {
    let inner = WrappedAbs(Arc::new(AbsFunc::new().into()));
    let udf: Arc<ScalarUDF> = Arc::new(inner.into());

    udf.into()
}

#[derive(Debug, Hash, Eq, PartialEq)]
struct WrappedAbs(Arc<ScalarUDF>);

impl ScalarUDFImpl for WrappedAbs {
    fn name(&self) -> &str {
        "ffi_abs"
    }

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

    fn return_type(&self, arg_types: &[DataType]) -> datafusion_common::Result<DataType> {
        self.0.return_type(arg_types)
    }

    fn invoke_with_args(
        &self,
        args: ScalarFunctionArgs,
    ) -> datafusion_common::Result<ColumnarValue> {
        self.0.invoke_with_args(args)
    }
}

pub(crate) extern "C" fn create_ffi_random_func() -> FFI_ScalarUDF {
    let udf: Arc<ScalarUDF> = Arc::new(RandomFunc::new().into());

    udf.into()
}

#[derive(Debug, PartialEq, Eq, Hash)]
struct TimeZoneUDF {
    signature: Signature,
}

impl ScalarUDFImpl for TimeZoneUDF {
    fn name(&self) -> &str {
        "TimeZoneUDF"
    }

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

    fn return_type(
        &self,
        _arg_types: &[DataType],
    ) -> datafusion_common::Result<DataType> {
        Ok(DataType::Utf8)
    }

    fn invoke_with_args(
        &self,
        args: ScalarFunctionArgs,
    ) -> datafusion_common::Result<ColumnarValue> {
        let tz = args.config_options.execution.time_zone.clone();
        Ok(ColumnarValue::Scalar(ScalarValue::from(tz)))
    }

    fn with_updated_config(&self, config: &ConfigOptions) -> Option<ScalarUDF> {
        config.execution.time_zone.as_ref()?;
        Some(ScalarUDF::from(Self {
            signature: self.signature.clone(),
        }))
    }
}

pub(crate) extern "C" fn create_timezone_func() -> FFI_ScalarUDF {
    let udf: Arc<ScalarUDF> = Arc::new(ScalarUDF::from(TimeZoneUDF {
        signature: Signature::uniform(1, vec![DataType::Utf8], Volatility::Stable),
    }));

    udf.into()
}

#[derive(Debug, PartialEq, Eq, Hash)]
struct PlacementUDF {
    signature: Signature,
}

impl ScalarUDFImpl for PlacementUDF {
    fn name(&self) -> &str {
        "placement_udf"
    }

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

    fn return_type(
        &self,
        _arg_types: &[DataType],
    ) -> datafusion_common::Result<DataType> {
        Ok(DataType::Int64)
    }

    fn invoke_with_args(
        &self,
        _args: ScalarFunctionArgs,
    ) -> datafusion_common::Result<ColumnarValue> {
        datafusion_common::internal_err!("placement_udf is not meant to be invoked")
    }

    fn placement(&self, args: &[ExpressionPlacement]) -> ExpressionPlacement {
        // Push to the leaves only for a (Column, Literal) pairing, so the
        // test catches dropped, reordered, or truncated arguments.
        if matches!(
            args,
            [ExpressionPlacement::Column, ExpressionPlacement::Literal]
        ) {
            ExpressionPlacement::MoveTowardsLeafNodes
        } else {
            ExpressionPlacement::KeepInPlace
        }
    }

    fn preserves_lex_ordering(
        &self,
        inputs: &[ExprProperties],
    ) -> datafusion_common::Result<bool> {
        Ok(inputs.iter().all(|input| input.preserves_lex_ordering))
    }
}

pub(crate) extern "C" fn create_placement_func() -> FFI_ScalarUDF {
    let udf: Arc<ScalarUDF> = Arc::new(ScalarUDF::from(PlacementUDF {
        signature: Signature::uniform(1, vec![DataType::Int64], Volatility::Immutable),
    }));

    udf.into()
}

pub(crate) extern "C" fn create_ffi_table_func(
    codec: FFI_LogicalExtensionCodec,
) -> FFI_TableFunction {
    let udtf: Arc<dyn TableFunctionImpl> = Arc::new(RangeFunc {});

    FFI_TableFunction::new_with_ffi_codec(udtf, None, codec)
}

pub(crate) extern "C" fn create_ffi_sum_func() -> FFI_AggregateUDF {
    let udaf: Arc<AggregateUDF> = Arc::new(Sum::new().into());

    udaf.into()
}

pub(crate) extern "C" fn create_ffi_first_value_func() -> FFI_AggregateUDF {
    let udaf: Arc<AggregateUDF> = Arc::new(FirstValue::new().into());

    udaf.into()
}

pub(crate) extern "C" fn create_ffi_stddev_func() -> FFI_AggregateUDF {
    let udaf: Arc<AggregateUDF> = Arc::new(Stddev::new().into());

    udaf.into()
}

pub(crate) extern "C" fn create_ffi_rank_func() -> FFI_WindowUDF {
    let udwf: Arc<WindowUDF> = Arc::new(
        Rank::new(
            "rank_demo".to_string(),
            datafusion_functions_window::rank::RankType::Basic,
        )
        .into(),
    );

    udwf.into()
}