crash_orm 0.7.2

A simple, typed ORM for Postgres
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

use postgres::types::Type;

use crate::schema::foreign_key::ForeignKey;

/// Struct describing a column in a table
pub struct ColumnDefinition {
    pub(crate) old_name: Option<String>,
    pub(crate) name: String,
    pub(crate) old_sql_type: Option<Type>,
    pub(crate) sql_type: Type,
    pub(crate) old_nullable: Option<bool>,
    pub(crate) nullable: bool,
    pub(crate) primary_key: bool,
    pub(crate) old_default_value: Option<Option<String>>,
    pub(crate) default_value: Option<String>,
    pub(crate) old_foreign_key: Option<Option<ForeignKey>>,
    pub(crate) foreign_key: Option<ForeignKey>,
}

impl ColumnDefinition {
    /// Creates a new column definition
    pub fn new(name: &'static str, sql_type: Type, nullable: bool) -> Self {
        Self {
            old_name: None,
            name: name.to_string(),
            old_sql_type: None,
            sql_type,
            old_nullable: None,
            nullable,
            primary_key: false,
            old_default_value: None,
            default_value: None,
            old_foreign_key: None,
            foreign_key: None,
        }
    }

    /// Creates a column definition from the database
    pub(crate) fn from_database(name: String, sql_type: Type, nullable: bool, primary_key: bool,
                                default_value: Option<String>, foreign_key: Option<ForeignKey>) -> Self {
        Self {
            old_name: Some(name.to_string()),
            name,
            old_sql_type: Some(sql_type.clone()),
            sql_type,
            old_nullable: Some(nullable),
            nullable,
            primary_key,
            old_default_value: Some(default_value.clone()),
            default_value,
            old_foreign_key: Some(foreign_key.clone()),
            foreign_key,
        }
    }

    /// Rename the column
    pub fn rename(&mut self, new_name: &'static str) -> &mut ColumnDefinition {
        self.name = new_name.to_string();
        self
    }

    /// Change null constraint
    pub fn set_nullable(&mut self, nullable: bool) -> &mut ColumnDefinition {
        self.nullable = nullable;
        self
    }

    /// Change type of column
    pub fn change_type(&mut self, sql_type: Type) -> &mut ColumnDefinition {
        self.sql_type = sql_type;
        self
    }

    /// Change primary key constraint
    pub fn set_primary(&mut self, primary: bool) -> &mut ColumnDefinition {
        self.primary_key = primary;
        self
    }

    /// Shortcut method to create a primary key for this column
    pub fn primary(mut self) -> ColumnDefinition {
        self.primary_key = true;
        self
    }

    /// Change the default value
    pub fn set_default_value(&mut self, default_value: Option<String>) -> &mut ColumnDefinition {
        self.default_value = default_value;
        self
    }

    /// Remove the current foreign key constraint
    pub fn remove_foreign_key(&mut self) -> &mut ColumnDefinition {
        self.foreign_key = None;
        self
    }

    /// Set the foreign key constraint
    pub fn set_foreign_key(&mut self, target_table: &str, target_field: &str) -> &mut ColumnDefinition {
        self.foreign_key = Some(ForeignKey {
            name: None,
            src_field: self.name.clone(),
            target_table: target_table.to_string(),
            target_field: target_field.to_string(),
        });
        self
    }
}