Skip to main content

uqa_sql/semantics/parameters/
explain.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7//! Select only planning parameters and admit their displayed values without a complete settings snapshot.
8
9use super::{
10    catalog::parameter_definitions,
11    definition::{ParameterDefinition, ParameterFlags},
12    value::show_setting_with_control,
13};
14use crate::SQLError;
15use uqa_core::memory::{Produced, ProductionControl, ProductionVec};
16
17#[cfg(test)]
18mod tests;
19
20pub type ExplainSettings = Vec<(&'static str, String)>;
21pub type ParameterRead<'a> = dyn Fn(
22        &'static ParameterDefinition,
23        &ProductionControl<'_>,
24    ) -> Result<Option<Produced<String>>, SQLError>
25    + 'a;
26
27pub fn capture(
28    read: &ParameterRead<'_>,
29    control: &ProductionControl<'_>,
30) -> Result<Produced<ExplainSettings>, SQLError> {
31    let mut output = ProductionVec::new(*control);
32    for definition in parameter_definitions()
33        .iter()
34        .filter(|definition| definition.has_flag(ParameterFlags::EXPLAIN))
35    {
36        control.check()?;
37        let Some(setting) = read(definition, control)? else {
38            continue;
39        };
40        if setting.as_str() == definition.boot_setting_with_control(control)?.as_str() {
41            continue;
42        }
43        let shown = show_setting_with_control(definition, &setting, control)?;
44        let (shown, memory) = shown.into_parts();
45        output.push_produced(control.finish((definition.name, shown), memory)?)?;
46    }
47    Ok(output.finish()?)
48}