Skip to main content

appstruct_migrate/
sql.rs

1use crate::{MigrationPlan, SchemaChange};
2use appstruct_schema::ColumnSchema;
3use appstruct_schema::sql::{
4    add_foreign_key, add_index, add_seed, add_unique_constraint, column_definition,
5    generated_header, quote_ident, sql_default,
6};
7
8pub use appstruct_schema::initial_migration;
9
10#[cfg(test)]
11use appstruct_ir::{GeneratedValueIr, OnDeleteIr};
12#[cfg(test)]
13use appstruct_schema::sql::quote_literal;
14#[cfg(test)]
15use appstruct_schema::{
16    DatabaseSchema, DatabaseType, ForeignKeySchema, TableSchema, UniqueConstraintSchema,
17};
18
19/// Render SQL for an automatically applicable migration plan.
20///
21/// # Errors
22///
23/// Returns an error when the plan contains a blocked or unsupported change.
24pub fn migration_sql(plan: &MigrationPlan) -> Result<String, String> {
25    if plan.is_blocked() {
26        return Err("migration contains changes that require review or input".to_owned());
27    }
28    let mut statements = vec![generated_header()];
29    for planned in &plan.changes {
30        statements.push(match &planned.change {
31            SchemaChange::AddTable { table } => appstruct_schema::sql::create_table(table),
32            SchemaChange::AddColumn { table, column } => format!(
33                "ALTER TABLE {} ADD COLUMN {};\n",
34                quote_ident(table),
35                column_definition(column, true)
36            ),
37            SchemaChange::AlterColumn {
38                table,
39                before,
40                after,
41            } => alter_column(table, before, after)?,
42            SchemaChange::AddUniqueConstraint { constraint } => add_unique_constraint(constraint),
43            SchemaChange::AddIndex { index } => add_index(index),
44            SchemaChange::AddSeed { seed } => add_seed(seed),
45            SchemaChange::AddForeignKey { foreign_key } => add_foreign_key(foreign_key),
46            SchemaChange::RemoveTable { .. }
47            | SchemaChange::RenameTable { .. }
48            | SchemaChange::RemoveColumn { .. }
49            | SchemaChange::RemoveUniqueConstraint { .. }
50            | SchemaChange::RemoveIndex { .. }
51            | SchemaChange::RemoveSeed { .. }
52            | SchemaChange::RemoveForeignKey { .. } => {
53                return Err("destructive migration cannot be rendered automatically".to_owned());
54            }
55        });
56    }
57    Ok(format!("{}\n", statements.join("\n")))
58}
59
60fn alter_column(
61    table: &str,
62    before: &ColumnSchema,
63    after: &ColumnSchema,
64) -> Result<String, String> {
65    if before.name != after.name
66        || before.data_type != after.data_type
67        || before.primary_key != after.primary_key
68        || before.unique != after.unique
69        || before.generated != after.generated
70    {
71        return Err("column shape change requires manual migration".to_owned());
72    }
73    if before.nullable && !after.nullable {
74        return Err("adding a not-null constraint requires manual migration".to_owned());
75    }
76    let prefix = format!(
77        "ALTER TABLE {} ALTER COLUMN {}",
78        quote_ident(table),
79        quote_ident(&after.name)
80    );
81    let mut statements = Vec::new();
82    if before.nullable != after.nullable {
83        statements.push(format!("{prefix} DROP NOT NULL;\n"));
84    }
85    if before.default != after.default {
86        statements.push(sql_default(after).map_or_else(
87            || format!("{prefix} DROP DEFAULT;\n"),
88            |default| format!("{prefix} SET DEFAULT {default};\n"),
89        ));
90    }
91    Ok(statements.concat())
92}
93
94#[cfg(test)]
95mod tests;