uqa-execution 0.3.0

Volcano physical operators with row-batch pipelines
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
121
122

//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! Runtime services consumed by physical query operators and host callbacks.

use crate::functions::{
    RegisteredSQLFunction, SQLAggregateFunction, SQLFunctionOptions, SQLScalarFunction,
    SQLTableFunction,
};
use parking_lot::{Mutex, RwLock};
use std::collections::BTreeMap;
use uqa_core::CancellationToken;
use uqa_sql::SQLError;

/// Live memory settings are read at the same execution boundaries as the session setting.
pub trait QueryMemorySettings: Send + Sync {
    fn work_mem_bytes(&self) -> Result<usize, SQLError>;
}

/// Borrowed runtime services with no catalog mutation, transaction, or storage publication access.
#[derive(Clone, Copy)]
pub struct QueryRuntimeView<'a> {
    pub cancellation: &'a CancellationToken,
    pub settings: &'a dyn QueryMemorySettings,
    pub scalar_functions:
        &'a RwLock<BTreeMap<String, RegisteredSQLFunction<dyn SQLScalarFunction>>>,
    pub table_functions: &'a RwLock<BTreeMap<String, RegisteredSQLFunction<dyn SQLTableFunction>>>,
    pub aggregate_functions:
        &'a RwLock<BTreeMap<String, RegisteredSQLFunction<dyn SQLAggregateFunction>>>,
    pub notices: &'a Mutex<Vec<(String, String)>>,
}

impl QueryRuntimeView<'_> {
    pub fn check_cancelled(&self) -> Result<(), SQLError> {
        Ok(self.cancellation.check()?)
    }

    pub fn cancellation_token(&self) -> uqa_core::CancellationToken {
        self.cancellation.clone()
    }

    pub fn work_mem_bytes(&self) -> Result<usize, SQLError> {
        self.settings.work_mem_bytes()
    }

    pub fn lookup_scalar_function(
        &self,
        name: &str,
    ) -> Option<RegisteredSQLFunction<dyn SQLScalarFunction>> {
        self.scalar_functions
            .read()
            .get(&name.to_ascii_lowercase())
            .cloned()
    }

    pub fn has_scalar_functions(&self) -> bool {
        !self.scalar_functions.read().is_empty()
    }

    pub fn has_scalar_function(&self, name: &str) -> bool {
        self.scalar_functions
            .read()
            .contains_key(&name.to_ascii_lowercase())
    }

    pub fn lookup_table_function(
        &self,
        name: &str,
    ) -> Option<RegisteredSQLFunction<dyn SQLTableFunction>> {
        self.table_functions
            .read()
            .get(&name.to_ascii_lowercase())
            .cloned()
    }

    pub fn has_table_function(&self, name: &str) -> bool {
        self.table_functions
            .read()
            .contains_key(&name.to_ascii_lowercase())
    }

    pub fn lookup_aggregate_function(
        &self,
        name: &str,
    ) -> Option<RegisteredSQLFunction<dyn SQLAggregateFunction>> {
        self.aggregate_functions
            .read()
            .get(&name.to_ascii_lowercase())
            .cloned()
    }

    pub fn has_aggregate_function(&self, name: &str) -> bool {
        self.aggregate_functions
            .read()
            .contains_key(&name.to_ascii_lowercase())
    }

    pub fn registered_function_options(&self, name: &str) -> [Option<SQLFunctionOptions>; 3] {
        let name = name.to_ascii_lowercase();
        [
            self.scalar_functions
                .read()
                .get(&name)
                .map(|registration| registration.options),
            self.table_functions
                .read()
                .get(&name)
                .map(|registration| registration.options),
            self.aggregate_functions
                .read()
                .get(&name)
                .map(|registration| registration.options),
        ]
    }

    pub fn push_diagnostic(&self, level: impl Into<String>, message: impl Into<String>) {
        self.notices.lock().push((level.into(), message.into()));
    }
}