polyglot-sql 0.6.2

SQL parsing, validating, formatting, and dialect translation library
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
use std::{cell::RefCell, collections::HashMap};

use polyglot_sql::dialects::transform_recursive;
use polyglot_sql::expressions::{
    Cast, DataType, Expression, JoinKind, LikeOp, Literal, StructField,
};
use polyglot_sql::generator::{Generator, GeneratorConfig};
use polyglot_sql::{
    parse, rename_tables, replace_by_type, transform, transform_map, DialectType, ExpressionWalk,
    Parser,
};

fn parse_one(sql: &str) -> Expression {
    Parser::parse_sql(sql)
        .unwrap_or_else(|e| panic!("failed to parse {sql:?}: {e}"))
        .into_iter()
        .next()
        .expect("expected one statement")
}

fn parse_one_dialect(sql: &str, dialect: DialectType) -> Expression {
    parse(sql, dialect)
        .unwrap_or_else(|e| panic!("failed to parse {sql:?}: {e}"))
        .into_iter()
        .next()
        .expect("expected one statement")
}

fn generate_with_dialect(expr: &Expression, dialect: DialectType) -> String {
    let config = GeneratorConfig {
        dialect: Some(dialect),
        ..Default::default()
    };
    let mut generator = Generator::with_config(config);
    generator
        .generate(expr)
        .unwrap_or_else(|e| panic!("failed to generate {dialect:?} SQL: {e}"))
}

fn first_index(order: &[String], target: &str) -> usize {
    order
        .iter()
        .position(|name| name == target)
        .unwrap_or_else(|| panic!("missing {target} in visit order: {order:?}"))
}

fn rename_predicate_children(node: Expression) -> Expression {
    match node {
        Expression::Table(mut table) => {
            if table
                .schema
                .as_ref()
                .is_some_and(|schema| schema.name == "src")
            {
                table.schema = Some(polyglot_sql::expressions::Identifier::quoted("dst"));
            }
            Expression::Table(table)
        }
        Expression::Column(mut column) => {
            column.name.name = match column.name.name.as_str() {
                "x" => "lhs".to_string(),
                "y" => "rhs".to_string(),
                _ => column.name.name,
            };
            Expression::Column(column)
        }
        other => other,
    }
}

fn assert_predicate_children_renamed(sql: &str) {
    let expression = parse_one_dialect(sql, DialectType::PostgreSQL);
    let transformed = transform_map(expression, &|node| Ok(rename_predicate_children(node)))
        .expect("predicate child transform should succeed");
    let sql = generate_with_dialect(&transformed, DialectType::PostgreSQL);

    assert!(sql.contains("\"dst\".a"), "{sql}");
    assert!(sql.contains("lhs"), "{sql}");
    assert!(sql.contains("rhs"), "{sql}");
    assert!(!sql.contains("src."), "{sql}");
    if sql.contains("FROM") && sql.matches("FROM").count() > 1 {
        assert!(sql.contains("\"dst\".b"), "{sql}");
    }
}

#[test]
fn transform_recursive_visits_children_before_parents() {
    let expr = parse_one("SELECT a + 1 AS x");
    let order = RefCell::new(Vec::new());

    let transformed = transform_recursive(expr, &|node| {
        order.borrow_mut().push(node.variant_name().to_string());
        Ok(node)
    })
    .expect("transform should succeed");

    assert!(matches!(transformed, Expression::Select(_)));

    let order = order.into_inner();
    assert!(first_index(&order, "column") < first_index(&order, "add"));
    assert!(first_index(&order, "literal") < first_index(&order, "add"));
    assert!(first_index(&order, "add") < first_index(&order, "alias"));
    assert!(first_index(&order, "alias") < first_index(&order, "select"));
}

#[test]
fn transform_map_visits_quantified_comparison_children() {
    for sql in [
        "SELECT * FROM src.a WHERE x = ANY (SELECT y FROM src.b)",
        "SELECT * FROM src.a WHERE x <> ALL (SELECT y FROM src.b)",
        "SELECT * FROM src.a WHERE x < ANY (SELECT y FROM src.b)",
        "SELECT * FROM src.a WHERE x <= ALL (SELECT y FROM src.b)",
        "SELECT * FROM src.a WHERE x > ANY (SELECT y FROM src.b)",
        "SELECT * FROM src.a WHERE x >= ALL (SELECT y FROM src.b)",
        "SELECT * FROM src.a WHERE x = SOME (SELECT y FROM src.b)",
        "SELECT x = ANY(ARRAY[y]) FROM src.a",
    ] {
        assert_predicate_children_renamed(sql);
    }
}

