declare_schema 0.0.14

CLI / Library for Postgres schema migrations
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

//! Diff SQL and a Postgres server to execute migrations
//!
//! Example
//! ```ignore
//! let pool = sqlx::PgPool::connect(env::var(key)?.as_str()).await?;
//! let target_schema = include_str!("schema.sql");
//! declare_schema::migrate_from_string(&target_schema, &pool).await?;
//! ```
//! Diff SQL and a Postgres server to generate migration statements
//!
//! Example
//! ```ignore
//! let pool = sqlx::PgPool::connect(env::var(key)?.as_str()).await?;
//! let target_schema = include_str!("schema.sql");
//! let steps = declare_schema::generate_migrations_from_string(&target_schema, &pool).await?;
//! for step in steps {
//!     println!("{}", step)
//! }
//! ```

/// Diff'ing of ASTs and statement generation
pub mod altertable;
/// str parsing to generate sqlparser ASTs
pub mod schema;
/// Postgres Server reading to generate sqlparser ASTs
pub mod source_postgres;

use altertable::Wrapped;
use sqlparser::ast::CreateTable;
use sqlparser::ast::TableConstraint;
use sqlx::PgPool;
use thiserror::Error;

/// The common error type for migration errors
#[non_exhaustive]
#[derive(Error, Debug)]
pub enum MigrationError {
    #[error("The table index cannot be modified yet: `From: {0} To: {1}`. Try adding a new index then dropping the old one")]
    CannotModifyIndex(sqlparser::ast::CreateIndex, sqlparser::ast::CreateIndex),
    #[error("The table constraint cannot be modified yet: From: `{0}` To: {1}. Try adding a new constraint then dropping the old one")]
    CannotModifyTableConstraint(TableConstraint, TableConstraint),
    #[error("These are not the same tables {0} {1}")]
    TablesNotMatching(CreateTable, CreateTable),
    #[error("Problems while connecting/executing SQL")]
    ExecSqlError(#[from] sqlx::Error),
    #[error("Problems while parsing SQL")]
    SqlParseError(#[from] sqlparser::parser::ParserError),
    #[error("Problems while parsing SQL type: {0}")]
    SqlParseTypeError(String),
    #[error("Unsupported statement {0}")]
    UnsupportedStatementType(sqlparser::ast::Statement),
    #[error("Unsupported statement {0}")]
    UnnamedObject(altertable::Wrapped),
}

pub async fn migrate_schema_from_string(
    schema: &str,
    src: &str,
    pool: &PgPool,
) -> Result<(), MigrationError> {
    let src_state = crate::source_postgres::from_pool_schema(&pool, &schema).await?;
    let end_statements = schema::app_schema(src)?;
    let end_state: Result<Vec<Wrapped>, MigrationError> = end_statements
        .clone()
        .into_iter()
        .map(|s| Wrapped::try_from(s))
        .collect();
    let end_state = end_state?;
    let steps = crate::altertable::from_to(src_state, end_state)?;

    let mut conn = pool.acquire().await?;
    sqlx::query("SET lock_timeout TO 5000")
        .execute(&mut *conn)
        .await?;
    for s in steps {
        #[cfg(test)]
        println!("{:?}", s.to_string());

        sqlx::query(&s.to_string()).execute(&mut *conn).await?;
    }
    Ok(())
}
/// Diff a str with a DB and apply changes required to get the DB to match `str`
///

pub async fn migrate_from_string(src: &str, pool: &PgPool) -> Result<(), MigrationError> {
    migrate_schema_from_string("public", &src, &pool).await
}

/// Diff a str with a DB and return SQL changes required to get the DB to match `str`

pub async fn generate_migrations_from_string(
    src: &str,
    pool: &PgPool,
) -> Result<Vec<String>, MigrationError> {
    generate_migrations_from_string_for_schema("public", &src, &pool).await
}
pub async fn generate_migrations_from_string_for_schema(
    schema: &str,
    src: &str,
    pool: &PgPool,
) -> Result<Vec<String>, MigrationError> {
    let src_state = crate::source_postgres::from_pool_schema(&pool, &schema).await?;
    let end_statements = schema::app_schema(src)?;
    let end_state: Result<Vec<Wrapped>, MigrationError> = end_statements
        .clone()
        .into_iter()
        .map(|s| Wrapped::try_from(s))
        .collect();
    let end_state = end_state?;
    let steps = crate::altertable::from_to(src_state, end_state)?;

    Ok(steps.into_iter().map(|f| f.to_string()).collect())
}