uqa-sql 0.4.0

PostgreSQL-compatible SQL compiler built on libpg_query
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
//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

use super::*;
use crate::ast::{
    AlterRoutineKind, FromClause, FunctionParallel, FunctionParamMode, FunctionVolatility,
    RoutineConfigAction, RoutineRevokeBehavior,
};

#[test]
fn role_rename_preserves_literal_names_and_unifies_role_user_and_group_aliases() {
    for alias in ["ROLE", "USER", "GROUP"] {
        let statement = first(&format!(
            "ALTER {alias} \"CURRENT_USER\" RENAME TO \"PUBLIC\""
        ));
        let Statement::RenameRole(rename) = &statement else {
            panic!("expected role rename: {statement:?}")
        };
        assert_eq!(rename.name, "CURRENT_USER");
        assert_eq!(rename.new_name, "PUBLIC");
        let encoded = serde_json::to_string(&statement).unwrap();
        let Statement::RenameRole(restored) = serde_json::from_str::<Statement>(&encoded).unwrap()
        else {
            panic!("expected role rename after decoding")
        };
        assert_eq!(&restored, rename);
    }
    let Statement::RenameRole(rename) = first("ALTER ROLE Source RENAME TO Destination") else {
        panic!("expected role rename")
    };
    assert_eq!(rename.name, "source");
    assert_eq!(rename.new_name, "destination");
}

fn variadic_value(expression: &Expr) -> &Expr {
    crate::expr::variadic_argument_value(expression)
        .unwrap_or_else(|| panic!("expected VARIADIC marker, got {expression:?}"))
}

#[test]
fn variadic_declarations_compile_and_survive_serde() {
    let statement = first(
        "CREATE FUNCTION collect(VARIADIC items integer[]) RETURNS integer[] LANGUAGE sql AS $$ SELECT items $$",
    );
    let Statement::CreateFunction(function) = &statement else {
        panic!("expected CREATE FUNCTION");
    };
    assert_eq!(function.params.len(), 1);
    assert_eq!(function.params[0].mode, FunctionParamMode::Variadic);
    assert_eq!(function.params[0].type_name, "int4[]");
    assert_eq!(function.identity_arity(), 1);
    assert_eq!(function.call_arity(), 1);

    let encoded = serde_json::to_string(&statement).unwrap();
    let decoded: Statement = serde_json::from_str(&encoded).unwrap();
    let Statement::CreateFunction(decoded) = decoded else {
        panic!("expected CREATE FUNCTION after round trip");
    };
    assert_eq!(decoded.params[0].mode, FunctionParamMode::Variadic);
}

#[test]
fn explicit_variadic_marker_survives_scalar_from_and_call_lowering() {
    let Statement::Select(select) = first("SELECT f(VARIADIC ARRAY[1, 2])") else {
        panic!("expected SELECT");
    };
    let Expr::Func { args, .. } = &select.projections[0].expr else {
        panic!("expected scalar function");
    };
    assert!(matches!(variadic_value(&args[0]), Expr::Array(values) if values.len() == 2));

    let Statement::Select(select) = first("SELECT f(VARIADIC items => ARRAY[1, 2])") else {
        panic!("expected SELECT");
    };
    let Expr::Func { args, .. } = &select.projections[0].expr else {
        panic!("expected scalar function");
    };
    assert!(matches!(
        &args[0],
        Expr::Func { binding, .. }
            if binding.as_ref().and_then(|binding| binding.dispatch)
                == Some(crate::ast::FunctionDispatch::NamedArgument)
    ));
    assert!(matches!(variadic_value(&args[0]), Expr::Array(values) if values.len() == 2));

    let Statement::Select(select) = first("SELECT * FROM f(VARIADIC ARRAY[1, 2])") else {
        panic!("expected SELECT");
    };
    let Some(FromClause::Function { args, .. }) = &select.from else {
        panic!("expected FROM function");
    };
    assert!(matches!(variadic_value(&args[0]), Expr::Array(values) if values.len() == 2));

    let Statement::Call { args, .. } = first("CALL p(VARIADIC ARRAY[1, 2])") else {
        panic!("expected CALL");
    };
    assert!(matches!(variadic_value(&args[0]), Expr::Array(values) if values.len() == 2));
}

#[test]
fn explicit_variadic_call_marker_survives_serde() {
    let statement = first("SELECT f(VARIADIC ARRAY[1, 2])");
    let encoded = serde_json::to_string(&statement).unwrap();
    assert!(encoded.contains("VariadicArgument"));
    let decoded: Statement = serde_json::from_str(&encoded).unwrap();
    let Statement::Select(select) = decoded else {
        panic!("expected SELECT after round trip");
    };
    let Expr::Func { args, .. } = &select.projections[0].expr else {
        panic!("expected scalar function after round trip");
    };
    assert!(matches!(variadic_value(&args[0]), Expr::Array(values) if values.len() == 2));
}