#[test]
fn transform_map_visits_null_safe_comparison_children() {
    for sql in [
        "SELECT * FROM src.a WHERE x IS DISTINCT FROM (SELECT y FROM src.b)",
        "SELECT * FROM src.a WHERE x IS NOT DISTINCT FROM (SELECT y FROM src.b)",
    ] {
        assert_predicate_children_renamed(sql);
    }
}

#[test]
fn affected_predicates_preserve_bottom_up_transform_order() {
    for (sql, parent) in [
        (
            "SELECT * FROM src.a WHERE x = ANY (SELECT y FROM src.b)",
            "any",
        ),
        (
            "SELECT * FROM src.a WHERE x = ALL (SELECT y FROM src.b)",
            "all",
        ),
        (
            "SELECT * FROM src.a WHERE x IS NOT DISTINCT FROM (SELECT y FROM src.b)",
            "null_safe_eq",
        ),
        (
            "SELECT * FROM src.a WHERE x IS DISTINCT FROM (SELECT y FROM src.b)",
            "null_safe_neq",
        ),
    ] {
        let expression = parse_one_dialect(sql, DialectType::PostgreSQL);
        let order = RefCell::new(Vec::new());
        transform_recursive(expression, &|node| {
            let label = match &node {
                Expression::Column(column) => format!("column:{}", column.name.name),
                Expression::Table(table) => format!("table:{}", table.name.name),
                _ => node.variant_name().to_string(),
            };
            order.borrow_mut().push(label);
            Ok(node)
        })
        .expect("transform should succeed");

        let order = order.into_inner();
        assert!(first_index(&order, "column:x") < first_index(&order, parent));
        assert!(first_index(&order, "column:y") < first_index(&order, parent));
        assert!(first_index(&order, "table:b") < first_index(&order, parent));
    }
}

#[test]
fn delegated_transform_entry_points_visit_quantified_subqueries() {
    let sql = "SELECT * FROM a WHERE x > ALL (SELECT y FROM b)";
    let rename_nested_table = |node: Expression| match node {
        Expression::Table(mut table) if table.name.name == "b" => {
            table.name.name = "renamed_b".to_string();
            Expression::Table(table)
        }
        other => other,
    };

    let transformed = transform(parse_one_dialect(sql, DialectType::PostgreSQL), &|node| {
        Ok(Some(rename_nested_table(node)))
    })
    .expect("optional transform should succeed");
    assert!(generate_with_dialect(&transformed, DialectType::PostgreSQL).contains("FROM renamed_b"));

    let transformed = parse_one_dialect(sql, DialectType::PostgreSQL)
        .transform_owned(|node| Ok(Some(rename_nested_table(node))))
        .expect("owned transform should succeed");
    assert!(generate_with_dialect(&transformed, DialectType::PostgreSQL).contains("FROM renamed_b"));

    let mapping = HashMap::from([("b".to_string(), "renamed_b".to_string())]);
    let transformed = rename_tables(parse_one_dialect(sql, DialectType::PostgreSQL), &mapping);
    assert!(generate_with_dialect(&transformed, DialectType::PostgreSQL).contains("FROM renamed_b"));
}

#[test]
fn transform_recursive_applies_join_wrapper_transform() {
    let expr = parse_one("SELECT * FROM a JOIN b ON a.id = b.id");

    let transformed = transform_recursive(expr, &|node| match node {
        Expression::Join(mut join) => {
            join.kind = JoinKind::Left;
            Ok(Expression::Join(join))
        }
        other => Ok(other),
    })
    .expect("transform should succeed");

    let Expression::Select(select) = transformed else {
        panic!("expected select");
    };
    assert_eq!(select.joins.len(), 1);
    assert_eq!(select.joins[0].kind, JoinKind::Left);
}

#[test]
fn transform_recursive_rejects_non_join_from_join_wrapper() {
    let expr = parse_one("SELECT * FROM a JOIN b ON a.id = b.id");

    let err = transform_recursive(expr, &|node| match node {
        Expression::Join(_) => Ok(Expression::identifier("not_a_join")),
        other => Ok(other),
    })
    .expect_err("join wrapper should reject non-join result");

    let message = err.to_string();
    assert!(
        message.contains("non-join expression"),
        "unexpected error: {message}"
    );
}

