pgevolve-core 0.3.3

Postgres declarative schema management — core library (parser, IR, diff, planner) powering the pgevolve CLI.
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
//! SQL emission for view and MV planner steps.
//!
//! Each `emit_*` function produces a single canonical SQL statement string
//! (always ending with `;`) suitable for direct embedding in `plan.sql`.
//! Output is deterministic: same input IR always produces the same bytes.

use crate::identifier::{Identifier, QualifiedName};
use crate::ir::view::{MaterializedView, View};

// ---------------------------------------------------------------------------
// Views
// ---------------------------------------------------------------------------

/// `CREATE [OR REPLACE] VIEW qname [(columns)] [WITH (...)] AS <body>;`
pub(crate) fn emit_create_view(v: &View, or_replace: bool) -> String {
    let mut sql = String::new();
    if or_replace {
        sql.push_str("CREATE OR REPLACE VIEW ");
    } else {
        sql.push_str("CREATE VIEW ");
    }
    sql.push_str(&v.qname.render_sql());
    if !v.columns.is_empty() {
        sql.push_str(" (");
        for (i, c) in v.columns.iter().enumerate() {
            if i > 0 {
                sql.push_str(", ");
            }
            sql.push_str(&c.name.render_sql());
        }
        sql.push(')');
    }
    if let Some(opts) = view_with_clause(v) {
        sql.push_str(" WITH (");
        sql.push_str(&opts);
        sql.push(')');
    }
    sql.push_str(" AS\n");
    let body = v.body_canonical.canonical_text().trim_end();
    sql.push_str(body);
    if !sql.ends_with(';') {
        sql.push(';');
    }
    sql
}

fn view_with_clause(v: &View) -> Option<String> {
    let mut parts: Vec<String> = Vec::new();
    if let Some(b) = v.security_barrier {
        parts.push(format!("security_barrier = {b}"));
    }
    if let Some(i) = v.security_invoker {
        parts.push(format!("security_invoker = {i}"));
    }
    if parts.is_empty() {
        None
    } else {
        Some(parts.join(", "))
    }
}

/// `DROP VIEW qname;`
pub(crate) fn emit_drop_view(qname: &QualifiedName) -> String {
    format!("DROP VIEW {};", qname.render_sql())
}

/// `ALTER VIEW qname SET (security_barrier = ..., ...);`
pub(crate) fn emit_alter_view_set_reloption(
    qname: &QualifiedName,
    security_barrier: Option<bool>,
    security_invoker: Option<bool>,
) -> String {
    let mut parts: Vec<String> = Vec::new();
    if let Some(b) = security_barrier {
        parts.push(format!("security_barrier = {b}"));
    }
    if let Some(i) = security_invoker {
        parts.push(format!("security_invoker = {i}"));
    }
    format!(
        "ALTER VIEW {} SET ({});",
        qname.render_sql(),
        parts.join(", ")
    )
}

/// `COMMENT ON VIEW qname IS '...'|NULL;`
pub(crate) fn emit_comment_on_view(qname: &QualifiedName, comment: Option<&str>) -> String {
    match comment {
        Some(c) => format!(
            "COMMENT ON VIEW {} IS '{}';",
            qname.render_sql(),
            c.replace('\'', "''"),
        ),
        None => format!("COMMENT ON VIEW {} IS NULL;", qname.render_sql()),
    }
}

/// `COMMENT ON COLUMN qname.col IS '...'|NULL;`
///
/// Used for view column comments (PG uses the same `COMMENT ON COLUMN` syntax
/// for both table and view columns).
pub(crate) fn emit_comment_on_view_column(
    qname: &QualifiedName,
    column: &Identifier,
    comment: Option<&str>,
) -> String {
    let col_ref = format!("{}.{}", qname.render_sql(), column.render_sql());
    match comment {
        Some(c) => format!(
            "COMMENT ON COLUMN {col_ref} IS '{}';",
            c.replace('\'', "''")
        ),
        None => format!("COMMENT ON COLUMN {col_ref} IS NULL;"),
    }
}

