schema-model 0.5.2

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
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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
use crate::model::enum_type::EnumType;
use crate::model::function::Function;
use crate::model::other_sql::OtherSql;
use crate::model::procedure::Procedure;
use crate::model::table::Table;
use crate::model::types::{DatabaseType, RelationType};
use crate::model::view::View;
use std::collections::HashMap;

#[derive(Debug)]
pub struct Schema {
    schema_name: Option<String>,
    case_sensitive_text: bool,
    tables: Vec<Table>,
    views: Vec<View>,
    functions: Vec<Function>,
    procedures: Vec<Procedure>,
    other_sql: Vec<OtherSql>,
    // Case-insensitive map: store lowercase name -> index in tables vec
    table_map: HashMap<String, usize>,
    enum_types: HashMap<String, EnumType>,
}

impl Default for Schema {
    fn default() -> Self {
        Self {
            schema_name: None,
            case_sensitive_text: true,
            tables: Vec::new(),
            views: Vec::new(),
            functions: Vec::new(),
            procedures: Vec::new(),
            other_sql: Vec::new(),
            table_map: HashMap::new(),
            enum_types: HashMap::new(),
        }
    }
}

impl Schema {
    pub fn new<S: Into<String>>(schema_name: Option<S>) -> Self {
        Self {
            schema_name: schema_name.map(|s| s.into()),
            ..Default::default()
        }
    }

    pub fn schema_name(&self) -> Option<&str> {
        self.schema_name.as_deref()
    }

    pub fn case_sensitive_text(&self) -> bool {
        self.case_sensitive_text
    }

    pub fn set_case_sensitive_text(&mut self, value: bool) {
        self.case_sensitive_text = value;
    }

    pub fn tables(&self) -> &[Table] {
        &self.tables
    }

    pub fn get_table(&self, name: &str) -> &Table {
        let idx = self.table_index(name);
        &self.tables[idx]
    }

    pub(crate) fn get_table_mut(&mut self, name: &str) -> &mut Table {
        let idx = self.table_index(name);
        &mut self.tables[idx]
    }

    /// Same as `get_table_mut`, but returns `None` instead of panicking when no table
    /// with this name exists - useful for callers (e.g. the XML parser) resolving
    /// possibly-malformed input, where a missing table should surface as an error
    /// rather than crash.
    pub fn get_table_mut_checked(&mut self, name: &str) -> Option<&mut Table> {
        let name_lower = name.to_lowercase();
        let idx = *self.table_map.get(&name_lower)?;
        Some(&mut self.tables[idx])
    }

    fn table_index(&self, name: &str) -> usize {
        let name_lower = name.to_lowercase();
        *self.table_map.get(&name_lower)
            .unwrap_or_else(|| panic!("Unable to locate a table with the name '{}'", name))
    }

    pub fn get_optional_table(&self, name: &str) -> Option<&Table> {
        let name_lower = name.to_lowercase();
        self.table_map.get(&name_lower).map(|&idx| &self.tables[idx])
    }

    pub fn all_views(&self) -> &[View] {
        &self.views
    }

    pub fn views(&self, database_type: DatabaseType) -> Vec<View> {
        self.views
            .iter()
            .filter(|view| view.database_type().is_none() || view.database_type().unwrap() == database_type)
            .cloned()
            .collect()
    }

    pub fn enum_types(&self) -> impl Iterator<Item = &EnumType> {
        let mut enum_types: Vec<&EnumType> = self.enum_types.values().collect();
        enum_types.sort_by(|a, b| a.name().cmp(b.name()));
        enum_types.into_iter()
    }

    pub fn get_enum_type(&self, type_name: &str) -> &EnumType {
        self.enum_types
            .get(&type_name.to_lowercase())
            .unwrap_or_else(|| panic!("Unable to locate an enum type with the name '{}'", type_name))
    }

    pub fn functions(&self) -> &[Function] {
        &self.functions
    }

    pub fn procedures(&self) -> &[Procedure] {
        &self.procedures
    }

    pub fn other_sql(&self) -> &[OtherSql] {
        &self.other_sql
    }