#[test]
fn alter_function_compiles_exact_identity_and_supported_attributes() {
    let statement =
        first("ALTER FUNCTION app.f(IN integer, OUT text, INOUT bigint) IMMUTABLE STRICT");
    let Statement::AlterRoutine(alter) = statement else {
        panic!("expected ALTER FUNCTION");
    };
    assert_eq!(alter.kind, AlterRoutineKind::Function);
    assert_eq!(alter.name, "app.f");
    assert_eq!(alter.arg_types.as_deref().unwrap(), ["int4", "int8"]);
    assert!(alter.arg_type_references.is_empty());
    assert_eq!(alter.volatility, Some(FunctionVolatility::Immutable));
    assert_eq!(alter.strict, Some(true));
}

#[test]
fn alter_procedure_and_routine_preserve_target_kind_and_null_input_action() {
    let Statement::AlterRoutine(procedure) =
        first("ALTER PROCEDURE app.p(IN integer, OUT text) STABLE CALLED ON NULL INPUT")
    else {
        panic!("expected ALTER PROCEDURE");
    };
    assert_eq!(procedure.kind, AlterRoutineKind::Procedure);
    assert_eq!(procedure.arg_types.as_deref().unwrap(), ["int4"]);
    assert_eq!(procedure.volatility, Some(FunctionVolatility::Stable));
    assert_eq!(procedure.strict, Some(false));

    let Statement::AlterRoutine(routine) = first("ALTER ROUTINE app.f(integer) VOLATILE") else {
        panic!("expected ALTER ROUTINE");
    };
    assert_eq!(routine.kind, AlterRoutineKind::Routine);
    assert_eq!(routine.volatility, Some(FunctionVolatility::Volatile));
    assert_eq!(routine.strict, None);
}

#[test]
fn alter_function_preserves_percent_type_identity_and_serde_defaults() {
    let statement = first("ALTER FUNCTION app.f(source.value%TYPE) STABLE");
    let Statement::AlterRoutine(alter) = &statement else {
        panic!("expected ALTER FUNCTION");
    };
    assert_eq!(alter.arg_types.as_deref().unwrap(), ["source.value%type"]);
    assert_eq!(alter.arg_type_references.len(), 1);
    let reference = alter.arg_type_references[0]
        .as_ref()
        .expect("%TYPE reference is retained");
    assert_eq!(reference.schema, None);
    assert_eq!(reference.relation, "source");
    assert_eq!(reference.column, "value");

    let decoded: Statement = serde_json::from_value(serde_json::to_value(&statement).unwrap())
        .expect("ALTER FUNCTION round trips");
    let Statement::AlterRoutine(decoded) = decoded else {
        panic!("expected ALTER FUNCTION after round trip");
    };
    assert_eq!(&decoded, alter);

    let mut encoded = serde_json::to_value(statement).unwrap();
    let fields = encoded["AlterRoutine"].as_object_mut().unwrap();
    fields.remove("arg_type_references");
    fields.remove("volatility");
    fields.remove("strict");
    let legacy: Statement = serde_json::from_value(encoded).unwrap();
    let Statement::AlterRoutine(legacy) = legacy else {
        panic!("expected ALTER FUNCTION");
    };
    assert!(legacy.arg_type_references.is_empty());
    assert_eq!(legacy.volatility, None);
    assert_eq!(legacy.strict, None);
}

