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

vortex_array/scalar_fn/
session.rs
