pgevolve-core 0.4.0

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

//! Shared `#[cfg(test)]` helpers used by per-rule lint tests.

#![cfg(test)]
#![allow(dead_code)]

use crate::identifier::{Identifier, QualifiedName};
use crate::ir::catalog::Catalog;
use crate::lint::source_tree::SourceTree;

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

pub fn qn(s: &str, n: &str) -> QualifiedName {
    QualifiedName::new(id(s), id(n))
}

pub fn empty_tree(catalog: Catalog) -> SourceTree {
    SourceTree::new(catalog, std::collections::HashMap::new())
}

pub fn make_plpgsql_function(
    schema: &str,
    name: &str,
    body_text: &str,
    deps: Vec<crate::plan::edges::DepEdge>,
) -> crate::ir::function::Function {
    use crate::ir::function::{
        FunctionLanguage, NormalizedArgTypes, ParallelSafety, ReturnType, SecurityMode, Volatility,
    };
    use crate::parse::normalize_body::NormalizedBody;
    let args = vec![];
    let arg_types_normalized = NormalizedArgTypes::from_args(&args);
    crate::ir::function::Function {
        qname: qn(schema, name),
        args,
        arg_types_normalized,
        return_type: ReturnType::Void,
        language: FunctionLanguage::PlPgSql,
        // PL/pgSQL bodies can't be parsed by pg_query — use from_raw_canonical.
        body: NormalizedBody::from_raw_canonical(body_text.to_string()),
        body_dependencies: deps,
        volatility: Volatility::Volatile,
        strict: false,
        security: SecurityMode::Invoker,
        parallel: ParallelSafety::Unsafe,
        leakproof: false,
        cost: None,
        rows: None,
        comment: None,
        owner: None,
        grants: vec![],
    }
}

/// Build a zero-arg `NormalizedArgTypes` for use in test `NodeId::Function` variants.
pub fn empty_arg_types() -> crate::ir::function::NormalizedArgTypes {
    crate::ir::function::NormalizedArgTypes::from_args(&[])
}

pub fn make_procedure(
    schema: &str,
    name: &str,
    body_text: &str,
    commits_in_body: bool,
    deps: Vec<crate::plan::edges::DepEdge>,
) -> crate::ir::procedure::Procedure {
    use crate::ir::function::{FunctionLanguage, SecurityMode};
    use crate::parse::normalize_body::NormalizedBody;
    crate::ir::procedure::Procedure {
        qname: qn(schema, name),
        args: vec![],
        language: FunctionLanguage::PlPgSql,
        // PL/pgSQL bodies can't be parsed by pg_query — use from_raw_canonical.
        body: NormalizedBody::from_raw_canonical(body_text.to_string()),
        body_dependencies: deps,
        security: SecurityMode::Invoker,
        commits_in_body,
        comment: None,
        owner: None,
        grants: vec![],
    }
}

pub fn make_trigger(
    schema: &str,
    name: &str,
    table_schema: &str,
    table_name: &str,
    fn_schema: &str,
    fn_name: &str,
) -> crate::ir::trigger::Trigger {
    use crate::ir::constraint::Deferrable;
    use crate::ir::trigger::{TriggerEvent, TriggerLevel, TriggerTiming};
    crate::ir::trigger::Trigger {
        qname: qn(schema, name),
        table: qn(table_schema, table_name),
        timing: TriggerTiming::Before,
        events: vec![TriggerEvent::Insert],
        level: TriggerLevel::Row,
        when_clause: None,
        transition_tables: vec![],
        function_qname: qn(fn_schema, fn_name),
        function_args: vec![],
        is_constraint: false,
        deferrable: Deferrable::NotDeferrable,
        comment: None,
    }
}

pub fn make_function_bare(schema: &str, name: &str) -> crate::ir::function::Function {
    make_plpgsql_function(schema, name, "BEGIN NULL; END", vec![])
}