swellow 0.2.0

SQL-first migration CLI
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

mod arrow_utils;
mod catalog;
mod error;
mod postgres;
mod spark;
mod sql_common;
pub use catalog::Catalog;
pub use error::{EngineError, EngineErrorKind};
pub use postgres::PostgresEngine;
pub use spark::SparkEngine;

use crate::{cli, migration::MigrationDirection};

use sqlparser;


pub enum EngineBackend {
    Postgres(PostgresEngine),
    SparkDelta(SparkEngine),
    SparkIceberg(SparkEngine),
}

impl EngineBackend {
    pub fn engine(&self) -> cli::Engine {
        match self {
            EngineBackend::Postgres(_) => cli::Engine::Postgres,
            EngineBackend::SparkDelta(_) => cli::Engine::SparkDelta,
            EngineBackend::SparkIceberg(_) => cli::Engine::SparkIceberg,
        }
    }

    pub fn disable_transactions(&mut self) -> () {
        match self {
            EngineBackend::Postgres(engine) => engine.disable_transactions(),
            _ => (),
        }
    }

    pub async fn ensure_table(&mut self) -> Result<(), EngineError> {
        match self {
            EngineBackend::Postgres(engine) => engine.ensure_table().await,
            EngineBackend::SparkDelta(engine) => engine.ensure_table().await,
            EngineBackend::SparkIceberg(engine) => engine.ensure_table().await,
        }
    }

    pub async fn begin(&mut self) -> Result<(), EngineError> {
        match self {
            EngineBackend::Postgres(engine) => engine.begin().await,
            _ => Ok(()),
        }
    }

    pub async fn fetch_latest_applied_version(&mut self) -> Result<Option<i64>, EngineError> {
        match self {
            EngineBackend::Postgres(engine) => engine.fetch_latest_applied_version().await,
            EngineBackend::SparkDelta(engine) => engine.fetch_latest_applied_version().await,
            EngineBackend::SparkIceberg(engine) => engine.fetch_latest_applied_version().await,
        }
    }

    pub async fn acquire_lock(&mut self) -> Result<(), EngineError> {
        match self {
            EngineBackend::Postgres(engine) => engine.acquire_lock().await,
            EngineBackend::SparkDelta(engine) => engine.acquire_lock().await,
            EngineBackend::SparkIceberg(engine) => engine.acquire_lock().await,
        }
    }

    pub async fn release_lock(&mut self) -> Result<(), EngineError> {
        match self {
            EngineBackend::Postgres(engine) => engine.release_lock().await,
            EngineBackend::SparkDelta(engine) => engine.release_lock().await,
            EngineBackend::SparkIceberg(engine) => engine.release_lock().await,
        }
    }

    pub async fn disable_records(&mut self, current_version_id: i64) -> Result<(), EngineError> {
        match self {
            EngineBackend::Postgres(engine) => engine.disable_records(current_version_id).await,
            EngineBackend::SparkDelta(engine) => engine.disable_records(current_version_id).await,
            EngineBackend::SparkIceberg(engine) => engine.disable_records(current_version_id).await,
        }
    }

    pub async fn upsert_record(
        &mut self,
        object_type: &sqlparser::ast::ObjectType,
        object_name_before: &str,
        object_name_after: &str,
        version_id: i64,
        checksum: &str
    ) -> Result<(), EngineError> {
        match self {
            EngineBackend::Postgres(engine) => engine.upsert_record(
                object_type,
                object_name_before,
                object_name_after,
                version_id,
                checksum,
            ).await,
            EngineBackend::SparkDelta(engine) => engine.upsert_record(
                object_type,
                object_name_before,
                object_name_after,
                version_id,
                checksum,
            ).await,
            EngineBackend::SparkIceberg(engine) => engine.upsert_record(
                object_type,
                object_name_before,
                object_name_after,
                version_id,
                checksum,
            ).await,
        }
    }

    pub async fn execute(&mut self, sql: &str) -> Result<(), EngineError> {
        match self {
            EngineBackend::Postgres(engine) => engine.execute(sql).await,
            EngineBackend::SparkDelta(engine) => engine.execute(sql).await,
            EngineBackend::SparkIceberg(engine) => engine.execute(sql).await,
        }
    }

    pub async fn update_record(
        &mut self, 
        direction: &MigrationDirection,
        version_id: i64
    ) -> Result<(), EngineError> {
        let status = match direction {
            MigrationDirection::Up => "APPLIED",
            MigrationDirection::Down => "ROLLED_BACK"
        };

        match self {
            EngineBackend::Postgres(engine) => engine.update_record(status, version_id).await,
            EngineBackend::SparkDelta(engine) => engine.update_record(status, version_id).await,
            EngineBackend::SparkIceberg(engine) => engine.update_record(status, version_id).await,
        }
    }

    pub async fn rollback(&mut self) -> Result<(), EngineError> {
        match self {
            EngineBackend::Postgres(engine) => engine.rollback().await,
            _ => Ok(()),
        }
    }

    pub async fn commit(&mut self) -> Result<(), EngineError> {
        match self {
            EngineBackend::Postgres(engine) => engine.commit().await,
            _ => Ok(()),
        }
    }

    pub async fn snapshot(&mut self) -> Result<String, EngineError> {
        match self {
            EngineBackend::Postgres(engine) => engine.snapshot().await,
            EngineBackend::SparkDelta(engine) => engine.snapshot().await,
            EngineBackend::SparkIceberg(engine) => engine.snapshot().await,
        }
    }
}


/// A trait defining the required business operations for Swellow.
/// This abstracts over different database engines.
pub trait DbEngine {
    async fn ensure_table(&mut self) -> Result<(), EngineError>;
    async fn execute(&mut self, sql: &str) -> Result<(), EngineError>;
    async fn fetch_latest_applied_version(&mut self) -> Result<Option<i64>, EngineError>;
    async fn acquire_lock(&mut self) -> Result<(), EngineError>;
    async fn release_lock(&mut self) -> Result<(), EngineError>;
    async fn disable_records(&mut self, current_version_id: i64) -> Result<(), EngineError>;
    async fn upsert_record(
        &mut self,
        object_type: &sqlparser::ast::ObjectType,
        object_name_before: &str,
        object_name_after: &str,
        version_id: i64,
        checksum: &str
    ) -> Result<(), EngineError>;
    async fn update_record(&mut self, status: &str, version_id: i64) -> Result<(), EngineError>;
    async fn snapshot(&mut self) -> Result<String, EngineError>;
}