sqlglot-rust 0.9.11

A SQL parser, optimizer, and transpiler library inspired by Python's sqlglot
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
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
use sqlglot_rust::optimizer::optimize;
/// Tests ported from Python sqlglot's `test_optimizer.py`.
///
/// Covers constant folding (arithmetic, string concat, comparisons),
/// boolean simplification (AND/OR with TRUE/FALSE, double NOT, WHERE TRUE),
/// and subquery unnesting / decorrelation (EXISTS/IN → JOINs).
use sqlglot_rust::{Dialect, generate, parse};

/// Parse → optimise → generate, compare with expected output.
fn validate_optimized(input: &str, expected: &str) {
    let stmt = parse(input, Dialect::Ansi)
        .unwrap_or_else(|e| panic!("Parse failed for '{}': {}", input, e));
    let optimized = optimize(stmt).unwrap();
    let output = generate(&optimized, Dialect::Ansi);
    assert_eq!(output, expected, "\n  Input: {}", input);
}

/// Ensures the optimized output equals the original (i.e. no-op optimization).
fn validate_no_op(sql: &str) {
    validate_optimized(sql, sql);
}

// ═════════════════════════════════════════════════════════════════════════════
// Constant Folding – Arithmetic
// (from Python test_optimizer.py::test_simplify)
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_fold_addition() {
    validate_optimized("SELECT 1 + 2", "SELECT 3");
    validate_optimized("SELECT 10 + 20 + 30", "SELECT 60");
}

#[test]
fn test_fold_subtraction() {
    validate_optimized("SELECT 10 - 3", "SELECT 7");
}

#[test]
fn test_fold_multiplication() {
    validate_optimized("SELECT 3 * 4", "SELECT 12");
    validate_optimized("SELECT 2 * 3 * 4", "SELECT 24");
}

#[test]
fn test_fold_division() {
    validate_optimized("SELECT 10 / 2", "SELECT 5");
}

#[test]
fn test_fold_modulo() {
    validate_optimized("SELECT 10 % 3", "SELECT 1");
}

#[test]
fn test_fold_mixed_arithmetic() {
    validate_optimized("SELECT 1 + 2 * 3", "SELECT 7");
}

// ═════════════════════════════════════════════════════════════════════════════
// Constant Folding – String Concatenation
// (from Python test_optimizer.py::test_simplify)
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_fold_string_concat() {
    validate_optimized("SELECT 'hello' || ' ' || 'world'", "SELECT 'hello world'");
    validate_optimized("SELECT 'foo' || 'bar'", "SELECT 'foobar'");
}

// ═════════════════════════════════════════════════════════════════════════════
// Constant Folding – Comparisons
// (from Python test_optimizer.py::test_simplify)
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_fold_comparisons() {
    validate_optimized("SELECT 1 < 2", "SELECT TRUE");
    validate_optimized("SELECT 1 > 2", "SELECT FALSE");
    validate_optimized("SELECT 1 = 1", "SELECT TRUE");
    validate_optimized("SELECT 1 <> 1", "SELECT FALSE");
    validate_optimized("SELECT 1 <= 1", "SELECT TRUE");
    validate_optimized("SELECT 1 >= 1", "SELECT TRUE");
    validate_optimized("SELECT 2 <= 1", "SELECT FALSE");
    validate_optimized("SELECT 0 >= 1", "SELECT FALSE");
}

// ═════════════════════════════════════════════════════════════════════════════
// Boolean Simplification – AND / OR with TRUE / FALSE
// (from Python test_optimizer.py::test_simplify)
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_simplify_and_true() {
    validate_optimized("SELECT TRUE AND x", "SELECT x");
    validate_optimized("SELECT x AND TRUE", "SELECT x");
}

#[test]
fn test_simplify_and_false() {
    validate_optimized("SELECT FALSE AND x", "SELECT FALSE");
    validate_optimized("SELECT x AND FALSE", "SELECT FALSE");
}

#[test]
fn test_simplify_or_true() {
    validate_optimized("SELECT TRUE OR x", "SELECT TRUE");
    validate_optimized("SELECT x OR TRUE", "SELECT TRUE");
}

#[test]
fn test_simplify_or_false() {
    validate_optimized("SELECT FALSE OR x", "SELECT x");
    validate_optimized("SELECT x OR FALSE", "SELECT x");
}

