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

#[cfg(feature = "tls")]
use crate::SslMode;
use crate::upgrade_macros::{do_await, run_upgrade_flow};
use crate::{PostgresUpgraderOptions, UpgraderError};

/// Asynchronously applies schema upgrades from the specified folder to the database.
///
/// # Errors
///
/// Returns `UpgraderError` if:
/// - Connection to the database fails.
/// - Upgrader files cannot be loaded or are invalid.
/// - An integrity violation is detected.
/// - Execution of a migration step fails.
#[cfg(feature = "tokio-postgres")]
pub async fn upgrade_async(
    upgraders_folder: impl AsRef<std::path::Path>,
    connection_string: &str,
    options: &PostgresUpgraderOptions,
) -> Result<(), UpgraderError> {
    use tokio_postgres::NoTls;

    #[cfg(feature = "tls")]
    use crate::tls::create_tls_config;

    #[cfg(feature = "tls")]
    let mut client = match options.ssl_mode {
        SslMode::Disable => {
            let (client, connection) = tokio_postgres::connect(connection_string, NoTls)
                .await
                .map_err(|e| UpgraderError::ConnectionError(e.to_string()))?;

            tokio::spawn(async move {
                if let Err(_e) = connection.await {
                    // Connection error will be detected by the client on next query
                }
            });
            client
        }
        SslMode::Require => {
            let tls = create_tls_config()?;
            let (client, connection) = tokio_postgres::connect(connection_string, tls)
                .await
                .map_err(|e| UpgraderError::ConnectionError(e.to_string()))?;

            tokio::spawn(async move {
                if let Err(_e) = connection.await {
                    // Connection error will be detected by the client on next query
                }
            });
            client
        }
    };

    #[cfg(not(feature = "tls"))]
    let mut client = {
        let (client, connection) = tokio_postgres::connect(connection_string, NoTls)
            .await
            .map_err(|e| UpgraderError::ConnectionError(e.to_string()))?;

        tokio::spawn(async move {
            if let Err(_e) = connection.await {
                // Log error
            }
        });
        client
    };

    run_upgrade_flow!(
        client,
        options,
        upgraders_folder,
        crate::db_tracker::async_tracker,
        do_await,
        &
    )
}