Skip to main content

uqa_execution/query/
consumer.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7//! Row-delivery and directional-control protocol for physical query execution.
8
9use crate::{Batch, OwnedPhysicalRow, RowSchema};
10use uqa_sql::SQLError;
11
12pub trait QueryRowConsumer {
13    fn begin(&self, columns: &[String], schema: &RowSchema) -> Result<(), SQLError>;
14
15    fn consume(&self, row: OwnedPhysicalRow) -> Result<QueryConsumerControl, SQLError>;
16
17    fn consume_batch(&self, batch: Batch) -> Result<QueryConsumerControl, SQLError> {
18        for row in batch.rows {
19            let control = self.consume(OwnedPhysicalRow::new(batch.schema.clone(), row))?;
20            if control != QueryConsumerControl::Continue {
21                return Ok(control);
22            }
23        }
24        Ok(QueryConsumerControl::Continue)
25    }
26
27    /// Whether UNION ALL may deliver directly from each child instead of its ordinary set operator.
28    fn streams_set_inputs(&self) -> bool {
29        true
30    }
31
32    fn uses_directional_scan(&self) -> bool {
33        false
34    }
35
36    fn directional_scan_prepared(
37        &self,
38        _support: crate::BackwardScanSupport,
39    ) -> Result<(), SQLError> {
40        Ok(())
41    }
42
43    fn scan_direction(&self) -> crate::PhysicalScanDirection {
44        crate::PhysicalScanDirection::Forward
45    }
46
47    fn direction_exhausted(&self) -> Result<QueryConsumerControl, SQLError> {
48        Ok(QueryConsumerControl::Stop)
49    }
50
51    fn rewound(&self) -> Result<QueryConsumerControl, SQLError> {
52        Ok(QueryConsumerControl::Continue)
53    }
54}
55
56#[derive(Clone, Copy, PartialEq, Eq)]
57pub enum QueryConsumerControl {
58    Continue,
59    Stop,
60    Rewind,
61}
62
63#[derive(Clone)]
64pub enum QueryOutputMode<'a> {
65    Rows,
66    SharedSpill,
67    ExistsKeySet(Option<&'a dyn uqa_sql::expr::SQLValueCatalog>),
68    RowConsumer(std::rc::Rc<dyn QueryRowConsumer + 'a>),
69}