// ═════════════════════════════════════════════════════════════════════════════
// Boolean Simplification – NOT
// (from Python test_optimizer.py::test_simplify)
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_simplify_double_not() {
    validate_optimized("SELECT NOT NOT x", "SELECT x");
}

// ═════════════════════════════════════════════════════════════════════════════
// Boolean Simplification – WHERE TRUE elimination
// (from Python test_optimizer.py::test_simplify)
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_simplify_where_true() {
    validate_optimized("SELECT x FROM t WHERE TRUE", "SELECT x FROM t");
}

#[test]
fn test_simplify_where_true_and_condition() {
    validate_optimized(
        "SELECT x FROM t WHERE TRUE AND a > 1",
        "SELECT x FROM t WHERE a > 1",
    );
}

// ═════════════════════════════════════════════════════════════════════════════
// No-op cases – optimizer should leave these unchanged
// (from Python test_optimizer.py checking idempotence)
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_no_op_plain_select() {
    validate_no_op("SELECT a FROM t WHERE a > 1");
}

#[test]
fn test_no_op_column_only() {
    validate_no_op("SELECT a + b FROM t");
}

#[test]
fn test_no_op_complex_query() {
    validate_no_op("SELECT a, b FROM t INNER JOIN t2 ON t.id = t2.id WHERE t.x > 0 ORDER BY a");
}

// ═════════════════════════════════════════════════════════════════════════════
// Combined constant folding + boolean simplification
// (from Python test_optimizer.py multi-pass tests)
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_combined_fold_and_simplify() {
    // 1 + 2 folds to 3, 3 > 0 folds to TRUE, TRUE AND x → x
    validate_optimized("SELECT 1 + 2 > 0 AND x", "SELECT x");
}

#[test]
fn test_fold_in_where() {
    validate_optimized(
        "SELECT a FROM t WHERE 1 + 1 = 2",
        "SELECT a FROM t", // WHERE TRUE → removed
    );
}

#[test]
fn test_fold_leaves_non_const_untouched() {
    // Cannot fold a + 1 because a is a column reference
    validate_no_op("SELECT a + 1 FROM t");
}

// ═════════════════════════════════════════════════════════════════════════════
// Optimizer preserves correct structure
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_optimizer_preserves_joins() {
    validate_no_op("SELECT a.x FROM a INNER JOIN b ON a.id = b.id");
}

#[test]
fn test_optimizer_preserves_group_by() {
    validate_no_op("SELECT a, COUNT(*) FROM t GROUP BY a");
}

#[test]
fn test_optimizer_preserves_cte() {
    validate_no_op("WITH cte AS (SELECT 1 AS x) SELECT * FROM cte");
}

// ═════════════════════════════════════════════════════════════════════════════
// Subquery unnesting – EXISTS → JOIN (via full optimize pipeline)
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_optimize_exists_to_inner_join() {
    let input = "SELECT a.id FROM a WHERE EXISTS (SELECT 1 FROM b WHERE b.id = a.id)";
    let stmt = parse(input, Dialect::Ansi).unwrap();
    let optimized = optimize(stmt).unwrap();
    let output = generate(&optimized, Dialect::Ansi);
    assert!(
        output.contains("INNER JOIN"),
        "optimize() should unnest EXISTS: {output}"
    );
    assert!(
        !output.contains("EXISTS"),
        "EXISTS should be removed: {output}"
    );
}

#[test]
fn test_optimize_not_exists_to_left_join() {
    let input = "SELECT a.id FROM a WHERE NOT EXISTS (SELECT 1 FROM b WHERE b.id = a.id)";
    let stmt = parse(input, Dialect::Ansi).unwrap();
    let optimized = optimize(stmt).unwrap();
    let output = generate(&optimized, Dialect::Ansi);
    assert!(
        output.contains("LEFT JOIN"),
        "optimize() should unnest NOT EXISTS: {output}"
    );
    assert!(
        output.contains("IS NULL"),
        "Anti-join needs IS NULL check: {output}"
    );
}

