uqa-execution 0.6.0

Volcano physical operators with row-batch pipelines
Documentation
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//
//! Demand-driven local and materialized table scans.

use super::TableScanContext;
use crate::query::{
    local_table::{
        table_lock_origin, HierarchyRowSource, LocalTableRowSource, LocalTableScanConfig,
    },
    CteScope,
};
use uqa_core::Value;
use uqa_sql::{
    plan::{
        source_projection::{ColumnPrune, QualifierFilters, SourceProjection},
        SourcePlan,
    },
    semantics::{
        source_filters::{has_filters_for_qualifier, qualifier_filter, qualifier_for},
        TABLE_OID_COLUMN, XMIN_COLUMN,
    },
    SQLError, SQLParam,
};
type StreamingLocalTableScan<'a> = (Box<dyn crate::PhysicalOperator + 'a>, bool);

#[expect(
    clippy::too_many_lines,
    reason = "preserves source schema and row identity"
)]
pub fn try_streaming_local_table_scan<'a, S: Clone>(
    context: TableScanContext<'_>,
    source: &SourcePlan,
    ctes: &CteScope<S>,
    prune: Option<&ColumnPrune>,
    filters: Option<&QualifierFilters>,
    params: &[SQLParam],
) -> Result<Option<StreamingLocalTableScan<'a>>, SQLError> {
    let SourcePlan::Table {
        name,
        qualifier,
        alias,
        column_aliases,
        bound_columns,
        include_descendants,
    } = source
    else {
        return Ok(None);
    };
    let qualifier = qualifier_for(qualifier, alias.as_deref());
    if let Some(materialized) = ctes.materialized_for_scan(name) {
        if has_filters_for_qualifier(filters, &qualifier) {
            return Ok(None);
        }
        let mapping = materialized
            .row_schema()
            .identities()
            .iter()
            .enumerate()
            .filter_map(|(position, identity)| {
                let source_column = identity.column();
                let column = column_aliases
                    .get(position)
                    .map_or(source_column, String::as_str);
                if prune
                    .and_then(|prune| prune.get(&qualifier))
                    .is_some_and(|wanted| !wanted.contains(column))
                {
                    return None;
                }
                let output_identity = crate::ColumnIdentity::qualified(&qualifier, column);
                Some((column.to_string(), output_identity, position))
            })
            .collect();
        let scan: Box<dyn crate::PhysicalOperator + 'a> =
            Box::new(crate::SharedSpillScan::new(materialized));
        let selection = crate::ColumnSelection::with_identities(scan, mapping);
        let selection = if ctes.lock_identities.emit {
            selection.rebinding_lock_origins(qualifier)
        } else {
            selection
        };
        return Ok(Some((Box::new(selection), false)));
    }
    let catalog = ctes.catalog_read_view()?;
    let resolution = ctes.relation_name_resolution()?;
    if catalog.view_resolved(&resolution, name)?.is_some()
        || catalog.foreign_table_resolved(&resolution, name)?.is_some()
    {
        return Ok(None);
    }
    let Some(root_name) = catalog.table_name_resolved(&resolution, name)? else {
        return Ok(None);
    };
    let root_table = catalog
        .table_resolved(&resolution, &root_name)?
        .ok_or_else(|| SQLError::UnknownTable(name.clone()))?;
    let wanted = prune.and_then(|prune| prune.get(&qualifier)).cloned();
    let metadata = wanted
        .as_ref()
        .map(SourceProjection::metadata)
        .unwrap_or_default();
    let table_columns = uqa_sql::semantics::bound_source_column_names(
        root_table
            .columns
            .iter()
            .map(|column| column.name.clone())
            .collect::<Vec<_>>(),
        bound_columns.as_deref(),
    )?;
    if column_aliases.len() > table_columns.len() {
        return Err(SQLError::Routine {
            sqlstate: "42P10".into(),
            message: format!(
                "table \"{qualifier}\" has {} columns available but {} columns specified",
                table_columns.len(),
                column_aliases.len()
            ),
        });
    }
    // The name a filter writes for each column of the table: its alias, or its own name.
    let visible_names = table_columns
        .iter()
        .enumerate()
        .map(|(position, physical)| {
            (
                physical.clone(),
                column_aliases
                    .get(position)
                    .cloned()
                    .unwrap_or_else(|| physical.clone()),
            )
        })
        .collect::<std::collections::BTreeMap<_, _>>();
    // An unqualified reference is conservatively requested from every FROM source during pruning. The scan schema must still describe only real table columns: advertising those over-inclusive requests as columns can make later joins bind an unqualified name to a non-existent value.
    let selected_columns = table_columns
        .into_iter()
        .enumerate()
        .filter_map(|(position, physical)| {
            let visible = column_aliases
                .get(position)
                .cloned()
                .unwrap_or_else(|| physical.clone());
            wanted
                .as_ref()
                .is_none_or(|wanted| wanted.contains(&visible))
                .then_some((physical, visible))
        })
        .collect::<Vec<_>>();
    let (mut columns, mut schema): (Vec<_>, Vec<_>) = selected_columns.into_iter().unzip();
    let include_table_oid = wanted
        .as_ref()
        .is_some_and(|wanted| wanted.contains(TABLE_OID_COLUMN));
    let include_xmin = wanted
        .as_ref()
        .is_some_and(|wanted| wanted.contains(XMIN_COLUMN));
    if include_xmin {
        columns.push(XMIN_COLUMN.into());
        schema.push(XMIN_COLUMN.into());
    }
    if include_table_oid {
        schema.push(TABLE_OID_COLUMN.into());
    }
    let mut physical_schema = projected_scan_schema(
        &qualifier,
        &columns,
        &schema,
        &root_table.columns,
        include_table_oid,
        root_table.catalog_oids.row_type_reference(
            &uqa_core::RelationIdentity::from_legacy_name(&root_name)
                .map_err(SQLError::Internal)?,
        ),
    )?;
    let metadata_relation = uqa_sql::ast::InternalRelationId::allocate();
    let mut metadata_attributes = Vec::with_capacity(2);
    if metadata.includes_doc_id() {
        metadata_attributes.push((
            metadata_relation.column(0),
            Some(uqa_sql::ast::ColumnType::BigInteger),
        ));
    }
    if metadata.includes_score() {
        metadata_attributes.push((
            metadata_relation.column(1),
            Some(uqa_sql::ast::ColumnType::DoublePrecision),
        ));
    }
    if !metadata_attributes.is_empty() {
        physical_schema =
            crate::RowSchema::append_internal_typed(&physical_schema, &metadata_attributes);
        let mut aliases = Vec::with_capacity(metadata_attributes.len() * 3);
        if metadata.includes_doc_id() {
            let column = metadata_relation.column(0);
            let slot = physical_schema
                .internal_slot(column)
                .expect("document metadata attribute must have a physical slot");
            let ty = Some(uqa_sql::ast::ColumnType::BigInteger);
            aliases.push((
                crate::ColumnIdentity::qualified(
                    uqa_sql::semantics::META_QUALIFIER,
                    uqa_sql::semantics::META_DOC_ID_COLUMN,
                ),
                slot,
                ty.clone(),
            ));
            if !physical_schema.has_qualified_column(&qualifier, uqa_sql::semantics::DOC_ID_COLUMN)
            {
                aliases.push((
                    crate::ColumnIdentity::qualified(&qualifier, uqa_sql::semantics::DOC_ID_COLUMN),
                    slot,
                    ty.clone(),
                ));
            }
            if !physical_schema.has_unqualified_column(uqa_sql::semantics::DOC_ID_COLUMN) {
                aliases.push((
                    crate::ColumnIdentity::unqualified(uqa_sql::semantics::DOC_ID_COLUMN),
                    slot,
                    ty,
                ));
            }
        }
        if metadata.includes_score() {
            let column = metadata_relation.column(1);
            let slot = physical_schema
                .internal_slot(column)
                .expect("score metadata attribute must have a physical slot");
            let ty = Some(uqa_sql::ast::ColumnType::DoublePrecision);
            aliases.push((
                crate::ColumnIdentity::qualified(
                    uqa_sql::semantics::META_QUALIFIER,
                    uqa_sql::semantics::META_SCORE_COLUMN,
                ),
                slot,
                ty.clone(),
            ));
            if !physical_schema.has_qualified_column(&qualifier, uqa_sql::semantics::SCORE_COLUMN) {
                aliases.push((
                    crate::ColumnIdentity::qualified(&qualifier, uqa_sql::semantics::SCORE_COLUMN),
                    slot,
                    ty.clone(),
                ));
            }
            if !physical_schema.has_unqualified_column(uqa_sql::semantics::SCORE_COLUMN) {
                aliases.push((
                    crate::ColumnIdentity::unqualified(uqa_sql::semantics::SCORE_COLUMN),
                    slot,
                    ty,
                ));
            }
        }
        physical_schema =
            crate::RowSchema::with_physical_identity_aliases(&physical_schema, &aliases);
    }
    let table_names = catalog.hierarchy_scan_tables(&resolution, name, *include_descendants)?;
    let mut sources = Vec::with_capacity(table_names.len());
    let mut filter_pushed = false;
    for table_name in table_names {
        let table = context.tables.table(&table_name)?;
        let column_definitions = catalog
            .table_resolved(&resolution, &table_name)?
            .ok_or_else(|| SQLError::UnknownTable(table_name.clone()))?
            .columns
            .clone();
        let lock_origin = table_lock_origin(
            &catalog,
            &resolution,
            &table_name,
            &qualifier,
            ctes.lock_identities.emit,
        )?;
        // Candidate selection and row evaluation must share the selected SQL operand types. A lossy column cast cannot use an index over the uncast values.
        let predicate_expression = qualifier_filter(filters, &qualifier)
            .map(|predicate| uqa_sql::bind_type_introspection(predicate, &physical_schema, params));
        let predicate = predicate_expression
            .as_ref()
            .filter(|predicate| !expression_references_tableoid(predicate))
            .map(|predicate| {
                crate::ProjectedPredicate::compile_bound(predicate, &physical_schema, params)
            })
            .transpose()?
            .flatten();
        filter_pushed |= predicate.is_some();
        let recheck_pins = lock_origin
            .as_ref()
            .and_then(|(origin_qualifier, storage_name)| {
                ctes.recheck_docs_for_scan(origin_qualifier, storage_name)
            });
        // A filter that names its rows by identity, or by an integer primary key whose values are the identities, reads only those rows, from storage or from the changes above it, instead of scanning the table.
        let mut candidates = if recheck_pins.is_none() {
            predicate_expression.as_ref().and_then(|filter| {
                crate::query::key_candidates::key_candidates(
                    filter,
                    params,
                    crate::query::key_candidates::IdentityColumns::new(
                        &column_definitions,
                        table.maps_integer_keys(),
                        |name| visible_names.get(name).map_or(name, String::as_str),
                    ),
                )
            })
        } else {
            None
        };
        if candidates.is_none() && recheck_pins.is_none() {
            if let Some(filter) = &predicate_expression {
                candidates = crate::query::index_candidates::IndexCandidates {
                    reads: context.tables,
                    table: &table_name,
                    columns: &column_definitions,
                    visible: &|name| {
                        visible_names
                            .get(name)
                            .cloned()
                            .unwrap_or_else(|| name.to_owned())
                    },
                    params,
                    command_visible: ctes.reads_command_overlay(),
                    cancellation: &context.runtime.cancellation_token(),
                }
                .select(filter)?;
            }
        }
        let command_changes = if ctes.reads_command_overlay() {
            context.tables.command_overlay_changes(&table_name)?
        } else {
            None
        };
        let estimated_cardinality = match &candidates {
            Some(candidates) => u64::try_from(candidates.len()).unwrap_or(u64::MAX),
            None => context.tables.table_row_estimate(&table_name)?,
        };
        let table_oid = include_table_oid
            .then(|| {
                crate::catalog::projection::snapshot_table_relation_oid(
                    &catalog,
                    &resolution,
                    &table_name,
                )
            })
            .transpose()?
            .map(Value::Int);
        sources.push(LocalTableRowSource::new(LocalTableScanConfig {
            cancellation: context.runtime.cancellation_token(),
            serializable: context.tables.serializable_read(&table_name)?,
            table_name,
            table,
            column_definitions,
            columns: columns.clone(),
            schema: schema.clone(),
            physical_schema: physical_schema.clone(),
            metadata,
            table_oid,
            predicate,
            estimated_cardinality,
            lock_origin,
            recheck_pins,
            candidates: candidates.map(std::sync::Arc::from),
            command_changes,
        }));
    }
    let source: Box<dyn crate::RowSource> = if sources.len() == 1 {
        Box::new(
            sources
                .pop()
                .ok_or_else(|| SQLError::Internal("single-table scan lost its source".into()))?,
        )
    } else {
        Box::new(HierarchyRowSource::new(sources)?)
    };
    Ok(Some((
        Box::new(crate::TableScan::new(source)),
        filter_pushed,
    )))
}

