graphile_worker_migrations 0.4.15

Migrations package for graphile_worker, a high performance Rust/PostgreSQL job queue
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

use graphile_worker_database::{DbError, DbExecutor, DbParams, DbTransaction};

#[allow(async_fn_in_trait)]
pub trait MigrationExecutor {
    async fn execute_statement(&mut self, stmt: &str) -> Result<(), DbError>;
}

impl MigrationExecutor for DbTransaction {
    async fn execute_statement(&mut self, stmt: &str) -> Result<(), DbError> {
        self.execute(stmt, DbParams::new()).await?;
        Ok(())
    }
}

#[cfg(feature = "driver-sqlx")]
impl MigrationExecutor for sqlx::Transaction<'_, sqlx::Postgres> {
    async fn execute_statement(&mut self, stmt: &str) -> Result<(), DbError> {
        sqlx::query(stmt).execute(self.as_mut()).await?;
        Ok(())
    }
}

pub mod m000001;
pub mod m000002;
pub mod m000003;
pub mod m000004;
pub mod m000005;
pub mod m000006;
pub mod m000007;
pub mod m000008;
pub mod m000009;
pub mod m000010;
pub mod m000011;
pub mod m000012;
pub mod m000013;
pub mod m000014;
pub mod m000015;
pub mod m000016;
pub mod m000017;
pub mod m000018;
pub mod m000019;

#[derive(Default)]
pub struct GraphileWorkerMigration {
    pub name: &'static str,
    pub is_breaking: bool,
    pub stmts: &'static [&'static str],
}

impl GraphileWorkerMigration {
    pub fn name(&self) -> &'static str {
        self.name
    }

    pub fn is_breaking(&self) -> bool {
        self.is_breaking
    }

    /// Parses the migration name and returns the migration number.
    /// ```rust
    /// use graphile_worker_migrations::sql::GraphileWorkerMigration;
    /// let migration = GraphileWorkerMigration {
    ///     name: "m000001_initial",
    ///     ..Default::default()
    /// };
    /// assert_eq!(migration.migration_number(), 1);
    /// let migration = GraphileWorkerMigration {
    ///     name: "m000002",
    ///     ..Default::default()
    /// };
    /// assert_eq!(migration.migration_number(), 2);
    /// ```
    pub fn migration_number(&self) -> u32 {
        self.name[1..7].parse().expect("Invalid migration name")
    }

    pub async fn execute(
        &self,
        tx: &mut impl MigrationExecutor,
        escaped_schema: &str,
    ) -> Result<(), DbError> {
        for stmt in self.stmts {
            let stmt = stmt.replace(":GRAPHILE_WORKER_SCHEMA", escaped_schema);
            tx.execute_statement(&stmt).await?;
        }

        Ok(())
    }
}

pub const GRAPHILE_WORKER_MIGRATIONS: &[GraphileWorkerMigration] = &[
    m000001::M000001_MIGRATION,
    m000002::M000002_MIGRATION,
    m000003::M000003_MIGRATION,
    m000004::M000004_MIGRATION,
    m000005::M000005_MIGRATION,
    m000006::M000006_MIGRATION,
    m000007::M000007_MIGRATION,
    m000008::M000008_MIGRATION,
    m000009::M000009_MIGRATION,
    m000010::M000010_MIGRATION,
    m000011::M000011_MIGRATION,
    m000012::M000012_MIGRATION,
    m000013::M000013_MIGRATION,
    m000014::M000014_MIGRATION,
    m000015::M000015_MIGRATION,
    m000016::M000016_MIGRATION,
    m000017::M000017_MIGRATION,
    m000018::M000018_MIGRATION,
    m000019::M000019_MIGRATION,
];