plsql-ir 0.1.0

Typed semantic intermediate representation for plsql-intelligence
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
//! Projection + column read/write extraction.
//!
//! Builds on the table/alias resolution from
//! (`sql_resolve`). Given a `SqlStatementModel` whose `tables` +
//! `alias_scope` are populated, this pass fills `projection`,
//! `reads`, and `writes` by walking the SELECT list, the
//! INSERT/UPDATE column targets, and the WHERE/SET/ON predicate
//! columns — attaching a [`ColumnResolution`] verdict to each.
//!
//! Resolution rules:
//!
//! * `alias.col` → look the alias up in `AliasScope`; if found,
//!   `Resolved`; if the alias isn't bound, `Unresolved`.
//! * bare `col` with exactly one table in scope → `Resolved`
//!   against that table.
//! * bare `col` with multiple tables in scope → `Unresolved`
//!   (ambiguous without catalog column lists; the catalog
//!   cross-check pass disambiguates later).
//! * `*` / `alias.*` → `StarExpansion`.
//!
//! ## /oracle evidence
//!
//! * `DATABASE-REFERENCE.md` PL/SQL Language Reference — the
//!   SELECT-list / SET-clause / predicate grammar defers to the
//!   SQL Language Reference.
//! * `LOW-LEVEL-CATALOGS.md` Data Dictionary View Families —
//!   `ALL_TAB_COLUMNS` is the authority that turns an
//!   `Unresolved` bare column into a `Resolved` one once the
//!   catalog is available (deferred to a later pass).

use crate::sql_sem::{
    ColumnResolution, ColumnUse, ProjectionItem, SqlSemanticModel, SqlSemanticVerb,
    SqlStatementModel,
};

/// Populate `projection`, `reads`, `writes` on `model` from its
/// raw text + already-resolved `tables` / `alias_scope`.
/// `raw` is the original SQL text (the model doesn't keep it).
pub fn extract_columns(model: &mut SqlStatementModel, raw: &str) {
    let single_table = model.tables.len() == 1;
    match model.verb {
        SqlSemanticVerb::Select => {
            let proj = parse_select_list(raw);
            for item in &proj {
                classify_projection_reads(item, single_table, model);
            }
            model.projection = proj;
            for c in predicate_columns(raw) {
                push_read(model, c, single_table);
            }
        }
        SqlSemanticVerb::Insert => {
            for c in insert_target_columns(raw) {
                push_write(model, c, single_table);
            }
            // Sub-SELECT projection columns are reads.
            for item in parse_select_list(raw) {
                if !item.is_star {
                    push_read_name(model, &item.expression_text, single_table);
                }
            }
        }
        SqlSemanticVerb::Update => {
            for c in update_set_columns(raw) {
                push_write(model, c, single_table);
            }
            for c in predicate_columns(raw) {
                push_read(model, c, single_table);
            }
        }
        SqlSemanticVerb::Delete => {
            for c in predicate_columns(raw) {
                push_read(model, c, single_table);
            }
        }
        SqlSemanticVerb::MergeUpdate
        | SqlSemanticVerb::MergeInsert
        | SqlSemanticVerb::MergeDelete => {
            for c in update_set_columns(raw) {
                push_write(model, c, single_table);
            }
            for c in predicate_columns(raw) {
                push_read(model, c, single_table);
            }
        }
    }
}

/// Convenience: run `extract_columns` over every statement in a
/// `SqlSemanticModel`. The caller supplies the raw text per
/// statement (the model is text-free by design).
pub fn extract_columns_for_model(model: &mut SqlSemanticModel, raws: &[String]) {
    for (i, stmt) in model.statements.iter_mut().enumerate() {
        if let Some(raw) = raws.get(i) {
            extract_columns(stmt, raw);
        }
    }
}

fn parse_select_list(raw: &str) -> Vec<ProjectionItem> {
    let upper = raw.to_ascii_uppercase();
    let Some(sel) = upper.find("SELECT") else {
        return Vec::new();
    };
    let after = sel + "SELECT".len();
    // Stop the projection list at INTO or FROM (whichever first).
    let into = upper[after..].find(" INTO ").map(|p| after + p);
    let from = upper[after..].find(" FROM ").map(|p| after + p);
    let end = [into, from]
        .into_iter()
        .flatten()
        .min()
        .unwrap_or(raw.len());
    let list = raw[after..end].trim();
    split_top_level_commas(list)
        .into_iter()
        .map(|piece| parse_projection_item(piece.trim()))
        .filter(|p| !p.expression_text.is_empty())
        .collect()
}

