mod.rs

// 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.

pub mod add_months;
pub mod date_add;
pub mod date_diff;
pub mod date_part;
pub mod date_sub;
pub mod date_trunc;
pub mod dayname;
pub mod extract;
pub mod from_utc_timestamp;
pub mod last_day;
pub mod make_dt_interval;
pub mod make_interval;
pub mod next_day;
pub mod time_trunc;
pub mod to_utc_timestamp;
pub mod trunc;
pub mod unix;

use datafusion_expr::ScalarUDF;
use datafusion_functions::make_udf_function;
use std::sync::Arc;

make_udf_function!(add_months::SparkAddMonths, add_months);
make_udf_function!(date_add::SparkDateAdd, date_add);
make_udf_function!(date_diff::SparkDateDiff, date_diff);
make_udf_function!(date_part::SparkDatePart, date_part);
make_udf_function!(date_sub::SparkDateSub, date_sub);
make_udf_function!(date_trunc::SparkDateTrunc, date_trunc);
make_udf_function!(
    from_utc_timestamp::SparkFromUtcTimestamp,
    from_utc_timestamp
);
make_udf_function!(extract::SparkHour, hour);
make_udf_function!(extract::SparkMinute, minute);
make_udf_function!(extract::SparkSecond, second);
make_udf_function!(last_day::SparkLastDay, last_day);
make_udf_function!(make_dt_interval::SparkMakeDtInterval, make_dt_interval);
make_udf_function!(make_interval::SparkMakeInterval, make_interval);
make_udf_function!(next_day::SparkNextDay, next_day);
make_udf_function!(time_trunc::SparkTimeTrunc, time_trunc);
make_udf_function!(to_utc_timestamp::SparkToUtcTimestamp, to_utc_timestamp);
make_udf_function!(trunc::SparkTrunc, trunc);
make_udf_function!(unix::SparkUnixDate, unix_date);
make_udf_function!(
    unix::SparkUnixTimestamp,
    unix_micros,
    unix::SparkUnixTimestamp::microseconds
);
make_udf_function!(
    unix::SparkUnixTimestamp,
    unix_millis,
    unix::SparkUnixTimestamp::milliseconds
);
make_udf_function!(
    unix::SparkUnixTimestamp,
    unix_seconds,
    unix::SparkUnixTimestamp::seconds
);
make_udf_function!(dayname::SparkDayName, dayname);

pub mod expr_fn {
    use datafusion_functions::export_functions;

    export_functions!((
        add_months,
        "Returns the date that is months months after start. The function returns NULL if at least one of the input parameters is NULL.",
        arg1 arg2
    ));
    export_functions!((
        date_add,
        "Returns the date that is days days after start. The function returns NULL if at least one of the input parameters is NULL.",
        arg1 arg2
    ));
    export_functions!((
        date_sub,
        "Returns the date that is days days before start. The function returns NULL if at least one of the input parameters is NULL.",
        arg1 arg2
    ));
    export_functions!((hour, "Extracts the hour component of a timestamp.", arg1));
    export_functions!((
        minute,
        "Extracts the minute component of a timestamp.",
        arg1
    ));
    export_functions!((
        second,
        "Extracts the second component of a timestamp.",
        arg1
    ));
    export_functions!((
        last_day,
        "Returns the last day of the month which the date belongs to.",
        arg1
    ));
    export_functions!((
        make_dt_interval,
        "Make a day time interval from given days, hours, mins and secs (return type is actually a Duration(Microsecond))",
         days hours mins secs
    ));
    export_functions!((
        make_interval,
        "Make interval from years, months, weeks, days, hours, mins and secs.",
        years months weeks days hours mins secs
    ));
    // TODO: add once ANSI support is added:
    // "When both of the input parameters are not NULL and day_of_week is an invalid input, the function throws SparkIllegalArgumentException if spark.sql.ansi.enabled is set to true, otherwise NULL."
    export_functions!((
        next_day,
        "Returns the first date which is later than start_date and named as indicated. The function returns NULL if at least one of the input parameters is NULL.",
        arg1 arg2
    ));
    export_functions!((
        date_diff,
        "Returns the number of days from start `start` to end `end`.",
        end start
    ));
    export_functions!((
        date_trunc,
        "Truncates a timestamp `ts` to the unit specified by the format `fmt`.",
        fmt ts
    ));
    export_functions!((
        time_trunc,
        "Truncates a time `t` to the unit specified by the format `fmt`.",
        fmt t
    ));
    export_functions!((
        trunc,
        "Truncates a date `dt` to the unit specified by the format `fmt`.",
        dt fmt
    ));
    export_functions!((
        date_part,
        "Extracts a part of the date or time from a date, time, or timestamp expression.",
        arg1 arg2
    ));
    export_functions!((
        from_utc_timestamp,
        "Interpret a given timestamp `ts` in UTC timezone and then convert it to timezone `tz`.",
        ts tz
    ));
    export_functions!((
        to_utc_timestamp,
        "Interpret a given timestamp `ts` in timezone `tz` and then convert it to UTC timezone.",
        ts tz
    ));
    export_functions!((
        unix_date,
        "Returns the number of days since epoch (1970-01-01) for the given date `dt`.",
        dt
    ));
    export_functions!((
        unix_micros,
        "Returns the number of microseconds since epoch (1970-01-01 00:00:00 UTC) for the given timestamp `ts`.",
        ts
    ));
    export_functions!((
        unix_millis,
        "Returns the number of milliseconds since epoch (1970-01-01 00:00:00 UTC) for the given timestamp `ts`.",
        ts
    ));
    export_functions!((
        unix_seconds,
        "Returns the number of seconds since epoch (1970-01-01 00:00:00 UTC) for the given timestamp `ts`.",
        ts
    ));
    export_functions!((
        dayname,
        "Returns the three-letter abbreviated day name from the given date.",
        arg1
    ));
}

pub fn functions() -> Vec<Arc<ScalarUDF>> {
    vec![
        add_months(),
        date_add(),
        date_diff(),
        date_part(),
        date_sub(),
        date_trunc(),
        from_utc_timestamp(),
        hour(),
        last_day(),
        make_dt_interval(),
        make_interval(),
        minute(),
        next_day(),
        second(),
        time_trunc(),
        to_utc_timestamp(),
        trunc(),
        unix_date(),
        unix_micros(),
        unix_millis(),
        unix_seconds(),
        dayname(),
    ]
}