hawdb-executor 0.14.0

An embedded Rust graph database for local data-plane workloads
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
121
122
123
124
125
126
127
128
129
130
131

// Copyright 2026 Nowledge
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Storage-neutral inputs for one executor invocation.

use crate::result_delivery::OutputLimits;
use crate::ExecutionMemoryConfig;
use hawdb_core::{RuntimeTaskContext, Value};
use hawdb_plan_cypher::PhysicalPlan;
use std::collections::BTreeMap;

#[derive(Clone, Copy)]
pub struct ExecutionRequest<'a> {
    plan: &'a PhysicalPlan,
    parameters: &'a BTreeMap<String, Value>,
    output_limits: OutputLimits,
    memory: &'a ExecutionMemoryConfig,
    task_context: Option<&'a RuntimeTaskContext>,
    host_scorer: Option<&'a dyn crate::scoring::HostScorerProvider>,
}

impl<'a> ExecutionRequest<'a> {
    pub fn new(
        plan: &'a PhysicalPlan,
        parameters: &'a BTreeMap<String, Value>,
        memory: &'a ExecutionMemoryConfig,
    ) -> Self {
        Self {
            plan,
            parameters,
            output_limits: OutputLimits::default(),
            memory,
            task_context: None,
            host_scorer: None,
        }
    }

    pub fn with_output_limits(
        mut self,
        max_rows: Option<usize>,
        max_payload_bytes: Option<usize>,
    ) -> Self {
        self.output_limits = OutputLimits {
            max_rows,
            max_payload_bytes,
        };
        self
    }

    pub fn with_optional_task_context(
        mut self,
        task_context: Option<&'a RuntimeTaskContext>,
    ) -> Self {
        self.task_context = task_context;
        self
    }

    pub fn with_task_context(mut self, task_context: &'a RuntimeTaskContext) -> Self {
        self.task_context = Some(task_context);
        self
    }

    pub fn plan(self) -> &'a PhysicalPlan {
        self.plan
    }

    pub fn parameters(self) -> &'a BTreeMap<String, Value> {
        self.parameters
    }

    pub fn output_limits(self) -> OutputLimits {
        self.output_limits
    }

    pub fn memory(self) -> &'a ExecutionMemoryConfig {
        self.memory
    }

    pub fn task_context(self) -> Option<&'a RuntimeTaskContext> {
        self.task_context
    }

    #[doc(hidden)]
    pub fn with_optional_host_scorer(
        mut self,
        scorer: Option<&'a dyn crate::scoring::HostScorerProvider>,
    ) -> Self {
        self.host_scorer = scorer;
        self
    }

    #[doc(hidden)]
    pub fn host_scorer(self) -> Option<&'a dyn crate::scoring::HostScorerProvider> {
        self.host_scorer
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn request_preserves_storage_neutral_execution_inputs() {
        let plan = PhysicalPlan::EmptyExec;
        let parameters = BTreeMap::from([("limit".to_string(), Value::Int(7))]);
        let memory = ExecutionMemoryConfig::default();
        let task_context = RuntimeTaskContext::default();

        let request = ExecutionRequest::new(&plan, &parameters, &memory)
            .with_output_limits(Some(4), Some(1024))
            .with_task_context(&task_context);

        assert!(matches!(request.plan(), PhysicalPlan::EmptyExec));
        assert!(std::ptr::eq(request.parameters(), &parameters));
        assert_eq!(request.output_limits().max_rows, Some(4));
        assert_eq!(request.output_limits().max_payload_bytes, Some(1024));
        assert!(std::ptr::eq(request.memory(), &memory));
        assert!(std::ptr::eq(request.task_context().unwrap(), &task_context));
    }
}