// ---------------------------------------------------------------------------
// Materialized views
// ---------------------------------------------------------------------------

/// `CREATE MATERIALIZED VIEW qname [(columns)] AS <body>\nWITH NO DATA;`
pub(crate) fn emit_create_materialized_view(mv: &MaterializedView) -> String {
    let mut sql = String::new();
    sql.push_str("CREATE MATERIALIZED VIEW ");
    sql.push_str(&mv.qname.render_sql());
    if !mv.columns.is_empty() {
        sql.push_str(" (");
        for (i, c) in mv.columns.iter().enumerate() {
            if i > 0 {
                sql.push_str(", ");
            }
            sql.push_str(&c.name.render_sql());
        }
        sql.push(')');
    }
    sql.push_str(" AS\n");
    // Body should NOT end with `;` — the `WITH NO DATA` clause follows.
    let body = mv.body_canonical.canonical_text().trim_end();
    let body = body.trim_end_matches(';');
    sql.push_str(body);
    sql.push_str("\nWITH NO DATA;");
    sql
}

/// `DROP MATERIALIZED VIEW qname;`
pub(crate) fn emit_drop_materialized_view(qname: &QualifiedName) -> String {
    format!("DROP MATERIALIZED VIEW {};", qname.render_sql())
}

/// `REFRESH MATERIALIZED VIEW [CONCURRENTLY] qname;`
pub(crate) fn emit_refresh_mv(qname: &QualifiedName, concurrently: bool) -> String {
    if concurrently {
        format!(
            "REFRESH MATERIALIZED VIEW CONCURRENTLY {};",
            qname.render_sql()
        )
    } else {
        format!("REFRESH MATERIALIZED VIEW {};", qname.render_sql())
    }
}

/// `COMMENT ON MATERIALIZED VIEW qname IS '...'|NULL;`
pub(crate) fn emit_comment_on_materialized_view(
    qname: &QualifiedName,
    comment: Option<&str>,
) -> String {
    match comment {
        Some(c) => format!(
            "COMMENT ON MATERIALIZED VIEW {} IS '{}';",
            qname.render_sql(),
            c.replace('\'', "''"),
        ),
        None => format!(
            "COMMENT ON MATERIALIZED VIEW {} IS NULL;",
            qname.render_sql()
        ),
    }
}

