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 super::PlanRef<'_> {
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
22impl UnifiedPlan {
23    pub fn visit_sources(&self, visit: &mut dyn FnMut(&SourcePlan)) {
24        match self {
25            Self::Query(query) => query.visit_sources(visit),
26            Self::Command(command) => visit_command(command, visit),
27        }
28    }
29}
30
31fn visit_ctes(ctes: &[CtePlan], visit: &mut dyn FnMut(&SourcePlan)) {
32    for cte in ctes {
33        match &cte.body {
34            CtePlanBody::Query(query) => query.visit_sources(visit),
35            CtePlanBody::Command(command) => visit_command(command, visit),
36        }
37    }
38}
39
40fn visit_command(command: &CommandPlan, visit: &mut dyn FnMut(&SourcePlan)) {
41    match command {
42        CommandPlan::CreateView { query, .. }
43        | CommandPlan::CreateTableAs { query, .. }
44        | CommandPlan::CreateMaterializedView { query, .. }
45        | CommandPlan::DeclareCursor { query, .. } => {
46            query.visit_sources(visit);
47            return;
48        }
49        CommandPlan::Explain { body, .. } | CommandPlan::Prepare { body, .. } => {
50            body.visit_sources(visit);
51            return;
52        }
53        CommandPlan::Execute { params, .. } | CommandPlan::Call { args: params, .. } => {
54            for input in params {
55                for query in &input.subqueries {
56                    query.visit_sources(visit);
57                }
58            }
59            return;
60        }
61        _ => {}
62    }
63    visit_ctes(command.ctes(), visit);
64    for query in command.query_inputs() {
65        query.visit_sources(visit);
66    }
67    if let Some(source) = command.source_input() {
68        visit_source(source, visit);
69    }
70}
71
72impl QueryPlan {
73    pub fn visit_sources(&self, visit: &mut dyn FnMut(&SourcePlan)) {
74        visit_ctes(&self.ctes, visit);
75        let subqueries = match &self.root {
76            RelationalPlan::QueryBlock(block) => {
77                if let Some(source) = &block.from {
78                    visit_source(source, visit);
79                }
80                &block.subqueries
81            }
82            RelationalPlan::SetOp {
83                left,
84                right,
85                subqueries,
86                ..
87            } => {
88                left.visit_sources(visit);
89                right.visit_sources(visit);
90                subqueries
91            }
92            RelationalPlan::Values { subqueries, .. } => subqueries,
93        };
94        for query in subqueries {
95            query.visit_sources(visit);
96        }
97    }
98}
99
100fn visit_source(source: &SourcePlan, visit: &mut dyn FnMut(&SourcePlan)) {
101    visit(source);
102    match source {
103        SourcePlan::Subquery { body, .. } => body.visit_sources(visit),
104        SourcePlan::Join { left, right, .. } => {
105            visit_source(left, visit);
106            visit_source(right, visit);
107        }
108        _ => {}
109    }
110}
111
112impl UnifiedPlan {
113    pub fn visit_sources_mut(&mut self, visit: &mut dyn FnMut(&mut SourcePlan)) {
114        match self {
115            Self::Query(query) => query.visit_sources_mut(visit),
116            Self::Command(command) => visit_command_mut(command, visit),
117        }
118    }
119}
120
121pub(super) fn visit_command_mut(command: &mut CommandPlan, visit: &mut dyn FnMut(&mut SourcePlan)) {
122    match command {
123        CommandPlan::CreateView { query, .. }
124        | CommandPlan::CreateTableAs { query, .. }
125        | CommandPlan::CreateMaterializedView { query, .. }
126        | CommandPlan::DeclareCursor { query, .. } => {
127            query.visit_sources_mut(visit);
128            return;
129        }
130        CommandPlan::Explain { body, .. } | CommandPlan::Prepare { body, .. } => {
131            body.visit_sources_mut(visit);
132            return;
133        }
134        CommandPlan::Execute { params, .. } | CommandPlan::Call { args: params, .. } => {
135            for input in params {
136                for query in &mut input.subqueries {
137                    query.visit_sources_mut(visit);
138                }
139            }
140            return;
141        }
142        _ => {}
143    }
144    if let Some(ctes) = command.ctes_mut() {
145        for cte in ctes {
146            match &mut cte.body {
147                CtePlanBody::Query(query) => query.visit_sources_mut(visit),
148                CtePlanBody::Command(command) => visit_command_mut(command, visit),
149            }
150        }
151    }
152    for query in command.query_inputs_mut() {
153        query.visit_sources_mut(visit);
154    }
155    if let Some(source) = command.source_input_mut() {
156        super::rewrite::visit_source(source, visit);
157    }
158}