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
use std::collections::HashMap;
use std::collections::HashSet;
use std::iter::FromIterator;
use std::string::String;

use itertools::join;

use crate::*;

macro_rules! cast {
    ($target: expr, $pat: path) => {{
        if let $pat(a) = $target {
            // #1
            a
        } else {
            panic!("mismatch variant when cast to {}", stringify!($pat)); // #2
        }
    }};
}

impl protobuf::ParseResult {
    pub fn deparse(&self) -> Result<String> {
        crate::deparse(self)
    }

    // Note: this doesn't iterate over every possible node type, since we only care about a subset of nodes.
    pub fn nodes(&self) -> Vec<(NodeRef, i32, Context)> {
        self.stmts
            .iter()
            .filter_map(|s|
            // RawStmt  ->  Node   ->    NodeEnum           ->              NodeRef
            s.stmt.as_ref().and_then(|s| s.node.as_ref()).map(|n| n.nodes()))
            .flatten()
            .collect()
    }

    /// Returns a mutable reference to nested nodes.
    ///
    /// # Safety
    ///
    /// The caller may have to deal with dangling pointers, and passing an
    /// invalid tree back to libpg_query may cause it to panic.
    pub unsafe fn nodes_mut(&mut self) -> Vec<(NodeMut, i32, Context)> {
        self.stmts
            .iter_mut()
            .filter_map(|s|
            // RawStmt  ->  Node   ->    NodeEnum           ->              NodeMut
            s.stmt.as_mut().and_then(|s| s.node.as_mut()).map(|n| n.nodes_mut()))
            .flatten()
            .collect()
    }
}

pub struct ParseResult {
    pub protobuf: protobuf::ParseResult,
    pub warnings: Vec<String>,
    tables: Vec<(String, Context)>,
    pub aliases: HashMap<String, String>,
    pub cte_names: Vec<String>,
    functions: Vec<(String, Context)>,
}

impl ParseResult {
    pub fn new(protobuf: protobuf::ParseResult, stderr: String) -> Self {
        let warnings = stderr.lines().filter_map(|l| if l.starts_with("WARNING") { Some(l.trim().into()) } else { None }).collect();
        let mut tables: HashSet<(String, Context)> = HashSet::new();
        let mut aliases: HashMap<String, String> = HashMap::new();
        let mut cte_names: HashSet<String> = HashSet::new();
        let mut functions: HashSet<(String, Context)> = HashSet::new();

        for (node, _depth, context) in protobuf.nodes().into_iter() {
            match node {
                NodeRef::CommonTableExpr(s) => {
                    cte_names.insert(s.ctename.to_owned());
                }
                NodeRef::RangeVar(v) => {
                    // TODO: this incorrectly returns no tables: parse('with f as (select * from f limit 1) select * from f')
                    let table = if !v.schemaname.is_empty() { format!("{}.{}", v.schemaname, v.relname) } else { v.relname.to_owned() };
                    if cte_names.contains(&table) {
                        continue;
                    }
                    tables.insert((table.to_owned(), context));
                    v.alias.as_ref().and_then(|alias| aliases.insert(alias.aliasname.to_owned(), table));
                }
                NodeRef::FuncCall(c) => {
                    let funcname = join(c.funcname.iter().filter_map(|n| n.node.as_ref().map(|n| &cast!(n, NodeEnum::String).sval)), ".");
                    functions.insert((funcname, Context::Call));
                }
                NodeRef::DropStmt(s) => {
                    match protobuf::ObjectType::from_i32(s.remove_type) {
                        Some(protobuf::ObjectType::ObjectTable) => {
                            for o in &s.objects {
                                if let Some(NodeEnum::List(list)) = &o.node {
                                    let table =
                                        join(list.items.iter().filter_map(|i| i.node.as_ref().map(|n| &cast!(n, NodeEnum::String).sval)), ".");
                                    tables.insert((table, Context::DDL));
                                };
                            }
                        }
                        Some(protobuf::ObjectType::ObjectRule) | Some(protobuf::ObjectType::ObjectTrigger) => {
                            for o in &s.objects {
                                if let Some(NodeEnum::List(list)) = &o.node {
                                    // Unlike ObjectTable, this ignores the last string (the rule/trigger name)
                                    let table = join(
                                        list.items[0..list.items.len() - 1]
                                            .iter()
                                            .filter_map(|i| i.node.as_ref().map(|n| &cast!(n, NodeEnum::String).sval)),
                                        ".",
                                    );
                                    tables.insert((table, Context::DDL));
                                };
                            }
                        }
                        Some(protobuf::ObjectType::ObjectFunction) => {
                            // Only one function can be dropped in a statement
                            if let Some(NodeEnum::ObjectWithArgs(object)) = &s.objects[0].node {
                                if let Some(NodeEnum::String(string)) = &object.objname[0].node {
                                    functions.insert((string.sval.to_string(), Context::DDL));
                                }
                            }
                        }
                        _ => (),
                    }
                }
                NodeRef::CreateFunctionStmt(s) => {
                    if let Some(NodeEnum::String(string)) = &s.funcname[0].node {
                        functions.insert((string.sval.to_string(), Context::DDL));
                    }
                }
                NodeRef::RenameStmt(s) => {
                    if let Some(protobuf::ObjectType::ObjectFunction) = protobuf::ObjectType::from_i32(s.rename_type) {
                        if let Some(object) = &s.object {
                            if let Some(NodeEnum::ObjectWithArgs(object)) = &object.node {
                                if let Some(NodeEnum::String(string)) = &object.objname[0].node {
                                    functions.insert((string.sval.to_string(), Context::DDL));
                                    functions.insert((s.newname.to_string(), Context::DDL));
                                }
                            }
                        }
                    }
                }
                _ => (),
            }
        }

        Self {
            protobuf,
            warnings,
            tables: Vec::from_iter(tables),
            aliases,
            cte_names: Vec::from_iter(cte_names),
            functions: Vec::from_iter(functions),
        }
    }

