db-migrate 0.1.1

Robust database migration tool for ScyllaDB
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

pub mod commands;
pub mod config;
pub mod migration;
pub mod schema;
pub mod utils;

use serde::{Deserialize, Serialize};
use chrono::{DateTime, Utc};

/// Represents a migration record in the database
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MigrationRecord {
    pub version: String,
    pub applied_at: DateTime<Utc>,
    pub checksum: String,
    pub description: String,
}

/// Represents a migration file on disk
#[derive(Debug, Clone)]
pub struct MigrationFile {
    pub version: String,
    pub description: String,
    pub file_path: std::path::PathBuf,
    pub content: String,
    pub checksum: String,
}

/// Represents the result of a command execution
#[derive(Debug, Serialize)]
pub struct CommandOutput {
    pub success: bool,
    pub message: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<serde_json::Value>,
}

impl CommandOutput {
    pub fn success(message: impl Into<String>) -> Self {
        Self {
            success: true,
            message: message.into(),
            data: None,
        }
    }

    pub fn success_with_data(message: impl Into<String>, data: serde_json::Value) -> Self {
        Self {
            success: true,
            message: message.into(),
            data: Some(data),
        }
    }

    pub fn error(message: impl Into<String>) -> Self {
        Self {
            success: false,
            message: message.into(),
            data: None,
        }
    }
}

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

/// Custom error types for the migration tool
#[derive(thiserror::Error, Debug)]
pub enum MigrationError {
    #[error("Database connection error: {0}")]
    DatabaseError(#[from] scylla::transport::errors::NewSessionError),

    #[error("Query execution error: {0}")]
    QueryError(#[from] scylla::transport::errors::QueryError),

    #[error("Migration file error: {0}")]
    FileError(#[from] std::io::Error),

    #[error("Configuration error: {0}")]
    ConfigError(String),

    #[error("Migration integrity error: {0}")]
    IntegrityError(String),

    #[error("Migration not found: {0}")]
    MigrationNotFound(String),

    #[error("Checksum mismatch for migration {version}: expected {expected}, got {actual}")]
    ChecksumMismatch {
        version: String,
        expected: String,
        actual: String,
    },

    #[error("Cannot rollback migration {version}: {reason}")]
    RollbackError { version: String, reason: String },

    #[error("Migration {version} is already applied")]
    AlreadyApplied { version: String },

    #[error("Invalid migration format: {0}")]
    InvalidFormat(String),
}