fn parse_projection_item(piece: &str) -> ProjectionItem {
    let is_star = piece == "*" || piece.ends_with(".*");
    // `expr AS alias` / `expr alias`.
    let upper = piece.to_ascii_uppercase();
    if let Some(as_pos) = upper.rfind(" AS ") {
        let expr = piece[..as_pos].trim().to_string();
        let alias = piece[as_pos + 4..].trim().to_string();
        return ProjectionItem {
            alias,
            expression_text: expr,
            is_star,
        };
    }
    // Trailing-token alias only if there's whitespace and the
    // last token is a bare identifier (avoid splitting
    // `a.b` or `fn(x)`).
    if let Some(ws) = piece.rfind(char::is_whitespace) {
        let head = piece[..ws].trim();
        let tail = piece[ws..].trim();
        if !head.is_empty()
            && tail.chars().all(|c| c.is_ascii_alphanumeric() || c == '_')
            && !head.ends_with(['(', ','])
            && !is_star
        {
            return ProjectionItem {
                alias: tail.to_string(),
                expression_text: head.to_string(),
                is_star,
            };
        }
    }
    ProjectionItem {
        alias: String::new(),
        expression_text: piece.to_string(),
        is_star,
    }
}

fn classify_projection_reads(
    item: &ProjectionItem,
    single_table: bool,
    model: &mut SqlStatementModel,
) {
    if item.is_star {
        let (qual, _col) = split_qualifier(&item.expression_text);
        model.reads.push(ColumnUse {
            qualifier: qual,
            column: "*".to_string(),
            resolution: ColumnResolution::StarExpansion,
        });
        return;
    }
    // Pull bare column identifiers from the expression.
    for ident in column_idents(&item.expression_text) {
        push_read_name(model, &ident, single_table);
    }
}

fn push_read(model: &mut SqlStatementModel, col: String, single_table: bool) {
    push_read_name(model, &col, single_table);
}

fn push_read_name(model: &mut SqlStatementModel, name: &str, single_table: bool) {
    if let Some(cu) = make_column_use(name, single_table, model) {
        if !model.reads.contains(&cu) {
            model.reads.push(cu);
        }
    }
}

fn push_write(model: &mut SqlStatementModel, col: String, single_table: bool) {
    if let Some(cu) = make_column_use(&col, single_table, model) {
        if !model.writes.contains(&cu) {
            model.writes.push(cu);
        }
    }
}

fn make_column_use(name: &str, single_table: bool, model: &SqlStatementModel) -> Option<ColumnUse> {
    let name = name.trim();
    if name.is_empty() || is_sql_noise(name) {
        return None;
    }
    let (qualifier, column) = split_qualifier(name);
    if column.is_empty() || !column.chars().next()?.is_ascii_alphabetic() {
        return None;
    }
    let resolution = if !qualifier.is_empty() {
        if model.alias_scope.resolve(&qualifier).is_some() {
            ColumnResolution::Resolved
        } else {
            ColumnResolution::Unresolved
        }
    } else if single_table {
        ColumnResolution::Resolved
    } else {
        ColumnResolution::Unresolved
    };
    Some(ColumnUse {
        qualifier,
        column: column.to_ascii_uppercase(),
        resolution,
    })
}

fn split_qualifier(name: &str) -> (String, String) {
    match name.rsplit_once('.') {
        Some((q, c)) => (q.trim().to_string(), c.trim().to_string()),
        None => (String::new(), name.trim().to_string()),
    }
}

fn column_idents(expr: &str) -> Vec<String> {
    let mut out = Vec::new();
    let mut cur = String::new();
    for ch in expr.chars() {
        if ch.is_ascii_alphanumeric() || ch == '_' || ch == '$' || ch == '#' || ch == '.' {
            cur.push(ch);
        } else {
            if !cur.is_empty() {
                out.push(std::mem::take(&mut cur));
            }
        }
    }
    if !cur.is_empty() {
        out.push(cur);
    }
    out.into_iter().filter(|w| !is_sql_noise(w)).collect()
}