#[test]
fn transform_recursive_applies_ordered_wrapper_transform() {
    let expr = parse_one("SELECT * FROM a ORDER BY x NULLS LAST");

    let transformed = transform_recursive(expr, &|node| match node {
        Expression::Ordered(mut ordered) => {
            ordered.desc = true;
            ordered.nulls_first = Some(true);
            Ok(Expression::Ordered(ordered))
        }
        other => Ok(other),
    })
    .expect("transform should succeed");

    let Expression::Select(select) = transformed else {
        panic!("expected select");
    };
    let order_by = select.order_by.expect("expected order by");
    assert_eq!(order_by.expressions.len(), 1);
    assert!(order_by.expressions[0].desc);
    assert_eq!(order_by.expressions[0].nulls_first, Some(true));
}

#[test]
fn transform_recursive_preserves_ordered_original_when_wrapper_transform_errors() {
    let expr = parse_one("SELECT * FROM a ORDER BY x NULLS LAST");
    let original_sql = expr.sql();

    let transformed = transform_recursive(expr, &|node| match node {
        Expression::Ordered(_) => Err(polyglot_sql::Error::Parse {
            message: "ordered wrapper failure".to_string(),
            line: 0,
            column: 0,
            start: 0,
            end: 0,
        }),
        other => Ok(other),
    })
    .expect("ordered wrapper failure should fall back to original");

    assert_eq!(transformed.sql(), original_sql);
}

#[test]
fn transform_recursive_preserves_cte_body_when_child_transform_errors() {
    let expr = parse_one("WITH cte AS (SELECT 1) SELECT * FROM cte");
    let original_sql = expr.sql();

    let transformed = transform_recursive(expr, &|node| match node {
        Expression::Literal(_) => Err(polyglot_sql::Error::Parse {
            message: "literal transform failure".to_string(),
            line: 0,
            column: 0,
            start: 0,
            end: 0,
        }),
        other => Ok(other),
    })
    .expect("cte child failure should fall back to original body");

    assert_eq!(transformed.sql(), original_sql);
}

#[test]
fn transform_recursive_renames_update_target_from_and_join_tables() {
    let expr = parse_one_dialect(
        "UPDATE employees e \
         SET salary = s.new_salary \
         FROM salary_updates s \
         JOIN department_updates d ON d.id = s.department_id \
         WHERE e.id = s.employee_id \
         RETURNING e.id",
        DialectType::PostgreSQL,
    );
    let mapping = HashMap::from([
        ("employees".to_string(), "table_1".to_string()),
        ("salary_updates".to_string(), "table_2".to_string()),
        ("department_updates".to_string(), "table_3".to_string()),
    ]);

    let transformed = rename_tables(expr, &mapping);
    let sql = generate_with_dialect(&transformed, DialectType::PostgreSQL);

    assert!(sql.contains("UPDATE table_1 AS e"), "{sql}");
    assert!(sql.contains("FROM table_2 AS s"), "{sql}");
    assert!(sql.contains("JOIN table_3 AS d"), "{sql}");
    assert!(!sql.contains("employees"), "{sql}");
    assert!(!sql.contains("salary_updates"), "{sql}");
    assert!(!sql.contains("department_updates"), "{sql}");
}

#[test]
fn replace_by_type_visits_delete_using_and_returning_fields() {
    let expr = parse_one_dialect(
        "DELETE FROM employees e \
         USING salary_updates s \
         WHERE e.id = s.employee_id \
         RETURNING e.id",
        DialectType::PostgreSQL,
    );
    let mapping = HashMap::from([
        ("employees".to_string(), "table_1".to_string()),
        ("salary_updates".to_string(), "table_2".to_string()),
    ]);

    let transformed = replace_by_type(
        expr,
        |node| {
            matches!(node, Expression::Table(table) if mapping.contains_key(&table.name.name))
                || matches!(node, Expression::Column(column) if column.name.name == "id")
        },
        |node| match node {
            Expression::Table(mut table) => {
                table.name.name = mapping[&table.name.name].clone();
                Expression::Table(table)
            }
            Expression::Column(mut column) => {
                column.name.name = "employee_id".to_string();
                Expression::Column(column)
            }
            other => other,
        },
    );
    let sql = generate_with_dialect(&transformed, DialectType::PostgreSQL);

    assert!(sql.contains("DELETE FROM table_1 e"), "{sql}");
    assert!(sql.contains("USING table_2 AS s"), "{sql}");
    assert!(sql.contains("RETURNING e.employee_id"), "{sql}");
    assert!(!sql.contains("employees"), "{sql}");
    assert!(!sql.contains("salary_updates"), "{sql}");
}

