dbschema 0.1.0

Define database schema's as HCL files, and generate idempotent SQL migrations
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

use super::{LintCheck, LintMessage, LintSeverity};
use crate::ir::{Config, TableSpec};

pub struct MissingForeignKeyIndex;

impl MissingForeignKeyIndex {
    fn ignored(table: &TableSpec, columns: &[String], rule: &str) -> bool {
        if table.lint_ignore.iter().any(|i| i == rule) {
            return true;
        }
        for col_name in columns {
            if let Some(col) = table.columns.iter().find(|c| &c.name == col_name) {
                if col.lint_ignore.iter().any(|i| i == rule) {
                    return true;
                }
            }
        }
        false
    }

    fn has_index(cfg: &Config, table: &TableSpec, columns: &[String]) -> bool {
        let matches = |idx_cols: &[String]| {
            if idx_cols.len() < columns.len() {
                return false;
            }
            idx_cols.iter().zip(columns).all(|(a, b)| a == b)
        };
        if let Some(pk) = &table.primary_key {
            if matches(&pk.columns) {
                return true;
            }
        }
        if table.indexes.iter().any(|i| matches(&i.columns)) {
            return true;
        }
        let tbl_name = table.alt_name.as_ref().unwrap_or(&table.name);
        let schema = table.schema.as_deref().unwrap_or("public");
        cfg.indexes
            .iter()
            .filter(|i| i.table == *tbl_name && i.schema.as_deref().unwrap_or("public") == schema)
            .any(|i| matches(&i.columns))
    }
}

impl LintCheck for MissingForeignKeyIndex {
    fn name(&self) -> &'static str {
        "missing-foreign-key-index"
    }

    fn run(&self, cfg: &Config) -> Vec<LintMessage> {
        let mut msgs = Vec::new();
        for table in &cfg.tables {
            for fk in &table.foreign_keys {
                if Self::ignored(table, &fk.columns, self.name()) {
                    continue;
                }
                if !Self::has_index(cfg, table, &fk.columns) {
                    msgs.push(LintMessage {
                        check: self.name(),
                        message: format!(
                            "foreign key on '{}.{}' has no index",
                            table.name,
                            fk.columns.join(",")
                        ),
                        severity: LintSeverity::Error,
                    });
                }
            }
        }
        msgs
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ir::{ColumnSpec, Config, ForeignKeySpec, TableSpec};
    use crate::lint::{LintSettings, run_with_checks};

    #[test]
    fn detects_missing_fk_index() {
        let referenced = TableSpec {
            name: "ref".into(),
            alt_name: None,
            schema: None,
            if_not_exists: false,
            columns: vec![ColumnSpec {
                name: "id".into(),
                r#type: "int".into(),
                nullable: false,
                default: None,
                db_type: None,
                lint_ignore: vec![],
                comment: None,
                count: 1,
            }],
            primary_key: None,
            indexes: vec![],
            checks: vec![],
            foreign_keys: vec![],
            partition_by: None,
            partitions: vec![],
            back_references: vec![],
            lint_ignore: vec![],
            comment: None,
            map: None,
        };
        let table = TableSpec {
            name: "t".into(),
            alt_name: None,
            schema: None,
            if_not_exists: false,
            columns: vec![ColumnSpec {
                name: "ref_id".into(),
                r#type: "int".into(),
                nullable: false,
                default: None,
                db_type: None,
                lint_ignore: vec![],
                comment: None,
                count: 1,
            }],
            primary_key: None,
            indexes: vec![],
            checks: vec![],
            foreign_keys: vec![ForeignKeySpec {
                name: None,
                columns: vec!["ref_id".into()],
                ref_schema: None,
                ref_table: "ref".into(),
                ref_columns: vec!["id".into()],
                on_delete: None,
                on_update: None,
                back_reference_name: None,
            }],
            partition_by: None,
            partitions: vec![],
            back_references: vec![],
            lint_ignore: vec![],
            comment: None,
            map: None,
        };
        let cfg = Config {
            tables: vec![referenced, table],
            ..Default::default()
        };
        let msgs = run_with_checks(
            &cfg,
            vec![Box::new(MissingForeignKeyIndex)],
            &LintSettings::default(),
        );
        assert!(msgs.iter().any(|m| m.check == "missing-foreign-key-index"));
    }
}