#[test]
fn test_optimize_in_subquery_to_join() {
    let input = "SELECT a.id FROM a WHERE a.id IN (SELECT b.id FROM b)";
    let stmt = parse(input, Dialect::Ansi).unwrap();
    let optimized = optimize(stmt).unwrap();
    let output = generate(&optimized, Dialect::Ansi);
    assert!(
        output.contains("INNER JOIN"),
        "optimize() should unnest IN: {output}"
    );
    assert!(!output.contains(" IN "), "IN should be removed: {output}");
}

#[test]
fn test_optimize_not_in_subquery_to_left_join() {
    let input = "SELECT a.id FROM a WHERE a.id NOT IN (SELECT b.id FROM b)";
    let stmt = parse(input, Dialect::Ansi).unwrap();
    let optimized = optimize(stmt).unwrap();
    let output = generate(&optimized, Dialect::Ansi);
    assert!(
        output.contains("LEFT JOIN"),
        "optimize() should unnest NOT IN: {output}"
    );
    assert!(
        output.contains("IS NULL"),
        "Anti-join needs IS NULL: {output}"
    );
}

// ═════════════════════════════════════════════════════════════════════════════
// Subquery unnesting – safety: uncorrelated and non-equality correlations
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_optimize_uncorrelated_exists_unchanged() {
    // No correlation → optimizer should leave EXISTS alone
    let input = "SELECT a.id FROM a WHERE EXISTS (SELECT 1 FROM b WHERE b.x > 10)";
    let stmt = parse(input, Dialect::Ansi).unwrap();
    let optimized = optimize(stmt).unwrap();
    let output = generate(&optimized, Dialect::Ansi);
    assert!(
        output.contains("EXISTS"),
        "Uncorrelated EXISTS should remain: {output}"
    );
}

#[test]
fn test_optimize_non_eq_correlation_unchanged() {
    // Non-equality correlation → unsafe to unnest
    let input =
        "SELECT a.id FROM a WHERE EXISTS (SELECT 1 FROM b WHERE b.val < a.val AND b.id = a.id)";
    let stmt = parse(input, Dialect::Ansi).unwrap();
    let optimized = optimize(stmt).unwrap();
    let output = generate(&optimized, Dialect::Ansi);
    assert!(
        output.contains("EXISTS"),
        "Non-eq correlation should remain: {output}"
    );
}

// ═════════════════════════════════════════════════════════════════════════════
// Python sqlglot#7295 exact reproducer through full pipeline
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_optimize_sqlglot_issue_7295_no_crash() {
    // Exact reproducer from Python sqlglot#7295: correlated scalar subquery
    // inside COALESCE in SELECT list with non-equality correlation.
    // Must NOT crash and must NOT modify the query structure.
    let input = "SELECT COALESCE((SELECT MAX(b.val) FROM t AS b WHERE b.val < a.val AND b.id = a.id), a.val) AS result FROM t AS a";
    let stmt = parse(input, Dialect::Ansi).unwrap();
    let optimized = optimize(stmt).unwrap();
    let output = generate(&optimized, Dialect::Ansi);
    assert!(
        !output.contains("JOIN"),
        "Issue #7295: should NOT add JOINs: {output}"
    );
    assert!(
        output.contains("COALESCE"),
        "COALESCE should remain: {output}"
    );
}

// ═════════════════════════════════════════════════════════════════════════════
// Combined optimizations: constant folding + boolean simplification + unnesting
// ═════════════════════════════════════════════════════════════════════════════

#[test]
fn test_optimize_combined_bool_simplify_and_unnest() {
    // TRUE AND EXISTS(...) → EXISTS is simplified to just EXISTS, then unnested
    let input = "SELECT a.id FROM a WHERE TRUE AND EXISTS (SELECT 1 FROM b WHERE b.id = a.id)";
    let stmt = parse(input, Dialect::Ansi).unwrap();
    let optimized = optimize(stmt).unwrap();
    let output = generate(&optimized, Dialect::Ansi);
    assert!(
        output.contains("INNER JOIN"),
        "Should unnest after boolean simplification: {output}"
    );
    assert!(
        !output.contains("TRUE"),
        "TRUE should be simplified away: {output}"
    );
    assert!(
        !output.contains("EXISTS"),
        "EXISTS should be unnested: {output}"
    );
}

