schema-model 0.2.0

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

use crate::model::types::KeyType;

#[derive(Debug, Clone)]
pub struct KeyColumn {
    name: String,
}

impl KeyColumn {
    pub fn new<S: Into<String>>(name: S) -> Self {
        Self { name: name.into() }
    }

    pub fn name(&self) -> &str {
        &self.name
    }
}

#[derive(Debug, Clone)]
pub struct Key {
    key_type: KeyType,
    columns: Vec<KeyColumn>,
    cluster: bool,
    compress: bool,
    unique: bool,
    include: Option<String>,
}

impl Key {
    pub fn new(key_type: KeyType, columns: Vec<KeyColumn>) -> Self {
        Self {
            key_type,
            columns,
            cluster: false,
            compress: false,
            unique: false,
            include: None,
        }
    }

    pub fn new_full<S: Into<String>>(
        key_type: KeyType,
        columns: Vec<KeyColumn>,
        cluster: bool,
        compress: bool,
        unique: bool,
        include: Option<S>,
    ) -> Self {
        Self {
            key_type,
            columns,
            cluster,
            compress,
            unique,
            include: include.map(|s| s.into()),
        }
    }

    pub fn key_type(&self) -> KeyType {
        self.key_type
    }

    pub fn columns(&self) -> &Vec<KeyColumn> {
        &self.columns
    }

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

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

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

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

    pub fn is_index(&self) -> bool {
        self.key_type == KeyType::Index
    }

    pub fn contains_column(&self, column_name: &str) -> bool {
        self.columns.iter().any(|c| c.name() == column_name)
    }

    pub fn columns_as_string(&self) -> String {
        self.columns
            .iter()
            .map(|c| c.name())
            .collect::<Vec<_>>()
            .join(",")
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::model::types::KeyType;

    #[test]
    fn key_column_and_key_basics() {
        let cols = vec![KeyColumn::new("id"), KeyColumn::new("code")];
        let k = Key::new(KeyType::Primary, cols.clone());
        assert_eq!(k.key_type(), KeyType::Primary);
        assert_eq!(k.columns().len(), 2);
        assert!(!k.is_cluster());
        assert!(!k.is_compress());
        assert!(!k.is_unique());
        assert_eq!(k.include(), None);
        assert!(k.contains_column("id"));
        assert_eq!(k.columns_as_string(), "id,code");

        let k2 = Key::new_full(KeyType::Index, cols, true, true, true, Some("inc"));
        assert!(k2.is_cluster());
        assert!(k2.is_compress());
        assert!(k2.is_unique());
        assert_eq!(k2.include(), Some("inc"));
    }
}