Skip to main content

uqa_sql/plan/
source_visit.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7//! Borrowed source traversal includes nested queries, CTEs and command inputs.
8
9use super::{
10    CommandPlan, CtePlan, CtePlanBody, QueryPlan, RelationalPlan, SourcePlan, UnifiedPlan,
11};
12
13impl UnifiedPlan {
14    pub fn visit_sources(&self, visit: &mut dyn FnMut(&SourcePlan)) {
15        match self {
16            Self::Query(query) => query.visit_sources(visit),
17            Self::Command(command) => visit_command(command, visit),
18        }
19    }
20}
21
22fn visit_ctes(ctes: &[CtePlan], visit: &mut dyn FnMut(&SourcePlan)) {
23    for cte in ctes {
24        match &cte.body {
25            CtePlanBody::Query(query) => query.visit_sources(visit),
26            CtePlanBody::Command(command) => visit_command(command, visit),
27        }
28    }
29}
30
31fn visit_command(command: &CommandPlan, visit: &mut dyn FnMut(&SourcePlan)) {
32    match command {
33        CommandPlan::CreateView { query, .. }
34        | CommandPlan::CreateTableAs { query, .. }
35        | CommandPlan::CreateMaterializedView { query, .. }
36        | CommandPlan::DeclareCursor { query, .. } => {
37            query.visit_sources(visit);
38            return;
39        }
40        CommandPlan::Explain { body, .. } | CommandPlan::Prepare { body, .. } => {
41            body.visit_sources(visit);
42            return;
43        }
44        CommandPlan::Execute { params, .. } | CommandPlan::Call { args: params, .. } => {
45            for input in params {
46                for query in &input.subqueries {
47                    query.visit_sources(visit);
48                }
49            }
50            return;
51        }
52        _ => {}
53    }
54    visit_ctes(command.ctes(), visit);
55    for query in command.query_inputs() {
56        query.visit_sources(visit);
57    }
58    if let Some(source) = command.source_input() {
59        visit_source(source, visit);
60    }
61}
62
63impl QueryPlan {
64    pub fn visit_sources(&self, visit: &mut dyn FnMut(&SourcePlan)) {
65        visit_ctes(&self.ctes, visit);
66        let subqueries = match &self.root {
67            RelationalPlan::QueryBlock(block) => {
68                if let Some(source) = &block.from {
69                    visit_source(source, visit);
70                }
71                &block.subqueries
72            }
73            RelationalPlan::SetOp {
74                left,
75                right,
76                subqueries,
77                ..
78            } => {
79                left.visit_sources(visit);
80                right.visit_sources(visit);
81                subqueries
82            }
83            RelationalPlan::Values { subqueries, .. } => subqueries,
84        };
85        for query in subqueries {
86            query.visit_sources(visit);
87        }
88    }
89}
90
91fn visit_source(source: &SourcePlan, visit: &mut dyn FnMut(&SourcePlan)) {
92    visit(source);
93    match source {
94        SourcePlan::Subquery { body, .. } => body.visit_sources(visit),
95        SourcePlan::Join { left, right, .. } => {
96            visit_source(left, visit);
97            visit_source(right, visit);
98        }
99        _ => {}
100    }
101}
102
103impl UnifiedPlan {
104    pub fn visit_sources_mut(&mut self, visit: &mut dyn FnMut(&mut SourcePlan)) {
105        match self {
106            Self::Query(query) => query.visit_sources_mut(visit),
107            Self::Command(command) => visit_command_mut(command, visit),
108        }
109    }
110}
111
112pub(super) fn visit_command_mut(command: &mut CommandPlan, visit: &mut dyn FnMut(&mut SourcePlan)) {
113    match command {
114        CommandPlan::CreateView { query, .. }
115        | CommandPlan::CreateTableAs { query, .. }
116        | CommandPlan::CreateMaterializedView { query, .. }
117        | CommandPlan::DeclareCursor { query, .. } => {
118            query.visit_sources_mut(visit);
119            return;
120        }
121        CommandPlan::Explain { body, .. } | CommandPlan::Prepare { body, .. } => {
122            body.visit_sources_mut(visit);
123            return;
124        }
125        CommandPlan::Execute { params, .. } | CommandPlan::Call { args: params, .. } => {
126            for input in params {
127                for query in &mut input.subqueries {
128                    query.visit_sources_mut(visit);
129                }
130            }
131            return;
132        }
133        _ => {}
134    }
135    if let Some(ctes) = command.ctes_mut() {
136        for cte in ctes {
137            match &mut cte.body {
138                CtePlanBody::Query(query) => query.visit_sources_mut(visit),
139                CtePlanBody::Command(command) => visit_command_mut(command, visit),
140            }
141        }
142    }
143    for query in command.query_inputs_mut() {
144        query.visit_sources_mut(visit);
145    }
146    if let Some(source) = command.source_input_mut() {
147        super::rewrite::visit_source(source, visit);
148    }
149}