pgmt 0.5.0

PostgreSQL migration tool that keeps your schema files as the source of truth
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

//! SQL rendering for constraint operations

use crate::catalog::id::DbObjectId;
use crate::diff::operations::ConstraintOperation;
use crate::render::{RenderedSql, SqlRenderer};

impl SqlRenderer for ConstraintOperation {
    fn to_sql(&self) -> Vec<RenderedSql> {
        match self {
            ConstraintOperation::Create(constraint) => {
                vec![RenderedSql::new(
                    crate::render::sql::render_create_constraint(constraint),
                )]
            }
            ConstraintOperation::Drop(identifier) => {
                vec![RenderedSql::new(
                    crate::render::sql::render_drop_constraint(
                        &identifier.schema,
                        &identifier.table_name,
                        &identifier.name,
                    ),
                )]
            }
        }
    }

    fn db_object_id(&self) -> DbObjectId {
        match self {
            ConstraintOperation::Create(constraint) => constraint.id(),
            ConstraintOperation::Drop(identifier) => identifier.to_db_object_id(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::catalog::constraint::{Constraint, ConstraintType};
    use crate::diff::operations::ConstraintIdentifier;
    use crate::render::Safety;

    fn create_unique_constraint() -> Constraint {
        Constraint {
            schema: "public".to_string(),
            table_name: "users".to_string(),
            name: "users_email_key".to_string(),
            constraint_type: ConstraintType::Unique {
                columns: vec!["email".to_string()],
            },
            comment: None,
            depends_on: vec![],
        }
    }

    fn create_fk_constraint() -> Constraint {
        Constraint {
            schema: "public".to_string(),
            table_name: "orders".to_string(),
            name: "orders_user_id_fkey".to_string(),
            constraint_type: ConstraintType::ForeignKey {
                columns: vec!["user_id".to_string()],
                referenced_schema: "public".to_string(),
                referenced_table: "users".to_string(),
                referenced_columns: vec!["id".to_string()],
                on_delete: Some("CASCADE".to_string()),
                on_update: None,
                deferrable: false,
                initially_deferred: false,
            },
            comment: None,
            depends_on: vec![],
        }
    }

    #[test]
    fn test_render_create_unique_constraint() {
        let constraint = create_unique_constraint();
        let op = ConstraintOperation::Create(constraint);
        let rendered = op.to_sql();
        assert_eq!(rendered.len(), 1);
        assert!(rendered[0].sql.contains("ALTER TABLE"));
        assert!(rendered[0].sql.contains("ADD CONSTRAINT"));
        assert!(rendered[0].sql.contains("users_email_key"));
        assert!(rendered[0].sql.contains("UNIQUE"));
        assert_eq!(rendered[0].safety, Safety::Safe);
    }

    #[test]
    fn test_render_create_fk_constraint() {
        let constraint = create_fk_constraint();
        let op = ConstraintOperation::Create(constraint);
        let rendered = op.to_sql();
        assert_eq!(rendered.len(), 1);
        assert!(rendered[0].sql.contains("FOREIGN KEY"));
        assert!(rendered[0].sql.contains("REFERENCES"));
        assert!(rendered[0].sql.contains("ON DELETE CASCADE"));
    }

    #[test]
    fn test_render_drop_constraint() {
        let identifier = ConstraintIdentifier {
            schema: "public".to_string(),
            table_name: "users".to_string(),
            name: "users_email_key".to_string(),
        };
        let op = ConstraintOperation::Drop(identifier);
        let rendered = op.to_sql();
        assert_eq!(rendered.len(), 1);
        assert!(rendered[0].sql.contains("ALTER TABLE"));
        assert!(rendered[0].sql.contains("DROP CONSTRAINT"));
        assert!(rendered[0].sql.contains("users_email_key"));
        assert_eq!(rendered[0].safety, Safety::Safe);
    }

    #[test]
    fn test_has_destructive_sql() {
        let constraint = create_unique_constraint();
        let identifier = ConstraintIdentifier::from_constraint(&constraint);

        let create_op = ConstraintOperation::Create(constraint);
        let drop_op = ConstraintOperation::Drop(identifier);

        // Constraints can be recreated from schema, so DROP CONSTRAINT is not destructive
        assert!(
            !create_op
                .to_sql()
                .iter()
                .any(|s| s.safety == Safety::Destructive)
        );
        assert!(
            !drop_op
                .to_sql()
                .iter()
                .any(|s| s.safety == Safety::Destructive)
        );
    }

    #[test]
    fn test_db_object_id() {
        let constraint = create_unique_constraint();
        let op = ConstraintOperation::Create(constraint.clone());
        assert_eq!(
            op.db_object_id(),
            DbObjectId::Constraint {
                schema: "public".to_string(),
                table: "users".to_string(),
                name: "users_email_key".to_string()
            }
        );
    }
}