vortex_array/scalar_fn/
session.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use std::any::Any;
5use std::sync::Arc;
6
7use vortex_session::SessionExt;
8use vortex_session::SessionGuard;
9use vortex_session::SessionVar;
10use vortex_session::registry::Registry;
11
12use crate::scalar_fn::ScalarFnPluginRef;
13use crate::scalar_fn::ScalarFnVTable;
14use crate::scalar_fn::fns::between::Between;
15use crate::scalar_fn::fns::binary::Binary;
16use crate::scalar_fn::fns::cast::Cast;
17use crate::scalar_fn::fns::ext_storage::ExtStorage;
18use crate::scalar_fn::fns::fill_null::FillNull;
19use crate::scalar_fn::fns::get_item::GetItem;
20use crate::scalar_fn::fns::is_not_null::IsNotNull;
21use crate::scalar_fn::fns::is_null::IsNull;
22use crate::scalar_fn::fns::like::Like;
23use crate::scalar_fn::fns::list_contains::ListContains;
24use crate::scalar_fn::fns::list_length::ListLength;
25use crate::scalar_fn::fns::literal::Literal;
26use crate::scalar_fn::fns::merge::Merge;
27use crate::scalar_fn::fns::not::Not;
28use crate::scalar_fn::fns::pack::Pack;
29use crate::scalar_fn::fns::root::Root;
30use crate::scalar_fn::fns::select::Select;
31use crate::scalar_fn::fns::stat::StatFn;
32use crate::scalar_fn::fns::variant_get::VariantGet;
33
34/// Registry of scalar function vtables.
35pub type ScalarFnRegistry = Registry<ScalarFnPluginRef>;
36
37/// Session state for scalar function vtables and rewrite rules.
38#[derive(Clone, Debug)]
39pub struct ScalarFnSession {
40    registry: ScalarFnRegistry,
41}
42
43impl ScalarFnSession {
44    pub fn registry(&self) -> &ScalarFnRegistry {
45        &self.registry
46    }
47
48    /// Register a scalar function vtable in the session, replacing any existing vtable with the same ID.
49    pub fn register<V: ScalarFnVTable>(&self, vtable: V) {
50        self.registry
51            .register(vtable.id(), Arc::new(vtable) as ScalarFnPluginRef);
52    }
53}
54
55impl Default for ScalarFnSession {
56    fn default() -> Self {
57        let this = Self {
58            registry: ScalarFnRegistry::default(),
59        };
60
61        // Register built-in expressions.
62        this.register(Between);
63        this.register(Binary);
64        this.register(Cast);
65        this.register(ExtStorage);
66        this.register(FillNull);
67        this.register(GetItem);
68        this.register(IsNotNull);
69        this.register(IsNull);
70        this.register(Like);
71        this.register(ListContains);
72        this.register(ListLength);
73        this.register(Literal);
74        this.register(Merge);
75        this.register(Not);
76        this.register(Pack);
77        this.register(Root);
78        this.register(Select);
79        this.register(StatFn);
80        this.register(VariantGet);
81
82        this
83    }
84}
85
86impl SessionVar for ScalarFnSession {
87    fn as_any(&self) -> &dyn Any {
88        self
89    }
90
91    fn as_any_mut(&mut self) -> &mut dyn Any {
92        self
93    }
94}
95
96/// Extension trait for accessing scalar function session data.
97pub trait ScalarFnSessionExt: SessionExt {
98    /// Returns the scalar function vtable registry.
99    fn scalar_fns(&self) -> SessionGuard<'_, ScalarFnSession> {
100        self.get::<ScalarFnSession>()
101    }
102}
103impl<S: SessionExt> ScalarFnSessionExt for S {}
vortex_array/scalar_fn/session.rs

vortex_array/scalar_fn/
session.rs
