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::{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 uses_directional_scan(&self) -> bool {
18        false
19    }
20
21    fn directional_scan_prepared(
22        &self,
23        _support: crate::BackwardScanSupport,
24    ) -> Result<(), SQLError> {
25        Ok(())
26    }
27
28    fn scan_direction(&self) -> crate::PhysicalScanDirection {
29        crate::PhysicalScanDirection::Forward
30    }
31
32    fn direction_exhausted(&self) -> Result<QueryConsumerControl, SQLError> {
33        Ok(QueryConsumerControl::Stop)
34    }
35
36    fn rewound(&self) -> Result<QueryConsumerControl, SQLError> {
37        Ok(QueryConsumerControl::Continue)
38    }
39}
40
41#[derive(Clone, Copy, PartialEq, Eq)]
42pub enum QueryConsumerControl {
43    Continue,
44    Stop,
45    Rewind,
46}
47
48#[derive(Clone)]
49pub enum QueryOutputMode<'a> {
50    Rows,
51    SharedSpill,
52    ExistsKeySet(Option<&'a dyn uqa_sql::expr::SQLValueCatalog>),
53    RowConsumer(std::rc::Rc<dyn QueryRowConsumer + 'a>),
54}