#[test]
fn test_optimize_preserves_existing_joins_with_unnest() {
    // Query already has a join, and also has an EXISTS in WHERE → should add another join
    let input = "SELECT a.id FROM a INNER JOIN c ON a.cid = c.id WHERE EXISTS (SELECT 1 FROM b WHERE b.id = a.id)";
    let stmt = parse(input, Dialect::Ansi).unwrap();
    let optimized = optimize(stmt).unwrap();
    let output = generate(&optimized, Dialect::Ansi);
    assert!(
        output.contains("a.cid = c.id"),
        "Original join should be preserved: {output}"
    );
    assert!(
        !output.contains("EXISTS"),
        "EXISTS should be unnested: {output}"
    );
}

// ═══════════════════════════════════════════════════════════════════════
// qualify_columns tests
// ═══════════════════════════════════════════════════════════════════════

use sqlglot_rust::ast::DataType;
use sqlglot_rust::optimizer::qualify_columns::qualify_columns;
use sqlglot_rust::schema::{MappingSchema, Schema};

fn test_schema() -> MappingSchema {
    let mut s = MappingSchema::new(Dialect::Ansi);
    s.add_table(
        &["users"],
        vec![
            ("id".to_string(), DataType::Int),
            ("name".to_string(), DataType::Varchar(Some(255))),
            ("email".to_string(), DataType::Text),
            ("dept_id".to_string(), DataType::Int),
        ],
    )
    .unwrap();
    s.add_table(
        &["orders"],
        vec![
            ("id".to_string(), DataType::Int),
            ("user_id".to_string(), DataType::Int),
            (
                "amount".to_string(),
                DataType::Decimal {
                    precision: Some(10),
                    scale: Some(2),
                },
            ),
            ("status".to_string(), DataType::Varchar(Some(50))),
        ],
    )
    .unwrap();
    s.add_table(
        &["departments"],
        vec![
            ("id".to_string(), DataType::Int),
            ("dept_name".to_string(), DataType::Varchar(Some(100))),
        ],
    )
    .unwrap();
    s
}

fn qualify_sql(input: &str, schema: &MappingSchema) -> String {
    let stmt = parse(input, Dialect::Ansi).unwrap();
    let qualified = qualify_columns(stmt, schema);
    generate(&qualified, Dialect::Ansi)
}

#[test]
fn test_qc_expand_star_single_table() {
    let s = test_schema();
    assert_eq!(
        qualify_sql("SELECT * FROM users", &s),
        "SELECT id, name, email, dept_id FROM users"
    );
}

#[test]
fn test_qc_expand_star_multi_table() {
    let s = test_schema();
    let result = qualify_sql(
        "SELECT * FROM users JOIN departments ON users.dept_id = departments.id",
        &s,
    );
    assert_eq!(
        result,
        "SELECT id, name, email, dept_id, id, dept_name FROM users INNER JOIN departments ON users.dept_id = departments.id"
    );
}

#[test]
fn test_qc_expand_qualified_wildcard() {
    let s = test_schema();
    assert_eq!(
        qualify_sql("SELECT users.* FROM users", &s),
        "SELECT users.id, users.name, users.email, users.dept_id FROM users"
    );
}

#[test]
fn test_qc_qualify_single_source() {
    let s = test_schema();
    assert_eq!(
        qualify_sql("SELECT id, name FROM users WHERE email = 'a@b.com'", &s),
        "SELECT users.id, users.name FROM users WHERE users.email = 'a@b.com'"
    );
}

#[test]
fn test_qc_qualify_with_alias() {
    let s = test_schema();
    assert_eq!(
        qualify_sql("SELECT id, name FROM users AS u", &s),
        "SELECT u.id, u.name FROM users AS u"
    );
}

#[test]
fn test_qc_already_qualified_noop() {
    let s = test_schema();
    assert_eq!(
        qualify_sql("SELECT users.id FROM users", &s),
        "SELECT users.id FROM users"
    );
}

#[test]
fn test_qc_qualify_join_unique_columns() {
    let s = test_schema();
    assert_eq!(
        qualify_sql(
            "SELECT name, amount FROM users JOIN orders ON users.id = orders.user_id",
            &s
        ),
        "SELECT users.name, orders.amount FROM users INNER JOIN orders ON users.id = orders.user_id"
    );
}

