postgresql-schema-upgrader 0.1.2

A robust, safety-first library for managing PostgreSQL database schema migrations with both sync and async support.
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
125
126
127
128
129
130
131
132

use crate::UpgraderError;
use crate::schema_loader::SchemaUpgrader;
use crate::upgrade_macros::{
    do_await, do_sync, impl_create_schema_if_needed, impl_init_upgraders_table,
    impl_load_applied_upgraders, impl_lock_upgraders_table, impl_record_upgrader,
};
use chrono::{DateTime, Utc};

#[derive(Debug, Clone)]
pub(crate) struct AppliedUpgrader {
    pub(crate) file_id: i32,
    pub(crate) upgrader_id: i32,
    pub(crate) description: String,
    pub(crate) text: String,
    pub(crate) applied_on: DateTime<Utc>,
}

pub(crate) const ADVISORY_LOCK_ID: i64 = 42_00_42_00; // Arbitrary constant for serialization of CREATE TABLE

pub(crate) fn table_name(schema: Option<&str>) -> String {
    match schema {
        Some(s) => format!("\"{}\".\"$upgraders$\"", s),
        None => "\"$upgraders$\"".to_string(),
    }
}

#[cfg(feature = "postgres")]
pub(crate) mod blocking {
    use super::*;
    use postgres::GenericClient;

    pub fn create_schema_if_needed(
        client: &mut impl GenericClient,
        schema: Option<&str>,
    ) -> Result<(), UpgraderError> {
        impl_create_schema_if_needed!(client, schema, do_sync)
    }

    pub fn init_upgraders_table(
        client: &mut postgres::Client,
        schema: Option<&str>,
    ) -> Result<(), UpgraderError> {
        impl_init_upgraders_table!(client, schema, do_sync)
    }

    pub fn lock_upgraders_table(
        transaction: &mut postgres::Transaction,
        schema: Option<&str>,
    ) -> Result<(), UpgraderError> {
        impl_lock_upgraders_table!(transaction, schema, do_sync)
    }

    pub fn load_applied_upgraders(
        client: &mut impl GenericClient,
        schema: Option<&str>,
    ) -> Result<Vec<AppliedUpgrader>, UpgraderError> {
        impl_load_applied_upgraders!(client, schema, do_sync)
    }

    pub fn record_upgrader(
        client: &mut impl GenericClient,
        schema: Option<&str>,
        upgrader: &SchemaUpgrader,
    ) -> Result<(), UpgraderError> {
        impl_record_upgrader!(client, schema, upgrader, do_sync)
    }
}

#[cfg(feature = "tokio-postgres")]
pub(crate) mod async_tracker {
    use super::*;
    use tokio_postgres::GenericClient;

    pub async fn create_schema_if_needed(
        client: &impl GenericClient,
        schema: Option<&str>,
    ) -> Result<(), UpgraderError> {
        impl_create_schema_if_needed!(client, schema, do_await)
    }

    pub async fn init_upgraders_table(
        client: &mut tokio_postgres::Client,
        schema: Option<&str>,
    ) -> Result<(), UpgraderError> {
        impl_init_upgraders_table!(client, schema, do_await)
    }

    pub async fn lock_upgraders_table(
        transaction: &tokio_postgres::Transaction<'_>,
        schema: Option<&str>,
    ) -> Result<(), UpgraderError> {
        impl_lock_upgraders_table!(transaction, schema, do_await)
    }

    pub async fn load_applied_upgraders(
        client: &impl GenericClient,
        schema: Option<&str>,
    ) -> Result<Vec<AppliedUpgrader>, UpgraderError> {
        impl_load_applied_upgraders!(client, schema, do_await)
    }

    pub async fn record_upgrader(
        client: &impl GenericClient,
        schema: Option<&str>,
        upgrader: &SchemaUpgrader,
    ) -> Result<(), UpgraderError> {
        impl_record_upgrader!(client, schema, upgrader, do_await)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_table_name_without_schema() {
        let name = table_name(None);
        assert_eq!(name, "\"$upgraders$\"");
    }

    #[test]
    fn test_table_name_with_schema() {
        let name = table_name(Some("my_schema"));
        assert_eq!(name, "\"my_schema\".\"$upgraders$\"");
    }

    #[test]
    fn test_table_name_with_public_schema() {
        let name = table_name(Some("public"));
        assert_eq!(name, "\"public\".\"$upgraders$\"");
    }
}