a3s-orm 0.2.0

A type-safe, executor-neutral SQL query builder for Rust
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
133
134
135
136

use async_trait::async_trait;

use crate::{
    pending_migrations, AppliedMigration, MigrationBackend, MigrationError, MigrationReport,
    PreparedMigration,
};

use super::options::postgres_timeout_value;
use super::{PostgresError, PostgresExecutor, PostgresMigrationError, PostgresOptionsError};

const CREATE_TABLE: &str = "
    create table if not exists a3s_orm_migrations (
        version text primary key,
        name text not null,
        checksum text not null,
        applied_at timestamptz not null default now()
    )";

impl PostgresExecutor {
    fn migration_options_error(&self, source: PostgresOptionsError) -> PostgresMigrationError {
        let error = PostgresError::from(source);
        self.record_error(&error);
        PostgresMigrationError::Driver(error)
    }

    fn migration_database_error(&self, source: tokio_postgres::Error) -> PostgresMigrationError {
        self.record_database_failure(&source);
        PostgresMigrationError::Database(source)
    }

    fn migration_definition_error(&self, source: MigrationError) -> PostgresMigrationError {
        self.record_retry_class(super::PostgresRetryClass::Permanent);
        PostgresMigrationError::Migration(source)
    }

    fn migration_apply_error(
        &self,
        version: &str,
        source: tokio_postgres::Error,
    ) -> PostgresMigrationError {
        self.record_database_failure(&source);
        PostgresMigrationError::Apply {
            version: version.to_owned(),
            source,
        }
    }
}

#[async_trait]
impl MigrationBackend for PostgresExecutor {
    type Error = PostgresMigrationError;

    async fn apply(
        &self,
        migrations: &[PreparedMigration],
    ) -> Result<MigrationReport, Self::Error> {
        let options = self.migration_options();
        options
            .validate()
            .map_err(|source| self.migration_options_error(source))?;
        let lock_timeout = postgres_timeout_value("lock_timeout", options.lock_timeout())
            .map_err(|source| self.migration_options_error(source))?;
        let mut client = self.acquire().await?;
        let transaction = client
            .transaction()
            .await
            .map_err(|source| self.migration_database_error(source))?;
        transaction
            .execute(
                "select set_config('lock_timeout', $1, true)",
                &[&lock_timeout],
            )
            .await
            .map_err(|source| self.migration_database_error(source))?;
        if let Err(source) = transaction
            .query_one(
                "select pg_advisory_xact_lock($1)",
                &[&options.advisory_lock_id()],
            )
            .await
        {
            if source.code() == Some(&tokio_postgres::error::SqlState::LOCK_NOT_AVAILABLE) {
                self.record_database_failure(&source);
                return Err(PostgresMigrationError::LockTimeout {
                    timeout: options.lock_timeout(),
                    source,
                });
            }
            return Err(self.migration_database_error(source));
        }
        transaction
            .batch_execute(CREATE_TABLE)
            .await
            .map_err(|source| self.migration_database_error(source))?;
        let rows = transaction
            .query(
                "select version, checksum from a3s_orm_migrations order by version",
                &[],
            )
            .await
            .map_err(|source| self.migration_database_error(source))?;
        let applied = rows
            .into_iter()
            .map(|row| AppliedMigration {
                version: row.get(0),
                checksum: row.get(1),
            })
            .collect::<Vec<_>>();
        let pending = pending_migrations(&applied, migrations)
            .map_err(|source| self.migration_definition_error(source))?;
        let mut versions = Vec::with_capacity(pending.len());
        for migration in pending {
            transaction
                .batch_execute(migration.up_sql())
                .await
                .map_err(|source| self.migration_apply_error(migration.version(), source))?;
            transaction
                .execute(
                    "insert into a3s_orm_migrations (version, name, checksum) values ($1, $2, $3)",
                    &[
                        &migration.version(),
                        &migration.name(),
                        &migration.checksum(),
                    ],
                )
                .await
                .map_err(|source| self.migration_database_error(source))?;
            versions.push(migration.version().to_owned());
        }
        transaction
            .commit()
            .await
            .map_err(|source| self.migration_database_error(source))?;
        Ok(MigrationReport { applied: versions })
    }
}