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
//! Core migration creation handler
//!
//! A migration can be done for a specific schema which contains
//! multiple additions or removables from a database or table.
//!
//! At the end of crafting a migration you can use `Migration::exec` to
//! get the raw SQL string for a database backend or `Migration::revert`
//! to try to auto-infer the migration rollback. In cases where that
//! can't be done the `Result<String, RevertError>` will not unwrap.
//!
//! You can also use `Migration::exec` with your SQL connection for convenience
//! if you're a library developer.

use crate::table::{Table, TableMeta};
use crate::DatabaseChange;

use crate::backend::{SqlGenerator, SqlVariant};
use crate::connectors::SqlRunner;

use std::rc::Rc;

/// Represents a schema migration on a database
pub struct Migration {
    #[doc(hidden)]
    pub schema: Option<String>,
    #[doc(hidden)]
    pub changes: Vec<DatabaseChange>,
}

impl Migration {
    pub fn new() -> Migration {
        Migration {
            schema: None,
            changes: Vec::new(),
        }
    }

    /// Specify a database schema name for this migration
    pub fn schema<S: Into<String>>(self, schema: S) -> Migration {
        Self {
            schema: Some(schema.into()),
            ..self
        }
    }

    /// Creates the SQL for this migration for a specific backend
    ///
    /// This function copies state and does not touch the original
    /// migration layout. This allows you to call `revert` later on
    /// in the process to auto-infer the down-behaviour
    pub fn make<T: SqlGenerator>(&self) -> String {
        use DatabaseChange::*;

        /* What happens in make, stays in make (sort of) */
        let mut changes = self.changes.clone();
        let schema = self.schema.as_ref().map(|s| s.as_str());

        changes.iter_mut().fold(String::new(), |mut sql, change| {
            match change {
                &mut CreateTable(ref mut t, ref mut cb)
                | &mut CreateTableIfNotExists(ref mut t, ref mut cb) => {
                    cb(t); // Run the user code
                    let sql_changes = t.make::<T>(false, schema);

                    let name = t.meta.name().clone();
                    sql.push_str(&match change {
                        CreateTable(_, _) => T::create_table(&name, schema),
                        CreateTableIfNotExists(_, _) => {
                            T::create_table_if_not_exists(&name, schema)
                        }
                        _ => unreachable!(),
                    });
                    sql.push_str(" (");
                    let l = sql_changes.columns.len();
                    for (i, slice) in sql_changes.columns.iter().enumerate() {
                        sql.push_str(slice);

                        if i < l - 1 {
                            sql.push_str(", ");
                        }
                    }

                    let l = sql_changes.constraints.len();
                    for (i, slice) in sql_changes.constraints.iter().enumerate() {
                        if sql_changes.columns.len() > 0 && i == 0 {
                            sql.push_str(", ")
                        }

                        sql.push_str(slice);

                        if i < l - 1 {
                            sql.push_str(", ")
                        }
                    }

                    if let Some(ref primary_key) = sql_changes.primary_key {
                        sql.push_str(", ");
                        sql.push_str(primary_key);
                    };

                    let l = sql_changes.foreign_keys.len();
                    for (i, slice) in sql_changes.foreign_keys.iter().enumerate() {
                        if sql_changes.columns.len() > 0 && i == 0 {
                            sql.push_str(", ")
                        }

                        sql.push_str(slice);

                        if i < l - 1 {
                            sql.push_str(", ")
                        }
                    }

                    sql.push_str(")");

                    // Add additional index columns
                    if sql_changes.indices.len() > 0 {
                        sql.push_str(";");
                        sql.push_str(&sql_changes.indices.join(";"));
                    }
                }
                &mut DropTable(ref name) => sql.push_str(&T::drop_table(name, schema)),
                &mut DropTableIfExists(ref name) => {
                    sql.push_str(&T::drop_table_if_exists(name, schema))
                }
                &mut RenameTable(ref old, ref new) => {
                    sql.push_str(&T::rename_table(old, new, schema))
                }
                &mut ChangeTable(ref mut t, ref mut cb) => {
                    cb(t);
                    let sql_changes = t.make::<T>(true, schema);

                    sql.push_str(&T::alter_table(&t.meta.name(), schema));
                    sql.push_str(" ");

                    let l = sql_changes.columns.len();
                    for (i, slice) in sql_changes.columns.iter().enumerate() {
                        sql.push_str(slice);

                        if i < l - 1 {
                            sql.push_str(", ");
                        }
                    }

                    let l = sql_changes.foreign_keys.len();
                    for (i, slice) in sql_changes.foreign_keys.iter().enumerate() {
                        if sql_changes.columns.len() > 0 && i == 0 {
                            sql.push_str(", ")
                        }

                        sql.push_str("ADD ");
                        sql.push_str(slice);

                        if i < l - 1 {
                            sql.push_str(", ")
                        }
                    }

                    if let Some(ref primary_key) = sql_changes.primary_key {
                        sql.push_str(", ");
                        sql.push_str("ADD ");
                        sql.push_str(primary_key);
                    };

                    // Add additional index columns
                    if sql_changes.indices.len() > 0 {
                        sql.push_str(";");
                        sql.push_str(&sql_changes.indices.join(";"));
                    }
                }

                &mut CustomLine(ref line) => sql.push_str(line.as_str()),
            }

            sql.push_str(";");
            sql
        })
    }