#[test]
fn routine_security_ownership_acl_role_and_refcursor_statements_compile() {
    let Statement::CreateFunction(function) = first(
        "CREATE FUNCTION app.open_cursor(c refcursor) RETURNS refcursor LANGUAGE plpgsql SECURITY DEFINER LEAKPROOF PARALLEL SAFE SET search_path TO app, public AS $$ BEGIN RETURN c; END $$",
    ) else {
        panic!("expected CREATE FUNCTION");
    };
    assert_eq!(function.params[0].type_name, "refcursor");
    assert!(matches!(
        &function.returns,
        crate::ast::FunctionReturns::Scalar { type_name } if type_name == "refcursor"
    ));
    assert!(function.security.security_definer);
    assert!(function.security.leakproof);
    assert_eq!(function.parallel, FunctionParallel::Safe);
    assert_eq!(
        function.config_actions,
        [RoutineConfigAction::Set {
            name: "search_path".into(),
            value: "app,public".into(),
        }]
    );

    let Statement::AlterRoutine(alter) = first(
        "ALTER FUNCTION app.open_cursor(refcursor) SECURITY INVOKER NOT LEAKPROOF PARALLEL RESTRICTED SUPPORT app.support SET search_path FROM CURRENT",
    ) else {
        panic!("expected ALTER FUNCTION");
    };
    assert_eq!(alter.security_definer, Some(false));
    assert_eq!(alter.leakproof, Some(false));
    assert_eq!(alter.parallel, Some(FunctionParallel::Restricted));
    assert_eq!(alter.support, Some("app.support".into()));
    assert_eq!(
        alter.config_actions,
        [RoutineConfigAction::FromCurrent {
            name: "search_path".into(),
        }]
    );

    let Statement::AlterRoutine(reset) =
        first("ALTER FUNCTION app.open_cursor(refcursor) SET search_path TO DEFAULT")
    else {
        panic!("expected ALTER FUNCTION");
    };
    assert_eq!(
        reset.config_actions,
        [RoutineConfigAction::Reset {
            name: "search_path".into(),
        }]
    );

    let Statement::AlterRoutineOwner(owner) =
        first("ALTER FUNCTION app.open_cursor(refcursor) OWNER TO routine_owner")
    else {
        panic!("expected ALTER FUNCTION OWNER");
    };
    assert_eq!(owner.name, "app.open_cursor");
    assert_eq!(owner.arg_types.as_deref().unwrap(), ["refcursor"]);
    assert_eq!(
        owner.new_owner,
        crate::ast::RoleSpecification::from("routine_owner")
    );

    let Statement::GrantRoutine(grant) = first(
        "GRANT ALL PRIVILEGES ON FUNCTION app.open_cursor(refcursor) TO routine_caller, PUBLIC WITH GRANT OPTION",
    ) else {
        panic!("expected GRANT EXECUTE");
    };
    assert!(grant.is_grant);
    assert!(grant.grant_option);
    assert_eq!(
        grant.grantees,
        [
            "routine_caller".into(),
            crate::ast::AclRoleSpecification::Public
        ]
    );
    assert_eq!(grant.items[0].arg_types.as_deref().unwrap(), ["refcursor"]);
    assert_eq!(grant.grantor, None);
    assert_eq!(grant.revoke_behavior, RoutineRevokeBehavior::Restrict);

    let Statement::GrantRoutine(revoke) = first(
        "REVOKE GRANT OPTION FOR EXECUTE ON FUNCTION app.open_cursor(refcursor) FROM routine_caller GRANTED BY CURRENT_USER CASCADE",
    ) else {
        panic!("expected REVOKE EXECUTE");
    };
    assert!(!revoke.is_grant);
    assert!(revoke.grant_option_only);
    assert_eq!(
        revoke.grantor,
        Some(crate::ast::RoleSpecification::CurrentUser)
    );
    assert_eq!(revoke.revoke_behavior, RoutineRevokeBehavior::Cascade);

    assert!(matches!(
        first("CREATE ROLE routine_caller LOGIN CREATEDB CONNECTION LIMIT 4"),
        Statement::CreateRole(_)
    ));
    assert!(matches!(
        first("ALTER ROLE routine_caller NOLOGIN NOCREATEDB"),
        Statement::AlterRole(_)
    ));
    assert!(matches!(
        first("DROP ROLE IF EXISTS routine_caller"),
        Statement::DropRole(_)
    ));
}

#[test]
fn alter_function_preserves_an_omitted_signature_for_unique_resolution() {
    let Statement::AlterRoutine(alter) = first("ALTER FUNCTION app.f IMMUTABLE") else {
        panic!("expected ALTER FUNCTION");
    };
    assert_eq!(alter.arg_types, None);
    assert!(alter.arg_type_references.is_empty());

    let Statement::AlterRoutine(zero_arity) = first("ALTER FUNCTION app.f() IMMUTABLE") else {
        panic!("expected ALTER FUNCTION");
    };
    assert_eq!(zero_arity.arg_types, Some(Vec::new()));
}

#[test]
fn routine_rename_preserves_kind_identity_and_new_identifier() {
    let Statement::RenameRoutine(function) =
        first("ALTER FUNCTION app.f(integer) RENAME TO renamed")
    else {
        panic!("expected function rename");
    };
    assert_eq!(function.kind, AlterRoutineKind::Function);
    assert_eq!(function.name, "app.f");
    assert_eq!(function.arg_types.as_deref().unwrap(), ["int4"]);
    assert_eq!(function.new_name, "renamed");

    let Statement::RenameRoutine(procedure) =
        first("ALTER PROCEDURE app.p RENAME TO \"Case.Name\"")
    else {
        panic!("expected procedure rename");
    };
    assert_eq!(procedure.kind, AlterRoutineKind::Procedure);
    assert_eq!(procedure.arg_types, None);
    assert_eq!(procedure.new_name, "\"Case.Name\"");

    let Statement::RenameRoutine(routine) =
        first("ALTER ROUTINE app.f(source.value%TYPE) RENAME TO g")
    else {
        panic!("expected routine rename");
    };
    assert_eq!(routine.kind, AlterRoutineKind::Routine);
    assert_eq!(routine.arg_type_references.len(), 1);
}