    pub fn validate(&self) -> Vec<String> {
        let mut errors: Vec<String> = Vec::new();
        for table in &self.tables {
            if table.columns().is_empty() {
                errors.push(format!(
                    "ERROR: table {} has no columns; generated `create table` SQL would be invalid",
                    table.name()
                ));
            }

            for relation in table.relations() {
                if relation.relation_type() == RelationType::SetNull {
                    let from_column_name = relation.from_column_name();
                    match table.has_column(from_column_name) {
                        true if table.column(from_column_name).is_required() => {
                            errors.push(format!(
                                "ERROR: {}.{} is required. The {}.{} relation specifies setnull, which is not allowed",
                                table.name(),
                                from_column_name,
                                relation.to_table_name(),
                                relation.to_column_name()
                            ));
                        }
                        true => {}
                        false => {
                            errors.push(format!(
                                "ERROR: {}.{} does not exist. The {}.{} relation refers to it as the source column",
                                table.name(),
                                from_column_name,
                                relation.to_table_name(),
                                relation.to_column_name()
                            ));
                        }
                    }
                }
            }

            for column in table.columns() {
                if let Some(enum_type_name) = column.enum_type()
                    && !self.enum_types.contains_key(&enum_type_name.to_lowercase())
                {
                    errors.push(format!(
                        "ERROR: {}.{} references enum type '{}' which is not defined in this schema",
                        table.name(),
                        column.name(),
                        enum_type_name
                    ));
                }

                if column.column_type() == crate::model::column_type::ColumnType::Array
                    && column.element_type().is_none()
                {
                    errors.push(format!(
                        "ERROR: {}.{} is an array column but has no elementType",
                        table.name(),
                        column.name()
                    ));
                }
            }
        }
        errors
    }

    pub(crate) fn add_table(&mut self, table: Table) {
        let idx = self.tables.len();
        self.table_map.insert(table.name().to_lowercase(), idx);
        self.tables.push(table);
    }

    /// Sorts the schema's tables alphabetically by name, in place. Must be called after all
    /// tables have been added, since it rebuilds the name -> index lookup used by `get_table`.
    pub fn sort_tables_by_name(&mut self) {
        self.tables.sort_by(|a, b| a.name().cmp(b.name()));

        self.table_map.clear();
        for (idx, table) in self.tables.iter().enumerate() {
            self.table_map.insert(table.name().to_lowercase(), idx);
        }
    }

    pub(crate) fn add_view(&mut self, view: View) {
        self.views.push(view);
    }

    pub(crate) fn add_enum_type(&mut self, enum_type: EnumType) {
        self.enum_types
            .insert(enum_type.name().to_lowercase(), enum_type);
    }

    pub(crate) fn add_functions(&mut self, functions: Vec<Function>) {
        self.functions.extend(functions);
    }

    pub(crate) fn add_procedures(&mut self, procedures: Vec<Procedure>) {
        self.procedures.extend(procedures);
    }

