vortex-array 0.68.0

Vortex in memory columnar data format
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

use std::fmt;
use std::fmt::Display;
use std::fmt::Formatter;

use vortex_error::VortexResult;
use vortex_error::vortex_bail;
use vortex_session::VortexSession;

use crate::ArrayRef;
use crate::ExecutionCtx;
use crate::dtype::DType;
use crate::dtype::Nullability;
use crate::expr::Expression;
use crate::scalar_fn::Arity;
use crate::scalar_fn::ChildName;
use crate::scalar_fn::ExecutionArgs;
use crate::scalar_fn::ScalarFn;
use crate::scalar_fn::ScalarFnId;
use crate::scalar_fn::ScalarFnRef;
use crate::scalar_fn::ScalarFnVTable;

/// Options payload for a foreign scalar function.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct ForeignScalarFnOptions {
    metadata: Vec<u8>,
    arity: usize,
}

impl ForeignScalarFnOptions {
    pub fn new(metadata: Vec<u8>, arity: usize) -> Self {
        Self { metadata, arity }
    }
}

impl Display for ForeignScalarFnOptions {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "foreign(arity={}, metadata={}B)",
            self.arity,
            self.metadata.len()
        )
    }
}

/// Scalar function placeholder used when deserializing an unknown scalar function ID.
#[derive(Clone, Debug)]
pub struct ForeignScalarFnVTable {
    id: ScalarFnId,
}

impl ForeignScalarFnVTable {
    pub fn new(id: ScalarFnId) -> Self {
        Self { id }
    }

    pub fn make_scalar_fn(id: ScalarFnId, metadata: Vec<u8>, arity: usize) -> ScalarFnRef {
        ScalarFn::new(Self::new(id), ForeignScalarFnOptions::new(metadata, arity)).erased()
    }
}

impl ScalarFnVTable for ForeignScalarFnVTable {
    type Options = ForeignScalarFnOptions;

    fn id(&self) -> ScalarFnId {
        self.id.clone()
    }

    fn serialize(&self, options: &Self::Options) -> VortexResult<Option<Vec<u8>>> {
        Ok(Some(options.metadata.clone()))
    }

    fn deserialize(
        &self,
        metadata: &[u8],
        _session: &VortexSession,
    ) -> VortexResult<Self::Options> {
        Ok(ForeignScalarFnOptions::new(metadata.to_vec(), 0))
    }

    fn arity(&self, options: &Self::Options) -> Arity {
        Arity::Exact(options.arity)
    }

    fn child_name(&self, _options: &Self::Options, child_idx: usize) -> ChildName {
        ChildName::new_arc(format!("arg{child_idx}").into())
    }

    fn fmt_sql(
        &self,
        _options: &Self::Options,
        expr: &Expression,
        f: &mut Formatter<'_>,
    ) -> fmt::Result {
        write!(f, "{}(", self.id)?;
        for i in 0..expr.children().len() {
            if i > 0 {
                write!(f, ", ")?;
            }
            expr.child(i).fmt_sql(f)?;
        }
        write!(f, ")")
    }

    fn return_dtype(&self, _options: &Self::Options, _args: &[DType]) -> VortexResult<DType> {
        Ok(DType::Variant(Nullability::Nullable))
    }

    fn execute(
        &self,
        _options: &Self::Options,
        _args: &dyn ExecutionArgs,
        _ctx: &mut ExecutionCtx,
    ) -> VortexResult<ArrayRef> {
        vortex_bail!("Cannot execute unknown scalar function '{}'", self.id);
    }
}