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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

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

//! Retained query revisions and SQL runtime controls for native phrase execution.

use super::{
    operator_execution_error, DriverResult, PhysicalRetrievalDriver, PostingList, SQLError,
    ScoredEntry, TextScoringMode,
};
use uqa_core::memory::{Budgeted, BudgetedVec};
use uqa_operators::phrase::{score_phrase_budgeted, PhraseBudget, PhraseError};
use uqa_scoring::{BM25Params, ScoringMode};

impl PhysicalRetrievalDriver<'_> {
    pub(super) fn execute_phrase(
        &self,
        query: &str,
        field: Option<&str>,
        scoring: Option<TextScoringMode>,
    ) -> DriverResult<PostingList> {
        self.execute_phrase_counted(query, field, scoring)
            .map(|(rows, _)| rows)
    }

    pub(super) fn execute_phrase_counted(
        &self,
        query: &str,
        field: Option<&str>,
        scoring: Option<TextScoringMode>,
    ) -> DriverResult<(PostingList, usize)> {
        let scoring = scoring.ok_or_else(|| {
            SQLError::Internal("phrase reached execution without bound text scoring".into())
        })?;
        if field.is_none()
            && matches!(
                scoring,
                TextScoringMode::CustomBM25(_) | TextScoringMode::CustomBayesianBM25(_)
            )
        {
            return Err(SQLError::TypeMismatch(
                "explicit text scoring parameters require one concrete field".into(),
            ));
        }
        let fields = match field {
            Some(field) => vec![field.to_owned()],
            None => self.context.text.fts_fields_for_table(self.table)?,
        };
        if fields.is_empty() {
            return Err(SQLError::TypeMismatch(format!(
                "text search: table `{}` has no text-indexed columns",
                self.table
            )));
        }
        let mut query_units = 0;
        let runtime = self.context.runtime;
        let budget = PhraseBudget::new(runtime.work_mem_bytes()?, runtime.cancellation);
        let mut rows = BudgetedVec::new(budget.memory());
        for field in fields {
            self.context
                .text
                .validate_text_search_field(self.table, &field)?;
            let mode = match scoring {
                TextScoringMode::BM25 => ScoringMode::BM25(BM25Params::default()),
                TextScoringMode::BayesianBM25 => {
                    ScoringMode::BayesianBM25(self.bayesian_params_for(&field)?)
                }
                TextScoringMode::CustomBM25(params) => ScoringMode::BM25(params),
                TextScoringMode::CustomBayesianBM25(params) => ScoringMode::BayesianBM25(params),
            };
            let (matches, units) = self.phrase_field(query, &field, &mode, &budget)?;
            query_units = query_units.max(units);
            budget
                .append_results(&mut rows, matches)
                .map_err(phrase_sql_error)?;
        }
        budget
            .finish_postings(rows)
            .map(|rows| (rows.into_parts().0, query_units))
            .map_err(phrase_sql_error)
    }

    fn phrase_field(
        &self,
        query: &str,
        field: &str,
        mode: &ScoringMode,
        budget: &PhraseBudget<'_>,
    ) -> DriverResult<(Budgeted<Vec<ScoredEntry>>, usize)> {
        budget.check_cancelled().map_err(phrase_sql_error)?;
        let state = self
            .context
            .indexes
            .query_table_indexes(self.table)
            .map_err(|error| operator_execution_error("resolve phrase index", error))?
            .ok_or_else(|| SQLError::UnknownTable(self.table.into()))?;
        let index = state.inverted_index();
        let index = index.as_ref().as_ref();
        let revision = index
            .search_analyzer_revision(field)
            .map_err(|error| operator_execution_error("resolve phrase analyzer revision", error))?;
        let graph = uqa_storage::inverted_index::analyze_query_graph_budgeted(
            &revision,
            query,
            budget.memory(),
            || {
                budget
                    .cancellation()
                    .check()
                    .map_err(|_| uqa_analysis::AnalysisError::Cancelled)
            },
        )
        .map_err(|error| phrase_sql_error(PhraseError::Storage(error)))?;
        score_phrase_budgeted(index, field, &graph, mode, budget)
            .map(|rows| (rows, graph.len()))
            .map_err(phrase_sql_error)
    }
}

fn phrase_sql_error(error: PhraseError) -> SQLError {
    match error {
        PhraseError::Storage(uqa_storage::StorageBackendError::Analysis(
            uqa_analysis::AnalysisError::Cancelled,
        )) => SQLError::Cancelled(uqa_core::QueryCancelled),
        PhraseError::Storage(uqa_storage::StorageBackendError::Analysis(
            uqa_analysis::AnalysisError::Memory(error),
        )) => phrase_sql_error(error.into()),
        PhraseError::Cancelled(error) => SQLError::Cancelled(error),
        error @ (PhraseError::MemoryLimit { .. }
        | PhraseError::Allocation(_)
        | PhraseError::Memory(_)) => SQLError::Routine {
            sqlstate: "53200".into(),
            message: error.to_string(),
        },
        PhraseError::Scoring(uqa_scoring::TextSearchError::Parameters(error)) => {
            SQLError::Routine {
                sqlstate: "22023".into(),
                message: error.to_string(),
            }
        }
        error => operator_execution_error("phrase", error),
    }
}