schema-sql-generator 0.6.6

A set of tools to manage relational database schemas
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
use crate::common::generator_context::GeneratorContext;
use crate::common::trigger_generator::TriggerGenerator;
use crate::sql_println;
use schema_model::model::table::Table;
use schema_model::model::types::{DatabaseType, ForeignKeyMode, RelationType, TriggerType};

pub struct PostgresTriggerGenerator {
    context: GeneratorContext,
}

impl PostgresTriggerGenerator {
    pub fn new(context: GeneratorContext) -> Self {
        Self { context }
    }

    fn should_output_delete_trigger(&self, table: &Table) -> bool {
        let has_delete_triggers = table
            .triggers()
            .iter()
            .any(|t| t.trigger_type() == TriggerType::Delete);

        let has_reverse_relations_with_triggers = !table.reverse_relations().is_empty()
            && self.context.settings().foreign_key_mode() == ForeignKeyMode::Triggers;

        let has_aggregations = !table.aggregations().is_empty();

        has_delete_triggers || has_reverse_relations_with_triggers || has_aggregations
    }

    fn should_output_update_trigger(&self, table: &Table) -> bool {
        let has_update_triggers = table
            .triggers()
            .iter()
            .any(|t| t.trigger_type() == TriggerType::Update);

        let has_relations_with_triggers = !table.relations().is_empty()
            && self.context.settings().foreign_key_mode() == ForeignKeyMode::Triggers;

        let has_aggregations = !table.aggregations().is_empty();

        has_update_triggers || has_relations_with_triggers || has_aggregations
    }

}

impl TriggerGenerator for PostgresTriggerGenerator {
    fn output_triggers(&self) {
        let database_model = self.context.settings().database_model();
        let separator = self.context.settings().statement_separator();

        for table in database_model.all_tables() {
            if self.should_output_delete_trigger(table) && table.primary_key().is_some() {
                self.output_delete_trigger(table, separator);
            }

            if self.should_output_update_trigger(table) {
                self.output_update_trigger(table, separator);
            }
        }
    }
}

impl PostgresTriggerGenerator {
    fn output_delete_trigger(&self, table: &Table, separator: &str) {
        let database_type = self.context.settings().database_type();
        let table_name = table.name().to_lowercase();
        let fn_name = format!("{}_delete", table_name);
        let fully_qualified_table = table.fully_qualified_table_name(database_type);
        let fully_qualified_fn = format!(
            "{}.{}",
            table.schema_name().unwrap_or(DatabaseType::Postgresql.default_schema().unwrap()),
            fn_name
        );

        self.context.with_writer(|writer| {
            sql_println!(writer, "/* {} */", fully_qualified_fn);
            sql_println!(
                writer,
                "create or replace function {}() returns trigger as $BODY$"
            ,
                fully_qualified_fn
            );
            sql_println!(writer, "begin");

            if self.context.settings().foreign_key_mode() == ForeignKeyMode::Triggers {
                // A reverse relation carries the *original* relation's fields unchanged
                // (attached to the parent for convenient lookup): `from_table_name`/
                // `from_column_name` identify the child table and its FK column, while
                // `to_table_name`/`to_column_name` still refer to this table (the parent)
                // itself. The child table must be resolved via `from_table_name`, not
                // `to_table_name` - using `to_table_name` here would resolve back to this
                // same table and generate a trigger that deletes/updates/checks itself.
                for relation in table.reverse_relations() {
                    match relation.relation_type() {
                        RelationType::Enforce => {
                            let child_table = self.database_model().find_table_by_qualified_name(relation.from_table_name());
                            sql_println!(
                                writer,
                                "   if (select count(*) from {} where {} = OLD.{}) > 0 then",
                                child_table.fully_qualified_table_name(database_type),
                                relation.from_column_name(),
                                relation.to_column_name()
                            );
                            sql_println!(
                                writer,
                                "      raise exception 'The row in {} cannot be deleted. It is being used by a row in the {} table.';",
                                fully_qualified_table,
                                child_table.fully_qualified_table_name(database_type)
                            );
                            sql_println!(writer, "   end if;");
                        }
                        RelationType::SetNull => {
                            let child_table = self.database_model().find_table_by_qualified_name(relation.from_table_name());
                            sql_println!(
                                writer,
                                "   update {} set {} = null where {} = OLD.{};",
                                child_table.fully_qualified_table_name(database_type),
                                relation.from_column_name(),
                                relation.from_column_name(),
                                relation.to_column_name()
                            );
                        }
                        RelationType::Cascade => {
                            let child_table = self.database_model().find_table_by_qualified_name(relation.from_table_name());
                            sql_println!(
                                writer,
                                "   delete from {} where {} = OLD.{};",
                                child_table.fully_qualified_table_name(database_type),
                                relation.from_column_name(),
                                relation.to_column_name()
                            );
                        }
                        RelationType::DoNothing => {}
                    }
                }
            }

            for custom_trigger in table.triggers() {
                if custom_trigger.trigger_type() == TriggerType::Delete
                    && custom_trigger.database_type() == DatabaseType::Postgresql
                {
                    sql_println!(writer, "{}", custom_trigger.trigger_text());
                }
            }

            sql_println!(writer, "   return null;");
            sql_println!(writer, "end;");
            sql_println!(writer, "$BODY$ language plpgsql{}", separator);
            sql_println!(writer, "");

            sql_println!(writer, "drop trigger if exists {} on {} cascade{}", fn_name, fully_qualified_table, separator);
            sql_println!(
                writer,
                "create trigger {} after delete on {}",
                fn_name,
                fully_qualified_table
            );
            sql_println!(writer, "   for each row execute procedure {}(){}", fully_qualified_fn, separator);
            sql_println!(writer, "");
        });
    }

