uqa-sql 0.5.4

PostgreSQL-compatible SQL compiler built on libpg_query
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

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

//! Report collation conflicts only after the containing query has completed type analysis.

use crate::catalog::collations::derivation::Derivation;
use crate::plan::{CommandPlan, QueryPlan, RelationalPlan};
use crate::{SQLError, ScalarExpr};
use std::{collections::BTreeMap, ptr::NonNull};

/// Only conflicting inputs retain diagnostic metadata. Addresses identify borrowed syntax and are never dereferenced or retained in an executable plan.
#[derive(Default)]
pub(in crate::binding) struct PendingCollations(BTreeMap<NonNull<ScalarExpr>, Derivation>);

impl PendingCollations {
    pub(in crate::binding) fn append(&mut self, mut other: Self) {
        self.0.append(&mut other.0);
    }
    pub(super) fn record(&mut self, expression: &ScalarExpr, selected: Derivation) {
        if selected.error_only() != Derivation::None {
            self.0.insert(NonNull::from(expression), selected);
        }
    }

    pub(super) fn record_target(&mut self, expression: &ScalarExpr, selected: Derivation) {
        if matches!(selected, Derivation::Conflict(..)) {
            self.0.entry(NonNull::from(expression)).or_insert(selected);
        }
    }

    pub(super) fn indeterminate_target(&self, expression: &ScalarExpr) -> bool {
        matches!(
            self.0.get(&NonNull::from(expression)),
            Some(Derivation::Conflict(..) | Derivation::InvalidImplicit(..))
        )
    }

    pub(super) fn require_key(&mut self, expression: &ScalarExpr, selected: Derivation) {
        self.record(expression, selected.key());
    }

    pub(super) fn require_key_at(&mut self, expression: NonNull<ScalarExpr>) {
        if let Some(selected) = self.0.get_mut(&expression) {
            *selected = selected.key();
        }
    }

    pub(in crate::binding) fn validate_expression(
        &self,
        expression: &ScalarExpr,
    ) -> Result<(), SQLError> {
        if self.0.is_empty() {
            return Ok(());
        }
        let mut result = Ok(());
        expression.visit(&mut |node| {
            if result.is_ok() {
                if let Some(selected) = self.0.get(&NonNull::from(node)) {
                    result = selected.validate();
                }
            }
        });
        result
    }

    pub(in crate::binding) fn validate_query(&self, query: &QueryPlan) -> Result<(), SQLError> {
        if self.0.is_empty() {
            return Ok(());
        }
        if let RelationalPlan::QueryBlock(block) = &query.root {
            // PostgreSQL assigns the target list (including clause-added target entries) before the join tree and its qualifications.
            for expression in block
                .projections
                .iter()
                .map(|p| &p.expr)
                .chain(block.order_by.iter().map(|o| &o.expr))
                .chain(block.group_by.iter())
                .chain(block.grouping_sets.iter().flatten())
                .chain(block.distinct_on.iter())
            {
                self.validate_expression(expression)?;
            }
            for window in &block.windows {
                for expression in window.spec.expressions() {
                    self.validate_expression(expression)?;
                }
            }
            if let Some(source) = &block.from {
                let mut result = Ok(());
                source.visit_scalar_expressions(&mut |expression| {
                    if result.is_ok() {
                        result = self.validate_expression(expression);
                    }
                });
                result?;
            }
            for expression in block
                .r#where
                .iter()
                .chain(block.having.iter())
                .chain(block.offset.iter())
                .chain(block.limit.iter())
            {
                self.validate_expression(expression)?;
            }
            return Ok(());
        }
        let mut result = Ok(());
        query.visit_scalar_expressions(&mut |expression| {
            if result.is_ok() {
                result = self.validate_expression(expression);
            }
        });
        result
    }

    pub(super) fn validate_command(&self, command: &CommandPlan) -> Result<(), SQLError> {
        if self.0.is_empty() {
            return Ok(());
        }
        let mut result = Ok(());
        command.visit_scalar_expressions(&mut |expression| {
            if result.is_ok() {
                result = self.validate_expression(expression);
            }
        });
        result
    }
}