    /// Returns all referenced tables in the query
    pub fn tables(&self) -> Vec<String> {
        let mut tables = HashSet::new();
        self.tables.iter().for_each(|(t, _c)| {
            tables.insert(t.to_string());
        });
        Vec::from_iter(tables)
    }

    /// Returns only tables that were selected from
    pub fn select_tables(&self) -> Vec<String> {
        self.tables
            .iter()
            .filter_map(|(table, context)| match context {
                Context::Select => Some(table.to_string()),
                _ => None,
            })
            .collect()
    }

    /// Returns only tables that were modified by the query
    pub fn dml_tables(&self) -> Vec<String> {
        self.tables
            .iter()
            .filter_map(|(table, context)| match context {
                Context::DML => Some(table.to_string()),
                _ => None,
            })
            .collect()
    }

    /// Returns only tables that were modified by DDL statements
    pub fn ddl_tables(&self) -> Vec<String> {
        self.tables
            .iter()
            .filter_map(|(table, context)| match context {
                Context::DDL => Some(table.to_string()),
                _ => None,
            })
            .collect()
    }

    /// Returns any references to tables in the query
    pub fn functions(&self) -> Vec<String> {
        let mut functions = HashSet::new();
        self.functions.iter().for_each(|(f, _c)| {
            functions.insert(f.to_string());
        });
        Vec::from_iter(functions)
    }

    /// Returns DDL functions
    pub fn ddl_functions(&self) -> Vec<String> {
        self.functions
            .iter()
            .filter_map(|(function, context)| match context {
                Context::DDL => Some(function.to_string()),
                _ => None,
            })
            .collect()
    }

    /// Returns functions that were called
    pub fn call_functions(&self) -> Vec<String> {
        self.functions
            .iter()
            .filter_map(|(function, context)| match context {
                Context::Call => Some(function.to_string()),
                _ => None,
            })
            .collect()
    }

    pub fn deparse(&self) -> Result<String> {
        crate::deparse(&self.protobuf)
    }