#[test]
fn test_qc_ambiguous_column_left_unqualified() {
    let s = test_schema();
    // 'id' exists in both — stays unqualified
    assert_eq!(
        qualify_sql(
            "SELECT id FROM users JOIN orders ON users.id = orders.user_id",
            &s
        ),
        "SELECT id FROM users INNER JOIN orders ON users.id = orders.user_id"
    );
}

#[test]
fn test_qc_qualify_where_order_group_having() {
    let s = test_schema();
    assert_eq!(
        qualify_sql(
            "SELECT status, COUNT(*) FROM orders WHERE amount > 100 GROUP BY status HAVING COUNT(*) > 5 ORDER BY status",
            &s
        ),
        "SELECT orders.status, COUNT(*) FROM orders WHERE orders.amount > 100 GROUP BY orders.status HAVING COUNT(*) > 5 ORDER BY orders.status"
    );
}

#[test]
fn test_qc_cte_resolution() {
    let s = test_schema();
    assert_eq!(
        qualify_sql(
            "WITH active AS (SELECT id, name FROM users) SELECT id, name FROM active",
            &s
        ),
        "WITH active AS (SELECT users.id, users.name FROM users) SELECT active.id, active.name FROM active"
    );
}

#[test]
fn test_qc_derived_table() {
    let s = test_schema();
    assert_eq!(
        qualify_sql("SELECT sub.id FROM (SELECT id, name FROM users) AS sub", &s),
        "SELECT sub.id FROM (SELECT users.id, users.name FROM users) AS sub"
    );
}

#[test]
fn test_qc_preserve_aliases() {
    let s = test_schema();
    assert_eq!(
        qualify_sql("SELECT name AS user_name, email AS contact FROM users", &s),
        "SELECT users.name AS user_name, users.email AS contact FROM users"
    );
}

#[test]
fn test_qc_three_table_join() {
    let s = test_schema();
    assert_eq!(
        qualify_sql(
            "SELECT name, amount, dept_name FROM users JOIN orders ON users.id = orders.user_id JOIN departments ON users.dept_id = departments.id",
            &s
        ),
        "SELECT users.name, orders.amount, departments.dept_name FROM users INNER JOIN orders ON users.id = orders.user_id INNER JOIN departments ON users.dept_id = departments.id"
    );
}

#[test]
fn test_qc_unknown_table_passthrough() {
    let s = test_schema();
    // Table not in schema, columns pass through unchanged
    assert_eq!(
        qualify_sql("SELECT x, y FROM unknown_table", &s),
        "SELECT x, y FROM unknown_table"
    );
}

#[test]
fn test_qc_subquery_in_where() {
    let s = test_schema();
    // Columns in the inner subquery should get qualified too
    let result = qualify_sql(
        "SELECT name FROM users WHERE id IN (SELECT user_id FROM orders)",
        &s,
    );
    assert_eq!(
        result,
        "SELECT users.name FROM users WHERE users.id IN (SELECT orders.user_id FROM orders)"
    );
}

#[test]
fn test_qc_nested_cte_with_derived_table() {
    let s = test_schema();
    let result = qualify_sql(
        "WITH cte AS (SELECT id, name FROM users) SELECT id FROM (SELECT id FROM cte) AS sub",
        &s,
    );
    assert_eq!(
        result,
        "WITH cte AS (SELECT users.id, users.name FROM users) SELECT sub.id FROM (SELECT cte.id FROM cte) AS sub"
    );
}

#[test]
fn test_qc_non_select_passthrough() {
    let s = test_schema();
    // Non-SELECT statements pass through unchanged
    assert_eq!(
        qualify_sql("INSERT INTO users VALUES (1, 'a', 'b', 1)", &s),
        "INSERT INTO users VALUES (1, 'a', 'b', 1)"
    );
}

#[test]
fn test_qc_mixed_qualified_unqualified() {
    let s = test_schema();
    assert_eq!(
        qualify_sql("SELECT users.id, name FROM users", &s),
        "SELECT users.id, users.name FROM users"
    );
}

#[test]
fn test_qc_qualify_join_on_clause() {
    let s = test_schema();
    // user_id is unique to orders, gets qualified
    // id is ambiguous, stays unqualified
    assert_eq!(
        qualify_sql("SELECT name FROM users JOIN orders ON id = user_id", &s),
        "SELECT users.name FROM users INNER JOIN orders ON id = orders.user_id"
    );
}