    fn output_update_trigger(&self, table: &Table, separator: &str) {
        let database_type = self.context.settings().database_type();
        let table_name = table.name().to_lowercase();
        let fn_name = format!("{}_update", table_name);
        let fully_qualified_table = table.fully_qualified_table_name(database_type);
        let fully_qualified_fn = format!(
            "{}.{}",
            table.schema_name().unwrap_or(DatabaseType::Postgresql.default_schema().unwrap()),
            fn_name
        );

        self.context.with_writer(|writer| {
            sql_println!(writer, "/* {} */", fully_qualified_fn);
            sql_println!(
                writer,
                "create or replace function {}() returns trigger as $BODY$"
            ,
                fully_qualified_fn
            );
            sql_println!(writer, "begin");

            if self.context.settings().foreign_key_mode() == ForeignKeyMode::Triggers {
                for relation in table.relations() {
                    match relation.relation_type() {
                        RelationType::Enforce | RelationType::SetNull | RelationType::Cascade => {
                            let to_table = self.database_model().find_table_by_qualified_name(relation.to_table_name());
                            sql_println!(
                                writer,
                                "   if new.{} is not null then",
                                relation.from_column_name()
                            );
                            sql_println!(
                                writer,
                                "      if (select count(*) from {} where {} = new.{}) = 0 then",
                                to_table.fully_qualified_table_name(database_type),
                                relation.to_column_name(),
                                relation.from_column_name()
                            );
                            sql_println!(
                                writer,
                                "         raise exception 'The value of {} was not found in the {} table.';",
                                relation.from_column_name(),
                                to_table.fully_qualified_table_name(database_type)
                            );
                            sql_println!(writer, "      end if;");
                            sql_println!(writer, "   end if;");
                        }
                        RelationType::DoNothing => {}
                    }
                }
            }

            for custom_trigger in table.triggers() {
                if custom_trigger.trigger_type() == TriggerType::Update
                    && custom_trigger.database_type() == DatabaseType::Postgresql
                {
                    sql_println!(writer, "{}", custom_trigger.trigger_text());
                }
            }

            sql_println!(writer, "   return new;");
            sql_println!(writer, "end;");
            sql_println!(writer, "$BODY$ language plpgsql{}", separator);
            sql_println!(writer, "");

            sql_println!(writer, "drop trigger if exists {} on {} cascade{}", fn_name, fully_qualified_table, separator);
            sql_println!(
                writer,
                "create trigger {} after insert or update on {}",
                fn_name,
                fully_qualified_table
            );
            sql_println!(writer, "   for each row execute procedure {}(){}", fully_qualified_fn, separator);
            sql_println!(writer, "");
        });
    }