#[test]
fn pg18_role_membership_statements_preserve_options_and_legacy_entry_points() {
    let Statement::GrantRole(grant) = first(
        "GRANT parent_role, audit_role TO member_role, CURRENT_USER WITH ADMIN OPTION, INHERIT FALSE, SET TRUE GRANTED BY grantor_role",
    ) else {
        panic!("expected GRANT ROLE");
    };
    assert!(grant.is_grant);
    assert_eq!(grant.granted_roles, ["parent_role", "audit_role"]);
    assert_eq!(
        grant.grantee_roles,
        [
            crate::ast::RoleSpecification::Named("member_role".into()),
            crate::ast::RoleSpecification::CurrentUser
        ]
    );
    assert_eq!(grant.options.admin, Some(true));
    assert_eq!(grant.options.inherit, Some(false));
    assert_eq!(grant.options.set, Some(true));
    assert_eq!(
        grant.grantor,
        Some(crate::ast::RoleSpecification::Named("grantor_role".into()))
    );
    assert!(!grant.cascade);

    let Statement::GrantRole(revoke) = first(
        "REVOKE ADMIN OPTION FOR parent_role FROM member_role GRANTED BY grantor_role CASCADE",
    ) else {
        panic!("expected REVOKE ROLE");
    };
    assert!(!revoke.is_grant);
    assert_eq!(revoke.options.admin, Some(false));
    assert_eq!(revoke.options.inherit, None);
    assert_eq!(revoke.options.set, None);
    assert!(revoke.cascade);

    let Statement::CreateRole(create) =
        first("CREATE ROLE created_role IN ROLE parent_role ROLE member_role ADMIN admin_member")
    else {
        panic!("expected CREATE ROLE");
    };
    assert_eq!(
        create.in_roles,
        [crate::ast::RoleSpecification::Named("parent_role".into())]
    );
    assert_eq!(
        create.role_members,
        [crate::ast::RoleSpecification::Named("member_role".into())]
    );
    assert_eq!(
        create.admin_members,
        [crate::ast::RoleSpecification::Named("admin_member".into())]
    );

    let Statement::AlterRole(alter) =
        first("ALTER GROUP parent_role ADD USER first_member, second_member")
    else {
        panic!("expected ALTER GROUP");
    };
    assert_eq!(
        alter.membership_action,
        Some(crate::ast::RoleMembershipAction::Add)
    );
    assert_eq!(
        alter.members,
        [
            crate::ast::RoleSpecification::Named("first_member".into()),
            crate::ast::RoleSpecification::Named("second_member".into())
        ]
    );
}

#[test]
fn role_commands_keep_quoted_keyword_names_distinct_from_session_references() {
    use crate::ast::RoleSpecification::{CurrentUser, Named, SessionUser};
    let Statement::GrantRole(grant) =
        first("GRANT \"CURRENT_USER\" TO \"SESSION_USER\", CURRENT_USER GRANTED BY SESSION_USER")
    else {
        panic!("GRANT")
    };
    assert_eq!(grant.granted_roles, ["CURRENT_USER"]);
    assert_eq!(
        grant.grantee_roles,
        [Named("SESSION_USER".into()), CurrentUser]
    );
    assert_eq!(grant.grantor, Some(SessionUser));
    let Statement::CreateRole(create) = first(
        "CREATE ROLE created IN ROLE \"CURRENT_USER\" ROLE SESSION_USER ADMIN \"SESSION_USER\"",
    ) else {
        panic!("CREATE")
    };
    assert_eq!(create.in_roles, [Named("CURRENT_USER".into())]);
    assert_eq!(create.role_members, [SessionUser]);
    assert_eq!(create.admin_members, [Named("SESSION_USER".into())]);
    let Statement::AlterRole(alter) = first("ALTER GROUP \"CURRENT_USER\" ADD USER SESSION_USER")
    else {
        panic!("ALTER")
    };
    assert_eq!(alter.name, Named("CURRENT_USER".into()));
    assert_eq!(alter.members, [SessionUser]);
    let Statement::DropRole(drop) = first("DROP ROLE \"CURRENT_USER\", CURRENT_USER") else {
        panic!("DROP")
    };
    assert_eq!(drop.names, [Named("CURRENT_USER".into()), CurrentUser]);
}