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

vortex_array/scalar_fn/
session.rs