#[test]
fn replace_by_type_visits_update_output_clause() {
    let expr = parse_one_dialect(
        "UPDATE employees \
         SET salary = 1 \
         OUTPUT INSERTED.id INTO audit \
         WHERE id = 1",
        DialectType::TSQL,
    );

    let transformed = replace_by_type(
        expr,
        |node| {
            matches!(node, Expression::Table(table) if table.name.name == "employees")
                || matches!(node, Expression::Column(column) if column.name.name == "audit")
        },
        |node| match node {
            Expression::Table(mut table) => {
                table.name.name = "table_1".to_string();
                Expression::Table(table)
            }
            Expression::Column(mut column) => {
                column.name.name = "audit_redacted".to_string();
                Expression::Column(column)
            }
            other => other,
        },
    );
    let sql = generate_with_dialect(&transformed, DialectType::TSQL);

    assert!(sql.contains("UPDATE table_1"), "{sql}");
    assert!(
        sql.contains("OUTPUT INSERTED.id INTO audit_redacted"),
        "{sql}"
    );
    assert!(!sql.contains("employees"), "{sql}");
    assert!(!sql.contains("INTO audit "), "{sql}");
}

#[test]
fn transform_recursive_rewrites_nested_cast_data_types() {
    let expr = Expression::Cast(Box::new(Cast {
        this: Expression::column("value"),
        to: DataType::Array {
            element_type: Box::new(DataType::Struct {
                fields: vec![
                    StructField::new(
                        "a".to_string(),
                        DataType::Int {
                            length: None,
                            integer_spelling: false,
                        },
                    ),
                    StructField::new(
                        "b".to_string(),
                        DataType::Array {
                            element_type: Box::new(DataType::Int {
                                length: None,
                                integer_spelling: false,
                            }),
                            dimension: None,
                        },
                    ),
                ],
                nested: false,
            }),
            dimension: None,
        },
        trailing_comments: Vec::new(),
        double_colon_syntax: false,
        format: None,
        default: None,
        inferred_type: None,
    }));

    let transformed = transform_recursive(expr, &|node| match node {
        Expression::DataType(DataType::Int { .. }) => {
            Ok(Expression::DataType(DataType::BigInt { length: None }))
        }
        other => Ok(other),
    })
    .expect("transform should succeed");

    let Expression::Cast(cast) = transformed else {
        panic!("expected cast");
    };
    let DataType::Array { element_type, .. } = cast.to else {
        panic!("expected array type");
    };
    let DataType::Struct { fields, .. } = *element_type else {
        panic!("expected struct type");
    };
    assert!(matches!(fields[0].data_type, DataType::BigInt { .. }));
    let DataType::Array { element_type, .. } = &fields[1].data_type else {
        panic!("expected nested array");
    };
    assert!(matches!(element_type.as_ref(), DataType::BigInt { .. }));
}

#[test]
fn transform_recursive_visits_generated_child_metadata() {
    let expression = Expression::Like(Box::new(LikeOp {
        left: Expression::column("name"),
        right: Expression::Literal(Box::new(Literal::String("x%".to_string()))),
        escape: Some(Expression::Literal(Box::new(Literal::String(
            "!".to_string(),
        )))),
        quantifier: None,
        inferred_type: None,
    }));

    let transformed = transform_recursive(expression, &|node| match node {
        Expression::Literal(mut literal) if literal.is_string() && literal.value_str() == "!" => {
            *literal = Literal::String("#".to_string());
            Ok(Expression::Literal(literal))
        }
        other => Ok(other),
    })
    .expect("generated child should transform");

    let Expression::Like(like) = transformed else {
        panic!("expected LIKE expression");
    };
    assert!(matches!(
        like.escape,
        Some(Expression::Literal(literal)) if literal.is_string() && literal.value_str() == "#"
    ));
}