fn expression_references_tableoid(expression: &crate::ScalarExpr) -> bool {
    let mut columns = std::collections::BTreeSet::new();
    expression.collect_columns(&mut columns) && columns.contains(TABLE_OID_COLUMN)
}

/// Keep a scan's selected stored fields, public aliases and system-column metadata in one positional layout.
fn projected_scan_schema(
    qualifier: &str,
    columns: &[String],
    visible: &[String],
    definitions: &[uqa_sql::ast::ColumnDef],
    include_table_oid: bool,
    row_type: Option<uqa_sql::ast::CompositeTypeReference>,
) -> Result<crate::RowSchema, SQLError> {
    let column_metadata = columns.iter().zip(visible).map(|(column, visible)| {
        let definition = definitions
            .iter()
            .find(|definition| definition.name == *column);
        (
            visible.clone(),
            definition
                .map(|definition| definition.ty.clone())
                .or_else(|| (column == XMIN_COLUMN).then_some(uqa_sql::ast::ColumnType::Xid)),
            definition.and_then(|definition| definition.collation_oid),
        )
    });
    let table_oid = include_table_oid.then(|| {
        (
            TABLE_OID_COLUMN.to_string(),
            Some(uqa_sql::ast::ColumnType::Oid),
            None,
        )
    });
    let mut physical_schema =
        crate::RowSchema::with_column_metadata(Some(qualifier), column_metadata.chain(table_oid));
    // System columns are addressable by name but never expand into `*` or a whole-row value.
    let system_positions = visible
        .iter()
        .enumerate()
        .filter_map(|(position, column)| {
            (column == XMIN_COLUMN || column == TABLE_OID_COLUMN).then_some(position)
        })
        .collect::<Vec<_>>();
    if !system_positions.is_empty() {
        physical_schema =
            crate::RowSchema::with_wildcard_hidden_positions(&physical_schema, system_positions);
    }
    if let Some(row_type) = row_type {
        physical_schema = physical_schema
            .with_relation_row_type(qualifier, uqa_sql::ast::ColumnType::Composite(row_type))?;
    }
    Ok(physical_schema)
}

#[cfg(test)]
mod tests;