    fn database_model(&self) -> &schema_model::model::database_model::DatabaseModel {
        self.context.settings().database_model()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::common::test_support::make_context_with_fk_mode;
    use schema_model::builder::{ColumnBuilder, SchemaBuilder, TableBuilder};
    use schema_model::model::column_type::ColumnType;
    use schema_model::model::database_model::DatabaseModel;
    use schema_model::model::relation::Relation;
    use schema_model::model::types::{BooleanMode, DatabaseType, ForeignKeyMode, RelationType};

    fn build_model_with_relation() -> DatabaseModel {
        let parent = TableBuilder::new(Some("app"), "parent")
            .add_column(ColumnBuilder::new(None::<&str>, "id", ColumnType::Sequence).required(true).build())
            .build();
        let child = TableBuilder::new(Some("app"), "child")
            .add_column(ColumnBuilder::new(None::<&str>, "parent_id", ColumnType::Int).build())
            .add_relation(Relation::new("app.parent", "id", "child", "parent_id", RelationType::Enforce, false))
            .build();
        let schema = SchemaBuilder::new(Some("app"))
            .add_table(parent)
            .add_table(child)
            .build();
        DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema])
    }

    fn build_model_with_unqualified_relation() -> DatabaseModel {
        let parent = TableBuilder::new(None::<&str>, "parent")
            .add_column(ColumnBuilder::new(None::<&str>, "id", ColumnType::Sequence).required(true).build())
            .build();
        let child = TableBuilder::new(None::<&str>, "child")
            .add_column(ColumnBuilder::new(None::<&str>, "parent_id", ColumnType::Int).build())
            .add_relation(Relation::new("parent", "id", "child", "parent_id", RelationType::Enforce, false))
            .build();
        let schema = SchemaBuilder::new(None::<&str>)
            .add_table(parent)
            .add_table(child)
            .build();
        DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema])
    }

    #[test]
    fn output_triggers_renders_update_validation_trigger_for_relations_mode_triggers() {
        let model = build_model_with_relation();
        let (ctx, buffer) = make_context_with_fk_mode(model, DatabaseType::Postgresql, ForeignKeyMode::Triggers);

        let generator = PostgresTriggerGenerator::new(ctx);
        generator.output_triggers();

        let output = buffer.contents();
        assert!(output.contains("create or replace function app.child_update() returns trigger"));
        assert!(output.contains("was not found in the app.parent table"));
        assert!(output.contains("create trigger child_update after insert or update on app.child"));
    }

    #[test]
    fn output_triggers_resolves_unqualified_to_table_name_in_default_schema() {
        let model = build_model_with_unqualified_relation();
        let (ctx, buffer) = make_context_with_fk_mode(model, DatabaseType::Postgresql, ForeignKeyMode::Triggers);

        let generator = PostgresTriggerGenerator::new(ctx);
        generator.output_triggers();

        let output = buffer.contents();
        assert!(output.contains("was not found in the public.parent table"));
    }

    #[test]
    fn output_triggers_does_nothing_when_relations_mode_is_not_triggers() {
        let model = build_model_with_relation();
        let (ctx, buffer) = make_context_with_fk_mode(model, DatabaseType::Postgresql, ForeignKeyMode::Relations);

        let generator = PostgresTriggerGenerator::new(ctx);
        generator.output_triggers();

        assert_eq!(buffer.contents(), "");
    }

    /// Builds parent/child tables with both the forward relation (on `child`, used for the
    /// update trigger) and the matching reverse relation attached to `parent` (used for the
    /// delete trigger) - mirroring what `convert::reverse_relations()` does for a real parsed
    /// schema, since these unit tests build the model directly via builders rather than XML.
    fn build_model_with_reverse_relation(relation_type: RelationType) -> DatabaseModel {
        let mut parent = TableBuilder::new(Some("app"), "parent")
            .add_column(ColumnBuilder::new(None::<&str>, "id", ColumnType::Sequence).required(true).build())
            .add_key(schema_model::builder::KeyBuilder::new(schema_model::model::types::KeyType::Primary).add_column("id").build())
            .build();
        parent.add_reverse_relation(Relation::new("app.parent", "id", "app.child", "parent_id", relation_type, false));

        let child = TableBuilder::new(Some("app"), "child")
            .add_column(ColumnBuilder::new(None::<&str>, "parent_id", ColumnType::Int).build())
            .add_relation(Relation::new("app.parent", "id", "child", "parent_id", relation_type, false))
            .build();
        let schema = SchemaBuilder::new(Some("app"))
            .add_table(parent)
            .add_table(child)
            .build();
        DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema])
    }

    #[test]
    fn output_delete_trigger_enforce_checks_the_child_table_not_itself() {
        let model = build_model_with_reverse_relation(RelationType::Enforce);
        let (ctx, buffer) = make_context_with_fk_mode(model, DatabaseType::Postgresql, ForeignKeyMode::Triggers);

        let generator = PostgresTriggerGenerator::new(ctx);
        generator.output_triggers();

        let output = buffer.contents();
        assert!(output.contains("create or replace function app.parent_delete"));
        assert!(output.contains("if (select count(*) from app.child where parent_id = OLD.id) > 0"));
        assert!(output.contains("cannot be deleted. It is being used by a row in the app.child table"));
    }

    #[test]
    fn output_delete_trigger_setnull_updates_the_child_table_not_itself() {
        let model = build_model_with_reverse_relation(RelationType::SetNull);
        let (ctx, buffer) = make_context_with_fk_mode(model, DatabaseType::Postgresql, ForeignKeyMode::Triggers);

        let generator = PostgresTriggerGenerator::new(ctx);
        generator.output_triggers();

        let output = buffer.contents();
        assert!(output.contains("update app.child set parent_id = null where parent_id = OLD.id;"));
    }

    #[test]
    fn output_delete_trigger_cascade_deletes_from_the_child_table_not_itself() {
        let model = build_model_with_reverse_relation(RelationType::Cascade);
        let (ctx, buffer) = make_context_with_fk_mode(model, DatabaseType::Postgresql, ForeignKeyMode::Triggers);

        let generator = PostgresTriggerGenerator::new(ctx);
        generator.output_triggers();

        let output = buffer.contents();
        assert!(output.contains("delete from app.child where parent_id = OLD.id;"));
    }

    #[test]
    fn output_delete_trigger_uses_the_relations_own_column_for_a_composite_primary_key() {
        // The parent has a composite primary key (id, tenant_id); the relation specifically
        // references `id`. The delete trigger must match on the relation's own referenced
        // column, not an arbitrarily-picked primary key column.
        let mut parent = TableBuilder::new(Some("app"), "parent")
            .add_column(ColumnBuilder::new(None::<&str>, "id", ColumnType::Sequence).required(true).build())
            .add_column(ColumnBuilder::new(None::<&str>, "tenant_id", ColumnType::Int).required(true).build())
            .add_key(
                schema_model::builder::KeyBuilder::new(schema_model::model::types::KeyType::Primary)
                    .add_column("id")
                    .add_column("tenant_id")
                    .build(),
            )
            .build();
        parent.add_reverse_relation(Relation::new("app.parent", "id", "app.child", "parent_id", RelationType::Cascade, false));

        let child = TableBuilder::new(Some("app"), "child")
            .add_column(ColumnBuilder::new(None::<&str>, "parent_id", ColumnType::Int).build())
            .build();
        let schema = SchemaBuilder::new(Some("app"))
            .add_table(parent)
            .add_table(child)
            .build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_fk_mode(model, DatabaseType::Postgresql, ForeignKeyMode::Triggers);

        let generator = PostgresTriggerGenerator::new(ctx);
        generator.output_triggers();

        let output = buffer.contents();
        assert!(output.contains("delete from app.child where parent_id = OLD.id;"));
    }
}