    /// The same as `make` but making a run-time check for sql variant
    ///
    /// The `SqlVariant` type is populated based on the backends
    /// that are being selected at compile-time.
    ///
    /// This function panics if the provided variant is empty!
    pub fn make_from(&self, variant: SqlVariant) -> String {
        variant.run_for(self)
    }

    /// Inject a line of custom SQL into the top-level migration scope
    ///
    /// This is a bypass to the barrel typesystem, in case there is
    /// something your database supports that barrel doesn't, or if
    /// there is an issue with the way that barrel represents types.
    /// It does however mean that the SQL provided needs to be
    /// specific for one database, meaning that future migrations
    /// might become cumbersome.
    pub fn inject_custom<S: Into<String>>(&mut self, sql: S) {
        self.changes.push(DatabaseChange::CustomLine(sql.into()));
    }

    /// Automatically infer the `down` step of this migration
    ///
    /// Will thrown an error if behaviour is ambiguous or not
    /// possible to infer (e.g. revert a `drop_table`)
    pub fn revert<T: SqlGenerator>(&self) -> String {
        unimplemented!()
    }

    /// Pass a reference to a migration toolkit runner which will
    /// automatically generate and execute
    pub fn execute<S: SqlGenerator, T: SqlRunner>(&self, runner: &mut T) {
        runner.execute(self.make::<S>());
    }

    /// Create a new table with a specific name
    pub fn create_table<S: Into<String>, F: 'static>(&mut self, name: S, cb: F) -> &mut TableMeta
    where
        F: Fn(&mut Table),
    {
        self.changes
            .push(DatabaseChange::CreateTable(Table::new(name), Rc::new(cb)));

        match self.changes.last_mut().unwrap() {
            &mut DatabaseChange::CreateTable(ref mut t, _) => &mut t.meta,
            _ => unreachable!(),
        }
    }

    /// Create a new table *only* if it doesn't exist yet
    pub fn create_table_if_not_exists<S: Into<String>, F: 'static>(
        &mut self,
        name: S,
        cb: F,
    ) -> &mut TableMeta
    where
        F: Fn(&mut Table),
    {
        self.changes.push(DatabaseChange::CreateTableIfNotExists(
            Table::new(name),
            Rc::new(cb),
        ));

        match self.changes.last_mut().unwrap() {
            &mut DatabaseChange::CreateTableIfNotExists(ref mut t, _) => &mut t.meta,
            _ => unreachable!(),
        }
    }

    /// Change fields on an existing table
    pub fn change_table<S: Into<String>, F: 'static>(&mut self, name: S, cb: F)
    where
        F: Fn(&mut Table),
    {
        let t = Table::new(name);
        let c = DatabaseChange::ChangeTable(t, Rc::new(cb));
        self.changes.push(c);
    }

    /// Rename a table
    pub fn rename_table<S: Into<String>>(&mut self, old: S, new: S) {
        self.changes
            .push(DatabaseChange::RenameTable(old.into(), new.into()));
    }

    /// Drop an existing table
    pub fn drop_table<S: Into<String>>(&mut self, name: S) {
        self.changes.push(DatabaseChange::DropTable(name.into()));
    }

    /// Only drop a table if it exists
    pub fn drop_table_if_exists<S: Into<String>>(&mut self, name: S) {
        self.changes
            .push(DatabaseChange::DropTableIfExists(name.into()));
    }
}