/// `COMMENT ON COLUMN qname.col IS '...'|NULL;`
///
/// PG treats MV columns the same as table columns for `COMMENT ON COLUMN`.
pub(crate) fn emit_comment_on_mv_column(
    qname: &QualifiedName,
    column: &Identifier,
    comment: Option<&str>,
) -> String {
    let col_ref = format!("{}.{}", qname.render_sql(), column.render_sql());
    match comment {
        Some(c) => format!(
            "COMMENT ON COLUMN {col_ref} IS '{}';",
            c.replace('\'', "''")
        ),
        None => format!("COMMENT ON COLUMN {col_ref} IS NULL;"),
    }
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;
    use crate::identifier::Identifier;
    use crate::ir::column_type::ColumnType;
    use crate::ir::view::ViewColumn;
    use crate::parse::normalize_body::NormalizedBody;

    fn id(s: &str) -> Identifier {
        Identifier::from_unquoted(s).unwrap()
    }

    fn qn(schema: &str, name: &str) -> QualifiedName {
        QualifiedName::new(id(schema), id(name))
    }

    fn body(sql: &str) -> NormalizedBody {
        NormalizedBody::from_sql(sql).unwrap()
    }

    fn simple_view() -> View {
        View {
            qname: qn("app", "active_users"),
            columns: vec![],
            body_canonical: body("SELECT id, email FROM app.users WHERE active"),
            body_dependencies: vec![],
            security_barrier: None,
            security_invoker: None,
            comment: None,
            raw_body: String::new(),
            owner: None,
            grants: vec![],
        }
    }

    fn simple_mv() -> MaterializedView {
        MaterializedView {
            qname: qn("app", "user_summary"),
            columns: vec![],
            body_canonical: body("SELECT count(*) FROM app.users"),
            body_dependencies: vec![],
            comment: None,
            raw_body: String::new(),
            owner: None,
            grants: vec![],
            storage: crate::ir::reloptions::MaterializedViewStorageOptions::default(),
        }
    }

    // --- emit_create_view ---

    #[test]
    fn create_view_basic() {
        let v = simple_view();
        let sql = emit_create_view(&v, false);
        assert_eq!(
            sql,
            "CREATE VIEW app.active_users AS\nSELECT id, email FROM app.users WHERE active;"
        );
    }

    #[test]
    fn create_view_or_replace() {
        let v = simple_view();
        let sql = emit_create_view(&v, true);
        assert!(sql.starts_with("CREATE OR REPLACE VIEW app.active_users AS\n"));
    }

    #[test]
    fn create_view_with_explicit_columns() {
        let v = View {
            columns: vec![
                ViewColumn {
                    name: id("a"),
                    column_type: ColumnType::BigInt,
                    comment: None,
                },
                ViewColumn {
                    name: id("b"),
                    column_type: ColumnType::Text,
                    comment: None,
                },
            ],
            ..simple_view()
        };
        let sql = emit_create_view(&v, false);
        assert!(
            sql.contains("(a, b)"),
            "expected explicit column list, got: {sql}"
        );
    }

    #[test]
    fn create_view_with_security_barrier() {
        let v = View {
            security_barrier: Some(true),
            ..simple_view()
        };
        let sql = emit_create_view(&v, false);
        assert!(sql.contains("WITH (security_barrier = true)"), "got: {sql}");
    }

    #[test]
    fn create_view_with_both_reloptions() {
        let v = View {
            security_barrier: Some(false),
            security_invoker: Some(true),
            ..simple_view()
        };
        let sql = emit_create_view(&v, false);
        assert!(
            sql.contains("WITH (security_barrier = false, security_invoker = true)"),
            "got: {sql}"
        );
    }

    #[test]
    fn create_view_body_already_ends_with_semicolon() {
        // NormalizedBody strips trailing whitespace but may or may not have ';'.
        // emit_create_view always ensures exactly one trailing ';'.
        let v = simple_view();
        let sql = emit_create_view(&v, false);
        assert!(sql.ends_with(';'));
        // Only one trailing semicolon.
        assert!(!sql.ends_with(";;"));
    }

    // --- emit_drop_view ---

    #[test]
    fn drop_view_basic() {
        assert_eq!(
            emit_drop_view(&qn("app", "old_view")),
            "DROP VIEW app.old_view;"
        );
    }

    // --- emit_alter_view_set_reloption ---

    #[test]
    fn alter_view_set_reloption_single() {
        let sql = emit_alter_view_set_reloption(&qn("app", "v"), Some(true), None);
        assert_eq!(sql, "ALTER VIEW app.v SET (security_barrier = true);");
    }

    #[test]
    fn alter_view_set_reloption_both() {
        let sql = emit_alter_view_set_reloption(&qn("app", "v"), Some(false), Some(true));
        assert_eq!(
            sql,
            "ALTER VIEW app.v SET (security_barrier = false, security_invoker = true);"
        );
    }

    // --- emit_comment_on_view ---

    #[test]
    fn comment_on_view_set() {
        let sql = emit_comment_on_view(&qn("app", "v"), Some("my comment"));
        assert_eq!(sql, "COMMENT ON VIEW app.v IS 'my comment';");
    }

    #[test]
    fn comment_on_view_clear() {
        let sql = emit_comment_on_view(&qn("app", "v"), None);
        assert_eq!(sql, "COMMENT ON VIEW app.v IS NULL;");
    }

    #[test]
    fn comment_on_view_escapes_single_quotes() {
        let sql = emit_comment_on_view(&qn("app", "v"), Some("it's a view"));
        assert_eq!(sql, "COMMENT ON VIEW app.v IS 'it''s a view';");
    }

    // --- emit_comment_on_view_column ---

    #[test]
    fn comment_on_view_column_set() {
        let sql = emit_comment_on_view_column(&qn("app", "v"), &id("col"), Some("the col"));
        assert_eq!(sql, "COMMENT ON COLUMN app.v.col IS 'the col';");
    }

    #[test]
    fn comment_on_view_column_clear() {
        let sql = emit_comment_on_view_column(&qn("app", "v"), &id("col"), None);
        assert_eq!(sql, "COMMENT ON COLUMN app.v.col IS NULL;");
    }

    // --- emit_create_materialized_view ---

    #[test]
    fn create_materialized_view_basic() {
        let mv = simple_mv();
        let sql = emit_create_materialized_view(&mv);
        assert_eq!(
            sql,
            "CREATE MATERIALIZED VIEW app.user_summary AS\nSELECT count(*) FROM app.users\nWITH NO DATA;"
        );
    }

    #[test]
    fn create_materialized_view_does_not_double_semicolon() {
        let mv = simple_mv();
        let sql = emit_create_materialized_view(&mv);
        // Should end with exactly "WITH NO DATA;"
        assert!(sql.ends_with("WITH NO DATA;"));
        assert!(!sql.ends_with("WITH NO DATA;;"));
    }

    #[test]
    fn create_materialized_view_with_columns() {
        let mv = MaterializedView {
            columns: vec![ViewColumn {
                name: id("total"),
                column_type: ColumnType::BigInt,
                comment: None,
            }],
            ..simple_mv()
        };
        let sql = emit_create_materialized_view(&mv);
        assert!(sql.contains("(total)"), "expected column list, got: {sql}");
    }

    // --- emit_drop_materialized_view ---

    #[test]
    fn drop_materialized_view_basic() {
        assert_eq!(
            emit_drop_materialized_view(&qn("app", "user_summary")),
            "DROP MATERIALIZED VIEW app.user_summary;"
        );
    }

    // --- emit_refresh_mv ---

    #[test]
    fn refresh_mv_basic() {
        let sql = emit_refresh_mv(&qn("app", "user_summary"), false);
        assert_eq!(sql, "REFRESH MATERIALIZED VIEW app.user_summary;");
    }

    #[test]
    fn refresh_mv_concurrently() {
        let sql = emit_refresh_mv(&qn("app", "user_summary"), true);
        assert_eq!(
            sql,
            "REFRESH MATERIALIZED VIEW CONCURRENTLY app.user_summary;"
        );
    }

    // --- emit_comment_on_materialized_view ---

    #[test]
    fn comment_on_mv_set() {
        let sql = emit_comment_on_materialized_view(&qn("app", "mv"), Some("summary"));
        assert_eq!(sql, "COMMENT ON MATERIALIZED VIEW app.mv IS 'summary';");
    }

    #[test]
    fn comment_on_mv_clear() {
        let sql = emit_comment_on_materialized_view(&qn("app", "mv"), None);
        assert_eq!(sql, "COMMENT ON MATERIALIZED VIEW app.mv IS NULL;");
    }

    #[test]
    fn comment_on_mv_escapes_quotes() {
        let sql = emit_comment_on_materialized_view(&qn("app", "mv"), Some("it's fast"));
        assert_eq!(sql, "COMMENT ON MATERIALIZED VIEW app.mv IS 'it''s fast';");
    }

    // --- emit_comment_on_mv_column ---

    #[test]
    fn comment_on_mv_column_set() {
        let sql = emit_comment_on_mv_column(&qn("app", "mv"), &id("total"), Some("the total"));
        assert_eq!(sql, "COMMENT ON COLUMN app.mv.total IS 'the total';");
    }

    #[test]
    fn comment_on_mv_column_clear() {
        let sql = emit_comment_on_mv_column(&qn("app", "mv"), &id("total"), None);
        assert_eq!(sql, "COMMENT ON COLUMN app.mv.total IS NULL;");
    }
}