fn insert_target_columns(raw: &str) -> Vec<String> {
    // INSERT INTO t (c1, c2, …) VALUES …  — pull the paren list
    // immediately after the table name.
    let upper = raw.to_ascii_uppercase();
    let Some(into) = upper.find("INTO") else {
        return Vec::new();
    };
    let rest = &raw[into + 4..];
    let Some(open) = rest.find('(') else {
        return Vec::new();
    };
    let Some(close) = rest[open..].find(')') else {
        return Vec::new();
    };
    split_top_level_commas(&rest[open + 1..open + close])
        .into_iter()
        .map(|s| s.trim().to_string())
        .filter(|s| !s.is_empty())
        .collect()
}

fn update_set_columns(raw: &str) -> Vec<String> {
    let upper = raw.to_ascii_uppercase();
    let Some(set) = upper.find(" SET ") else {
        return Vec::new();
    };
    let after = set + 5;
    let end = upper[after..]
        .find(" WHERE ")
        .map(|p| after + p)
        .unwrap_or(raw.len());
    split_top_level_commas(&raw[after..end])
        .into_iter()
        .filter_map(|assign| assign.split('=').next().map(|s| s.trim().to_string()))
        .filter(|s| !s.is_empty())
        .collect()
}

fn predicate_columns(raw: &str) -> Vec<String> {
    let upper = raw.to_ascii_uppercase();
    let Some(w) = upper.find(" WHERE ") else {
        return Vec::new();
    };
    let pred = &raw[w + 7..];
    // Stop at GROUP/ORDER/HAVING.
    let pu = pred.to_ascii_uppercase();
    let stop = ["GROUP ", "ORDER ", "HAVING ", "CONNECT "]
        .iter()
        .filter_map(|kw| pu.find(kw))
        .min()
        .unwrap_or(pred.len());
    column_idents(&pred[..stop])
}

fn split_top_level_commas(s: &str) -> Vec<String> {
    let mut out = Vec::new();
    let mut depth = 0i32;
    let mut buf = String::new();
    for ch in s.chars() {
        match ch {
            '(' => {
                depth += 1;
                buf.push(ch);
            }
            ')' => {
                depth -= 1;
                buf.push(ch);
            }
            ',' if depth == 0 => out.push(std::mem::take(&mut buf)),
            _ => buf.push(ch),
        }
    }
    if !buf.trim().is_empty() {
        out.push(buf);
    }
    out
}

