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

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

pub struct LongIdentifier;

const MAX_IDENTIFIER_LEN: usize = 63;

impl LongIdentifier {
    fn ignored(ignores: &[String], rule: &str) -> bool {
        ignores.iter().any(|i| i == rule)
    }
}

impl LintCheck for LongIdentifier {
    fn name(&self) -> &'static str {
        "long-identifier"
    }

    fn run(&self, cfg: &Config) -> Vec<LintMessage> {
        let mut msgs = Vec::new();
        for table in &cfg.tables {
            if Self::ignored(&table.lint_ignore, self.name()) {
                continue;
            }
            if table.name.len() > MAX_IDENTIFIER_LEN {
                msgs.push(LintMessage {
                    check: self.name(),
                    message: format!(
                        "table '{}' name exceeds {} characters",
                        table.name, MAX_IDENTIFIER_LEN
                    ),
                    severity: LintSeverity::Error,
                });
            }
            for col in &table.columns {
                if Self::ignored(&col.lint_ignore, self.name()) {
                    continue;
                }
                if col.name.len() > MAX_IDENTIFIER_LEN {
                    msgs.push(LintMessage {
                        check: self.name(),
                        message: format!(
                            "column '{}.{}' name exceeds {} characters",
                            table.name, col.name, MAX_IDENTIFIER_LEN
                        ),
                        severity: LintSeverity::Error,
                    });
                }
            }
            for idx in &table.indexes {
                if let Some(name) = &idx.name {
                    if name.len() > MAX_IDENTIFIER_LEN {
                        msgs.push(LintMessage {
                            check: self.name(),
                            message: format!(
                                "index '{}.{}' name exceeds {} characters",
                                table.name, name, MAX_IDENTIFIER_LEN
                            ),
                            severity: LintSeverity::Error,
                        });
                    }
                }
            }
        }
        for idx in &cfg.indexes {
            if idx.name.len() > MAX_IDENTIFIER_LEN {
                msgs.push(LintMessage {
                    check: self.name(),
                    message: format!(
                        "index '{}' name exceeds {} characters",
                        idx.name, MAX_IDENTIFIER_LEN
                    ),
                    severity: LintSeverity::Error,
                });
            }
        }
        msgs
    }
}

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

    #[test]
    fn detects_long_name() {
        let long_name = "a".repeat(64);
        let table = TableSpec {
            name: long_name.clone(),
            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: Some(PrimaryKeySpec {
                name: None,
                columns: vec!["id".into()],
            }),
            indexes: vec![],
            checks: vec![],
            foreign_keys: vec![],
            partition_by: None,
            partitions: vec![],
            back_references: vec![],
            lint_ignore: vec![],
            comment: None,
            map: None,
        };
        let cfg = Config {
            tables: vec![table],
            ..Default::default()
        };
        let msgs = run_with_checks(
            &cfg,
            vec![Box::new(LongIdentifier)],
            &LintSettings::default(),
        );
        assert!(msgs.iter().any(|m| m.check == "long-identifier"));
    }
}