arrow-udf 0.9.0

User-defined function framework for arrow-rs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

// Copyright 2024 RisingWave Labs
//
// Licensed 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.

//! Data types for user-defined functions.

use arrow_array::builder::StructBuilder;
use arrow_schema::Fields;
pub use arrow_udf_macros::StructType;

// re-export common types
pub use chrono;
#[doc(no_inline)]
pub use chrono::{NaiveDate, NaiveDateTime, NaiveTime};
pub use rust_decimal;
#[doc(no_inline)]
pub use rust_decimal::Decimal;
pub use serde_json;

/// Interval type.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Interval {
    pub months: i32,
    pub days: i32,
    pub nanos: i64,
}

/// A trait for user-defined struct types.
///
/// This trait can be automatically derived with [`#[derive(StructType)]`](derive@StructType).
pub trait StructType {
    /// Returns the fields of the struct type.
    fn fields() -> Fields;
    /// Appends the struct value to the builder.
    fn append_to(self, builder: &mut StructBuilder);
    /// Appends a null value to the builder.
    fn append_null(builder: &mut StructBuilder);
}