使用 Spring Boot 进行 Flyway 修复

Question

我不太明白当在 Spring Boot 项目中使用 Flyway 迁移失败时我应该做什么。

我只需在 pom.xml 中添加 Flyway 依赖项即可激活 Flyway。一切正常。当我启动 Spring Boot 应用程序时，我的数据库脚本被迁移。

但是我的一个脚本中有一个错误，并且我的最后一次迁移失败了。现在，当我尝试迁移时，出现“迁移校验和不匹配”。通常，我会运行mvn flyway:repair，但由于我使用的是 Spring Boot，所以我不应该使用 Flyway Maven 插件。那我该怎么办？

Answer 1

有几种方法可以对数据库执行修复。我个人更喜欢简单的 SQL 语句。

SQL 语句：

只需删除迁移失败的行。之后，您可以再次运行迁移。

直接运行flyway

您可以在本地安装 Flyway 并在控制台中运行 flyway repair

使用 Flyway Maven 插件

将Flyway Maven Plugin 添加到您的pom 并运行mvn flyway:repair。我认为这与 Spring Boot 的概念并不矛盾。

扩展 Spring Boot

Spring Boot 会调用Flyway.migrate() 来执行数据库迁移。如果您想要更多控制权，请提供实现 FlywayMigrationStrategy 的 @Bean。

在FlywayMigrationStrategy 中，您可以从flyway 调用迁移或修复方法。更多信息请访问Spring Boot Reference Guide。

我认为应用程序中的FlywayMigrationStrategy 不是修复数据库的正确位置。失败的迁移是一个例外，应该在应用程序之外进行处理。

Answer 2

Flyway Maven 插件

只是将此信息添加到@Daniel 的回答中

1.

      ...
        <plugin>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-maven-plugin</artifactId>
            <version>4.1.0</version>
            <configuration>
                <url>jdbc:mysql://localhost:3306</url>
                <user>root</user>
                <password>root</password>
                <schemas>
                    <schema>[your_schema]</schema>
                </schemas>
            </configuration>
        </plugin>
      ...

2.

mvn flyway:clean

3.

mvn flyway:repair

PS.：如果第 2 步和第 3 步不起作用，请更改顺序。

更多关于 maven 目标的信息：https://flywaydb.org/documentation/maven/

Answer 3

当数据库迁移失败时，迁移在架构历史表(i.e flyway_schema_history) 中标记为失败，表示可能需要手动清理数据库。但如果数据库支持 DDL 事务，则迁移会自动回滚，并且架构历史表中不会记录任何内容。 PostgreSQL、Amazon Redshift、MS SQL 是少数支持 DDL 事务的数据库，而 Oracle Database、MySQL、MariaDB、Amazon Aurora 不支持 DDL 事务。

如果迁移条目失败，有几个选项可以修复它（仅适用于不支持 DDL 事务的数据库），如 @daniel-käfer 所述。我想添加另一种（可能更简单的方法）来处理失败的迁移。

flyway 支持多个callbacks，afterMigrateError 就是其中之一。如果我们添加一个名为 afterMigrateError.sql 的 sql 文件，那么它将在每次失败的 migrate 运行后执行。因此，我们可以简单地使用 sql 命令在数据库迁移文件夹（resources/db/migration）的默认位置创建一个文件afterMigrateError.sql，以从flyway_schema_history 表中删除失败的迁移。

sql命令afterMigrateError.sql可以如下：

DELETE IGNORE FROM flyway_schema_history WHERE success=0;

此命令查找表flyway_schema_history（如果存在），否则不会进行任何更改。然后它只查找具有success 列和0 条目的行（实际上，如果迁移失败会发生这种情况，所有成功的迁移都将在成功列中具有值1），然后删除这些条目。现在，我们可以简单地更改我们最新的迁移文件并更正它并再次运行。

Answer 4

如above所说的在本地安装flyway，将目录更改为安装然后运行（以H2为例）：

./flyway -url=jdbc:h2:/Users/mugo/dev/h2/das-boot -user=sa -password= repair

Answer 5

您可以通过代码声明以下 bean 来实现。

@Bean
public FlywayMigrationStrategy cleanMigrateStrategy() {
    return flyway -> {
        flyway.repair();
        flyway.migrate();
    };
}