database-migration 0.2.0

Database agnostic functions and data structures to build database migration tools.
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

use crate::checksum::Checksum;
use chrono::{DateTime, NaiveDateTime, Utc};
use serde::{Deserialize, Serialize};
use std::fmt::{Display, Formatter};
use std::path::PathBuf;
use std::time::Duration;

#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
pub enum MigrationKind {
    Baseline,
    Up,
    Down,
}

impl MigrationKind {
    pub const fn as_str(&self) -> &'static str {
        match self {
            Self::Baseline => "baseline",
            Self::Up => "up",
            Self::Down => "down",
        }
    }

    pub fn is_backward(&self) -> bool {
        *self == Self::Down
    }

    pub fn is_forward(&self) -> bool {
        !self.is_backward()
    }

    pub const fn is_any(&self) -> bool {
        true
    }
}

impl Display for MigrationKind {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct NewMigration {
    pub key: NaiveDateTime,
    pub title: String,
    pub kind: MigrationKind,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Migration {
    pub key: NaiveDateTime,
    pub title: String,
    pub kind: MigrationKind,
    pub script_path: PathBuf,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ScriptContent {
    pub key: NaiveDateTime,
    pub kind: MigrationKind,
    pub path: PathBuf,
    pub content: String,
    pub checksum: Checksum,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ApplicableMigration {
    pub key: NaiveDateTime,
    pub kind: MigrationKind,
    pub script_content: String,
    pub checksum: Checksum,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Execution {
    pub key: NaiveDateTime,
    pub applied_rank: i64,
    pub applied_by: String,
    pub applied_at: DateTime<Utc>,
    pub checksum: Checksum,
    pub execution_time: Duration,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Reversion {
    pub key: NaiveDateTime,
    pub reverted_by: String,
    pub reverted_at: DateTime<Utc>,
    pub execution_time: Duration,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ProblematicMigration {
    pub key: NaiveDateTime,
    pub kind: MigrationKind,
    pub script_path: PathBuf,
    pub problem: Problem,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Problem {
    ChecksumMismatch {
        definition_checksum: Checksum,
        execution_checksum: Checksum,
    },
    OutOfOrder {
        last_applied_key: NaiveDateTime,
    },
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum MigrationsTableInfo {
    NoTables,
    Missing,
    Table {
        name: String,
        version: Option<String>,
        definition: String,
    },
}

#[cfg(test)]
mod tests;