    /// Intelligently truncates queries to a max length.
    ///
    /// # Example
    ///
    /// ```rust
    /// let query = "INSERT INTO \"x\" (a, b, c, d, e, f) VALUES ($1)";
    /// let result = pg_query::parse(query).unwrap();
    /// assert_eq!(result.truncate(32).unwrap(), "INSERT INTO x (...) VALUES (...)")
    /// ```
    pub fn truncate(&self, max_length: usize) -> Result<String> {
        crate::truncate(&self.protobuf, max_length)
    }

    pub fn statement_types(&self) -> Vec<&str> {
        self.protobuf
            .stmts
            .iter()
            .filter_map(|s| match s.stmt.as_ref().and_then(|s| s.node.as_ref()) {
                Some(NodeEnum::InsertStmt(..)) => Some("InsertStmt"),
                Some(NodeEnum::DeleteStmt(..)) => Some("DeleteStmt"),
                Some(NodeEnum::UpdateStmt(..)) => Some("UpdateStmt"),
                Some(NodeEnum::SelectStmt(..)) => Some("SelectStmt"),
                Some(NodeEnum::AlterTableStmt(..)) => Some("AlterTableStmt"),
                Some(NodeEnum::AlterTableCmd(..)) => Some("AlterTableCmd"),
                Some(NodeEnum::AlterDomainStmt(..)) => Some("AlterDomainStmt"),
                Some(NodeEnum::SetOperationStmt(..)) => Some("SetOperationStmt"),
                Some(NodeEnum::GrantStmt(..)) => Some("GrantStmt"),
                Some(NodeEnum::GrantRoleStmt(..)) => Some("GrantRoleStmt"),
                Some(NodeEnum::AlterDefaultPrivilegesStmt(..)) => Some("AlterDefaultPrivilegesStmt"),
                Some(NodeEnum::ClosePortalStmt(..)) => Some("ClosePortalStmt"),
                Some(NodeEnum::ClusterStmt(..)) => Some("ClusterStmt"),
                Some(NodeEnum::CopyStmt(..)) => Some("CopyStmt"),
                Some(NodeEnum::CreateStmt(..)) => Some("CreateStmt"),
                Some(NodeEnum::DefineStmt(..)) => Some("DefineStmt"),
                Some(NodeEnum::DropStmt(..)) => Some("DropStmt"),
                Some(NodeEnum::TruncateStmt(..)) => Some("TruncateStmt"),
                Some(NodeEnum::CommentStmt(..)) => Some("CommentStmt"),
                Some(NodeEnum::FetchStmt(..)) => Some("FetchStmt"),
                Some(NodeEnum::IndexStmt(..)) => Some("IndexStmt"),
                Some(NodeEnum::CreateFunctionStmt(..)) => Some("CreateFunctionStmt"),
                Some(NodeEnum::AlterFunctionStmt(..)) => Some("AlterFunctionStmt"),
                Some(NodeEnum::DoStmt(..)) => Some("DoStmt"),
                Some(NodeEnum::RenameStmt(..)) => Some("RenameStmt"),
                Some(NodeEnum::RuleStmt(..)) => Some("RuleStmt"),
                Some(NodeEnum::NotifyStmt(..)) => Some("NotifyStmt"),
                Some(NodeEnum::ListenStmt(..)) => Some("ListenStmt"),
                Some(NodeEnum::UnlistenStmt(..)) => Some("UnlistenStmt"),
                Some(NodeEnum::TransactionStmt(..)) => Some("TransactionStmt"),
                Some(NodeEnum::ViewStmt(..)) => Some("ViewStmt"),
                Some(NodeEnum::LoadStmt(..)) => Some("LoadStmt"),
                Some(NodeEnum::CreateDomainStmt(..)) => Some("CreateDomainStmt"),
                Some(NodeEnum::CreatedbStmt(..)) => Some("CreatedbStmt"),
                Some(NodeEnum::DropdbStmt(..)) => Some("DropdbStmt"),
                Some(NodeEnum::VacuumStmt(..)) => Some("VacuumStmt"),
                Some(NodeEnum::ExplainStmt(..)) => Some("ExplainStmt"),
                Some(NodeEnum::CreateTableAsStmt(..)) => Some("CreateTableAsStmt"),
                Some(NodeEnum::CreateSeqStmt(..)) => Some("CreateSeqStmt"),
                Some(NodeEnum::AlterSeqStmt(..)) => Some("AlterSeqStmt"),
                Some(NodeEnum::VariableSetStmt(..)) => Some("VariableSetStmt"),
                Some(NodeEnum::VariableShowStmt(..)) => Some("VariableShowStmt"),
                Some(NodeEnum::DiscardStmt(..)) => Some("DiscardStmt"),
                Some(NodeEnum::CreateTrigStmt(..)) => Some("CreateTrigStmt"),
                Some(NodeEnum::CreatePlangStmt(..)) => Some("CreatePlangStmt"),
                Some(NodeEnum::CreateRoleStmt(..)) => Some("CreateRoleStmt"),
                Some(NodeEnum::AlterRoleStmt(..)) => Some("AlterRoleStmt"),
                Some(NodeEnum::DropRoleStmt(..)) => Some("DropRoleStmt"),
                Some(NodeEnum::LockStmt(..)) => Some("LockStmt"),
                Some(NodeEnum::ConstraintsSetStmt(..)) => Some("ConstraintsSetStmt"),
                Some(NodeEnum::ReindexStmt(..)) => Some("ReindexStmt"),
                Some(NodeEnum::CheckPointStmt(..)) => Some("CheckPointStmt"),
                Some(NodeEnum::CreateSchemaStmt(..)) => Some("CreateSchemaStmt"),
                Some(NodeEnum::AlterDatabaseStmt(..)) => Some("AlterDatabaseStmt"),
                Some(NodeEnum::AlterDatabaseSetStmt(..)) => Some("AlterDatabaseSetStmt"),
                Some(NodeEnum::AlterRoleSetStmt(..)) => Some("AlterRoleSetStmt"),
                Some(NodeEnum::CreateConversionStmt(..)) => Some("CreateConversionStmt"),
                Some(NodeEnum::CreateCastStmt(..)) => Some("CreateCastStmt"),
                Some(NodeEnum::CreateOpClassStmt(..)) => Some("CreateOpClassStmt"),
                Some(NodeEnum::CreateOpFamilyStmt(..)) => Some("CreateOpFamilyStmt"),
                Some(NodeEnum::AlterOpFamilyStmt(..)) => Some("AlterOpFamilyStmt"),
                Some(NodeEnum::PrepareStmt(..)) => Some("PrepareStmt"),
                Some(NodeEnum::ExecuteStmt(..)) => Some("ExecuteStmt"),
                Some(NodeEnum::DeallocateStmt(..)) => Some("DeallocateStmt"),
                Some(NodeEnum::DeclareCursorStmt(..)) => Some("DeclareCursorStmt"),
                Some(NodeEnum::CreateTableSpaceStmt(..)) => Some("CreateTableSpaceStmt"),
                Some(NodeEnum::DropTableSpaceStmt(..)) => Some("DropTableSpaceStmt"),
                Some(NodeEnum::AlterObjectDependsStmt(..)) => Some("AlterObjectDependsStmt"),
                Some(NodeEnum::AlterObjectSchemaStmt(..)) => Some("AlterObjectSchemaStmt"),
                Some(NodeEnum::AlterOwnerStmt(..)) => Some("AlterOwnerStmt"),
                Some(NodeEnum::AlterOperatorStmt(..)) => Some("AlterOperatorStmt"),
                Some(NodeEnum::AlterTypeStmt(..)) => Some("AlterTypeStmt"),
                Some(NodeEnum::DropOwnedStmt(..)) => Some("DropOwnedStmt"),
                Some(NodeEnum::ReassignOwnedStmt(..)) => Some("ReassignOwnedStmt"),
                Some(NodeEnum::CompositeTypeStmt(..)) => Some("CompositeTypeStmt"),
                Some(NodeEnum::CreateEnumStmt(..)) => Some("CreateEnumStmt"),
                Some(NodeEnum::CreateRangeStmt(..)) => Some("CreateRangeStmt"),
                Some(NodeEnum::AlterEnumStmt(..)) => Some("AlterEnumStmt"),
                Some(NodeEnum::AlterTsdictionaryStmt(..)) => Some("AlterTsdictionaryStmt"),
                Some(NodeEnum::AlterTsconfigurationStmt(..)) => Some("AlterTsconfigurationStmt"),
                Some(NodeEnum::CreateFdwStmt(..)) => Some("CreateFdwStmt"),
                Some(NodeEnum::AlterFdwStmt(..)) => Some("AlterFdwStmt"),
                Some(NodeEnum::CreateForeignServerStmt(..)) => Some("CreateForeignServerStmt"),
                Some(NodeEnum::AlterForeignServerStmt(..)) => Some("AlterForeignServerStmt"),
                Some(NodeEnum::CreateUserMappingStmt(..)) => Some("CreateUserMappingStmt"),
                Some(NodeEnum::AlterUserMappingStmt(..)) => Some("AlterUserMappingStmt"),
                Some(NodeEnum::DropUserMappingStmt(..)) => Some("DropUserMappingStmt"),
                Some(NodeEnum::AlterTableSpaceOptionsStmt(..)) => Some("AlterTableSpaceOptionsStmt"),
                Some(NodeEnum::AlterTableMoveAllStmt(..)) => Some("AlterTableMoveAllStmt"),
                Some(NodeEnum::SecLabelStmt(..)) => Some("SecLabelStmt"),
                Some(NodeEnum::CreateForeignTableStmt(..)) => Some("CreateForeignTableStmt"),
                Some(NodeEnum::ImportForeignSchemaStmt(..)) => Some("ImportForeignSchemaStmt"),
                Some(NodeEnum::CreateExtensionStmt(..)) => Some("CreateExtensionStmt"),
                Some(NodeEnum::AlterExtensionStmt(..)) => Some("AlterExtensionStmt"),
                Some(NodeEnum::AlterExtensionContentsStmt(..)) => Some("AlterExtensionContentsStmt"),
                Some(NodeEnum::CreateEventTrigStmt(..)) => Some("CreateEventTrigStmt"),
                Some(NodeEnum::AlterEventTrigStmt(..)) => Some("AlterEventTrigStmt"),
                Some(NodeEnum::RefreshMatViewStmt(..)) => Some("RefreshMatViewStmt"),
                Some(NodeEnum::ReplicaIdentityStmt(..)) => Some("ReplicaIdentityStmt"),
                Some(NodeEnum::AlterSystemStmt(..)) => Some("AlterSystemStmt"),
                Some(NodeEnum::CreatePolicyStmt(..)) => Some("CreatePolicyStmt"),
                Some(NodeEnum::AlterPolicyStmt(..)) => Some("AlterPolicyStmt"),
                Some(NodeEnum::CreateTransformStmt(..)) => Some("CreateTransformStmt"),
                Some(NodeEnum::CreateAmStmt(..)) => Some("CreateAmStmt"),
                Some(NodeEnum::CreatePublicationStmt(..)) => Some("CreatePublicationStmt"),
                Some(NodeEnum::AlterPublicationStmt(..)) => Some("AlterPublicationStmt"),
                Some(NodeEnum::CreateSubscriptionStmt(..)) => Some("CreateSubscriptionStmt"),
                Some(NodeEnum::AlterSubscriptionStmt(..)) => Some("AlterSubscriptionStmt"),
                Some(NodeEnum::DropSubscriptionStmt(..)) => Some("DropSubscriptionStmt"),
                Some(NodeEnum::CreateStatsStmt(..)) => Some("CreateStatsStmt"),
                Some(NodeEnum::AlterCollationStmt(..)) => Some("AlterCollationStmt"),
                Some(NodeEnum::CallStmt(..)) => Some("CallStmt"),
                Some(NodeEnum::AlterStatsStmt(..)) => Some("AlterStatsStmt"),
                _ => None,
            })
            .collect()
    }
}