fn is_sql_noise(w: &str) -> bool {
    let u = w.to_ascii_uppercase();
    matches!(
        u.as_str(),
        "AND"
            | "OR"
            | "NOT"
            | "NULL"
            | "IS"
            | "IN"
            | "LIKE"
            | "BETWEEN"
            | "EXISTS"
            | "TRUE"
            | "FALSE"
            | "FROM"
            | "WHERE"
            | "SELECT"
            | "INTO"
            | "VALUES"
            | "SET"
            | "DUAL"
            | "SYSDATE"
            | "COUNT"
            | "SUM"
            | "AVG"
            | "MIN"
            | "MAX"
            | "DISTINCT"
            | "AS"
            | "ON"
            | "USING"
            | "CASE"
            | "WHEN"
            | "THEN"
            | "ELSE"
            | "END"
    ) || u.chars().all(|c| c.is_ascii_digit() || c == '.')
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::sql_resolve::resolve_sql;

    #[test]
    fn select_list_columns_become_reads() {
        let raw = "SELECT e.id, e.name INTO a, b FROM employees e";
        let mut m = resolve_sql(raw);
        extract_columns(&mut m, raw);
        assert_eq!(m.projection.len(), 2);
        let cols: Vec<&str> = m.reads.iter().map(|c| c.column.as_str()).collect();
        assert!(cols.contains(&"ID"));
        assert!(cols.contains(&"NAME"));
        // Alias `e` is bound → Resolved.
        assert!(
            m.reads
                .iter()
                .all(|c| c.resolution == ColumnResolution::Resolved)
        );
    }

    #[test]
    fn star_projection_is_star_expansion() {
        let raw = "SELECT * INTO r FROM employees";
        let mut m = resolve_sql(raw);
        extract_columns(&mut m, raw);
        assert!(m.projection.iter().any(|p| p.is_star));
        assert!(
            m.reads
                .iter()
                .any(|c| c.resolution == ColumnResolution::StarExpansion)
        );
    }

    #[test]
    fn bare_column_single_table_resolved() {
        let raw = "SELECT salary INTO v FROM employees";
        let mut m = resolve_sql(raw);
        extract_columns(&mut m, raw);
        let c = m.reads.iter().find(|c| c.column == "SALARY").unwrap();
        assert_eq!(c.resolution, ColumnResolution::Resolved);
    }

    #[test]
    fn bare_column_multi_table_unresolved() {
        let raw = "SELECT amount INTO v FROM orders o, payments p WHERE o.id = p.oid";
        let mut m = resolve_sql(raw);
        extract_columns(&mut m, raw);
        let c = m.reads.iter().find(|c| c.column == "AMOUNT");
        assert_eq!(c.map(|c| c.resolution), Some(ColumnResolution::Unresolved));
    }

    #[test]
    fn qualified_unbound_alias_is_unresolved() {
        let raw = "SELECT zzz.col INTO v FROM employees e";
        let mut m = resolve_sql(raw);
        extract_columns(&mut m, raw);
        let c = m.reads.iter().find(|c| c.column == "COL").unwrap();
        assert_eq!(c.resolution, ColumnResolution::Unresolved);
    }

    #[test]
    fn insert_target_columns_become_writes() {
        let raw = "INSERT INTO audit (event_id, ts) VALUES (1, SYSDATE)";
        let mut m = resolve_sql(raw);
        extract_columns(&mut m, raw);
        let cols: Vec<&str> = m.writes.iter().map(|c| c.column.as_str()).collect();
        assert!(cols.contains(&"EVENT_ID"));
        assert!(cols.contains(&"TS"));
    }

    #[test]
    fn update_set_columns_become_writes() {
        let raw = "UPDATE employees e SET e.salary = e.salary * 1.1 WHERE e.id = 1";
        let mut m = resolve_sql(raw);
        extract_columns(&mut m, raw);
        assert!(m.writes.iter().any(|c| c.column == "SALARY"));
        // WHERE column is a read.
        assert!(m.reads.iter().any(|c| c.column == "ID"));
    }

    #[test]
    fn delete_predicate_columns_are_reads() {
        let raw = "DELETE FROM stale WHERE created < SYSDATE - 30";
        let mut m = resolve_sql(raw);
        extract_columns(&mut m, raw);
        assert!(m.reads.iter().any(|c| c.column == "CREATED"));
        assert!(m.writes.is_empty());
    }

    #[test]
    fn projection_alias_split() {
        let raw = "SELECT e.salary AS pay INTO v FROM employees e";
        let mut m = resolve_sql(raw);
        extract_columns(&mut m, raw);
        let p = &m.projection[0];
        assert_eq!(p.alias, "pay");
        assert_eq!(p.expression_text, "e.salary");
    }

    #[test]
    fn sql_noise_not_recorded_as_columns() {
        let raw = "SELECT id INTO v FROM employees WHERE id IS NOT NULL AND id > 0";
        let mut m = resolve_sql(raw);
        extract_columns(&mut m, raw);
        let cols: Vec<&str> = m.reads.iter().map(|c| c.column.as_str()).collect();
        assert!(
            !cols
                .iter()
                .any(|c| *c == "NULL" || *c == "AND" || *c == "NOT")
        );
        assert!(cols.contains(&"ID"));
    }

    #[test]
    fn extract_columns_for_model_walks_all_statements() {
        let mut model = SqlSemanticModel::default();
        model.push(resolve_sql("SELECT id INTO v FROM t1"));
        model.push(resolve_sql("SELECT name INTO v FROM t2"));
        extract_columns_for_model(
            &mut model,
            &[
                "SELECT id INTO v FROM t1".to_string(),
                "SELECT name INTO v FROM t2".to_string(),
            ],
        );
        assert!(model.statements[0].reads.iter().any(|c| c.column == "ID"));
        assert!(model.statements[1].reads.iter().any(|c| c.column == "NAME"));
    }

    #[test]
    fn serde_round_trip_preserves_column_resolution() {
        let raw = "SELECT salary INTO v FROM employees";
        let mut m = resolve_sql(raw);
        extract_columns(&mut m, raw);
        let json = serde_json::to_string(&m).unwrap();
        let back: SqlStatementModel = serde_json::from_str(&json).unwrap();
        assert_eq!(back, m);
    }
}