    pub(crate) fn add_other_sql(&mut self, other_sql: OtherSql) {
        self.other_sql.push(other_sql);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::model::column::Column;
    use crate::model::column_type::ColumnType;
    use crate::model::relation::Relation;

    fn make_schema() -> Schema {
        Schema::new(Some("schema"))
    }

    #[test]
    fn add_and_get_table_and_sort() {
        let mut schema = make_schema();
        let table1 = Table::new(
            Some("schema"),
            "Table1",
            Option::<&str>::None,
            crate::model::types::LockEscalation::Auto,
            false,
            vec![Column::new(Some("s"), "id", ColumnType::Int, 0, 0, true)],
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
        );
        let table2 = Table::new(
            Some("schema"),
            "Table2",
            Option::<&str>::None,
            crate::model::types::LockEscalation::Auto,
            false,
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
        );
        schema.add_table(table1);
        schema.add_table(table2);
        assert_eq!(schema.get_table("Table2").name(), "Table2"); // case-insensitive
        let names: Vec<_> = schema.tables().iter().map(|t| t.name()).collect();
        assert_eq!(names, vec!["Table1", "Table2"]);
        // table_map rebuilt so get_table still works
        assert_eq!(schema.get_table("Table1").name(), "Table1");
    }

    #[test]
    fn get_enum_type_is_case_insensitive() {
        // Matches the case-insensitive lookup used everywhere else in the model
        // (Table::column/has_column, Schema::get_table); a column declaring
        // `enumType="gendertype"` must still resolve an enum declared as `GenderType`.
        let mut schema = make_schema();
        schema.add_enum_type(EnumType::new("GenderType", Vec::new()));

        assert_eq!(schema.get_enum_type("GenderType").name(), "GenderType");
        assert_eq!(schema.get_enum_type("gendertype").name(), "GenderType");
        assert_eq!(schema.get_enum_type("GENDERTYPE").name(), "GenderType");
    }

    #[test]
    fn views_filtered_by_database_type() {
        let mut s = make_schema();
        s.add_view(View::new(Some("s"), "v1", "sql1", Some(DatabaseType::Postgresql)));
        s.add_view(View::new(Some("s"), "v2", "sql2", Some(DatabaseType::SqlServer)));
        let pg = s.views(DatabaseType::Postgresql);
        assert_eq!(pg.len(), 1);
        assert_eq!(pg[0].name(), "v1");
    }

    #[test]
    fn validate_setnull_error_when_required() {
        let mut s = make_schema();
        let parent = Table::new(
            Some("s"),
            "parent",
            Option::<&str>::None,
            crate::model::types::LockEscalation::Auto,
            false,
            vec![Column::new(Some("s"), "id", ColumnType::Int, 0, 0, true)],
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
        );
        s.add_table(parent);

        let child = Table::new(
            Some("s"),
            "child",
            Option::<&str>::None,
            crate::model::types::LockEscalation::Auto,
            false,
            vec![Column::new(Some("s"), "pid", ColumnType::Int, 0, 0, true)],
            Vec::new(),
            Vec::new(),
            vec![Relation::new(
                "parent",
                "id",
                "child",
                "pid",
                RelationType::SetNull,
                false,
            )],
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
        );
        s.add_table(child);

        let errors = s.validate();
        assert_eq!(errors.len(), 1);
        assert!(errors[0].contains("setnull"));
    }

    #[test]
    fn validate_reports_error_instead_of_panicking_when_from_column_is_missing() {
        // A relation whose `src` attribute doesn't match any real column on the table
        // (e.g. a typo in the XML) must surface as a validation error, not panic.
        let mut s = make_schema();
        let parent = Table::new(
            Some("s"),
            "parent",
            Option::<&str>::None,
            crate::model::types::LockEscalation::Auto,
            false,
            vec![Column::new(Some("s"), "id", ColumnType::Int, 0, 0, true)],
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
        );
        s.add_table(parent);

        let child = Table::new(
            Some("s"),
            "child",
            Option::<&str>::None,
            crate::model::types::LockEscalation::Auto,
            false,
            vec![Column::new(Some("s"), "pid", ColumnType::Int, 0, 0, true)],
            Vec::new(),
            Vec::new(),
            vec![Relation::new(
                "parent",
                "id",
                "child",
                "does_not_exist",
                RelationType::SetNull,
                false,
            )],
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
            Vec::new(),
        );
        s.add_table(child);

        let errors = s.validate();
        assert_eq!(errors.len(), 1);
        assert!(errors[0].contains("does_not_exist"));
    }

    #[test]
    fn validate_reports_error_for_column_referencing_an_undeclared_enum_type() {
        // A column's `enumType` attribute referencing a name with no matching `<enum>`
        // declaration must surface as a validation error - previously nothing caught
        // this, and it panicked deep in SQL generation instead (`get_enum_type`).
        use crate::builder::{ColumnBuilder, SchemaBuilder, TableBuilder};
        use crate::model::column_type::ColumnType as CT;

        let table = TableBuilder::new(Some("s"), "widget")
            .add_column(
                ColumnBuilder::new(Some("s"), "status", CT::Enum)
                    .enum_type(Some("StatusType".to_string()))
                    .build(),
            )
            .build();
        let schema = SchemaBuilder::new(Some("s")).add_table(table).build();

        let errors = schema.validate();
        assert_eq!(errors.len(), 1);
        assert!(errors[0].contains("StatusType"));
    }

    #[test]
    fn validate_reports_error_for_table_with_no_columns() {
        // A table with zero columns generates invalid `create table t (\n)` DDL; this
        // must be caught up front rather than crash/emit invalid SQL during generation.
        use crate::builder::{SchemaBuilder, TableBuilder};

        let table = TableBuilder::new(Some("s"), "widget").build();
        let schema = SchemaBuilder::new(Some("s")).add_table(table).build();

        let errors = schema.validate();
        assert_eq!(errors.len(), 1);
        assert!(errors[0].contains("widget"));
        assert!(errors[0].contains("no columns"));
    }

    #[test]
    fn validate_reports_error_for_array_column_missing_element_type() {
        use crate::builder::{ColumnBuilder, SchemaBuilder, TableBuilder};
        use crate::model::column_type::ColumnType as CT;

        let table = TableBuilder::new(Some("s"), "widget")
            .add_column(ColumnBuilder::new(Some("s"), "tags", CT::Array).build())
            .build();
        let schema = SchemaBuilder::new(Some("s")).add_table(table).build();

        let errors = schema.validate();
        assert_eq!(errors.len(), 1);
        assert!(errors[0].contains("tags"));
        assert!(errors[0].contains("elementType"));
    }

    #[test]
    fn validate_accepts_array_column_with_element_type_set() {
        use crate::builder::{ColumnBuilder, SchemaBuilder, TableBuilder};
        use crate::model::column_type::ColumnType as CT;

        let table = TableBuilder::new(Some("s"), "widget")
            .add_column(
                ColumnBuilder::new(Some("s"), "tags", CT::Array)
                    .element_type(Some("varchar".to_string()))
                    .build(),
            )
            .build();
        let schema = SchemaBuilder::new(Some("s")).add_table(table).build();

        assert!(schema.validate().is_empty());
    }

    #[test]
    fn validate_accepts_column_referencing_a_declared_enum_type_case_insensitively() {
        use crate::builder::{ColumnBuilder, SchemaBuilder, TableBuilder};
        use crate::model::column_type::ColumnType as CT;
        use crate::model::enum_type::EnumType;

        let table = TableBuilder::new(Some("s"), "widget")
            .add_column(
                ColumnBuilder::new(Some("s"), "status", CT::Enum)
                    .enum_type(Some("statustype".to_string()))
                    .build(),
            )
            .build();
        let schema = SchemaBuilder::new(Some("s"))
            .add_table(table)
            .add_enum_type(EnumType::new("StatusType", Vec::new()))
            .build();

        assert!(schema.validate().is_empty());
    }

    // #[test]
    // fn build_reverse_relations_creates_back_refs() {
    //     let mut s = make_schema();
    //     let mut parent = Table::new(
    //         Some("s"),
    //         "p",
    //         Option::<&str>::None,
    //         crate::model::types::LockEscalation::Auto,
    //         false,
    //         vec![Column::new(Some("s"), "id", ColumnType::Int, 0, 0, true)],
    //         Vec::new(),
    //         Vec::new(),
    //         Vec::new(),
    //         Vec::new(),
    //         Vec::new(),
    //         Vec::new(),
    //         Vec::new(),
    //         Vec::new(),
    //     );
    //     let mut child = Table::new(
    //         Some("s"),
    //         "c",
    //         Option::<&str>::None,
    //         crate::model::types::LockEscalation::Auto,
    //         false,
    //         vec![Column::new(Some("s"), "pid", ColumnType::Int, 0, 0, false)],
    //         Vec::new(),
    //         Vec::new(),
    //         vec![Relation::new(
    //             "p",
    //             "id",
    //             "c",
    //             "pid",
    //             RelationType::Cascade,
    //             false,
    //         )],
    //         Vec::new(),
    //         Vec::new(),
    //         Vec::new(),
    //         Vec::new(),
    //         Vec::new(),
    //     );
    //     s.add_table(parent);
    //     s.add_table(child);
    //
    //     s.build_reverse_relations();
    //     let p_ref = s.get_table("p");
    //     assert_eq!(p_ref.reverse_relations().len(), 1);
    //     let rr = &p_ref.reverse_relations()[0];
    //     assert_eq!(rr.from_table_name(), "c");
    //     assert_eq!(rr.to_table_name(), "p");
    // }
}