uqa_execution/query/
consumer.rs1use 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 collect_native_materialized(
17 &self,
18 _operator: &mut dyn crate::PhysicalOperator,
19 _cancellation: &uqa_core::CancellationToken,
20 ) -> crate::ExecResult<bool> {
21 Ok(false)
22 }
23
24 fn consume(&self, row: OwnedPhysicalRow) -> Result<QueryConsumerControl, SQLError>;
25
26 fn consume_batch(&self, batch: Batch) -> Result<QueryConsumerControl, SQLError> {
27 for row in batch.rows {
28 let control = self.consume(OwnedPhysicalRow::new(batch.schema.clone(), row))?;
29 if control != QueryConsumerControl::Continue {
30 return Ok(control);
31 }
32 }
33 Ok(QueryConsumerControl::Continue)
34 }
35
36 fn input_demand(&self) -> Option<std::num::NonZeroUsize> {
38 Some(crate::physical::demand::ONE)
39 }
40
41 fn streams_set_inputs(&self) -> bool {
43 true
44 }
45
46 fn uses_directional_scan(&self) -> bool {
47 false
48 }
49
50 fn directional_scan_prepared(
51 &self,
52 _support: crate::BackwardScanSupport,
53 ) -> Result<(), SQLError> {
54 Ok(())
55 }
56
57 fn scan_direction(&self) -> crate::PhysicalScanDirection {
58 crate::PhysicalScanDirection::Forward
59 }
60
61 fn direction_exhausted(&self) -> Result<QueryConsumerControl, SQLError> {
62 Ok(QueryConsumerControl::Stop)
63 }
64
65 fn rewound(&self) -> Result<QueryConsumerControl, SQLError> {
66 Ok(QueryConsumerControl::Continue)
67 }
68}
69
70#[derive(Clone, Copy, PartialEq, Eq)]
71pub enum QueryConsumerControl {
72 Continue,
73 Stop,
74 Rewind,
75}
76
77#[derive(Clone)]
78pub enum QueryOutputMode<'a> {
79 Rows,
80 SharedSpill,
81 ExistsKeySet(Option<&'a dyn uqa_sql::expr::SQLValueCatalog>),
82 RowConsumer(std::rc::Rc<dyn QueryRowConsumer + 'a>),
83}