Redgate Flyway Docker 镜像文档

1. 镜像概述和主要用途

本镜像为 Flyway Command-line 的官方 Docker 镜像，支持 Redgate Flyway 全系列版本（包括社区版、团队版和企业版），并与 Flyway Pipelines 兼容。Flyway Pipelines 可帮助用户集中查看跨项目的数据库部署状态，实现部署记录（已部署内容、时间及位置）的便捷追踪。

2. 核心功能和特性

• 多版本支持：兼容 Flyway 社区版、团队版、企业版，满足不同规模团队需求。
• 灵活的文件挂载：支持通过卷挂载配置文件、JDBC 驱动、SQL 迁移文件及 Java 迁移文件。
• CI/CD 集成：适配 Azure Pipelines 等 CI/CD 工具（通过 *-azure 标签镜像）。
• Flyway Pipelines 兼容：支持将迁移结果发布至 Flyway Pipelines，实现集中化部署状态管理。
• 跨环境一致性：通过容器化确保不同环境中 Flyway 版本及配置的一致性。

3. 使用场景和适用范围

• 数据库迁移自动化：通过容器化 Flyway 实现 SQL/Java 迁移脚本的自动执行。
• CI/CD 流程集成：嵌入 CI/CD 管道（如 Azure Pipelines），在应用部署前自动完成数据库版本同步。
• 多环境数据库管理：统一开发、测试、生产环境的数据库版本控制，减少环境差异导致的问题。
• 集中化部署追踪：结合 Flyway Pipelines，实时监控多项目数据库部署状态，简化审计与问题排查。

4. 使用方法和配置说明

4.1 快速开始

4.1.1 基础验证

运行以下命令验证镜像可用性，将输出 Flyway Command-line 的使用说明：

docker run --rm redgate/flyway

4.1.2 基本数据库操作

执行具体 Flyway 命令需传入必要参数（如数据库连接信息、许可证密钥）。示例：查看数据库信息：

docker run --rm redgate/flyway -licenseKey="FL01..." -url=jdbc:h2:mem:test -user=sa info

4.1.3 Azure 兼容版本

带有 *-azure 标签的镜像（如 redgate/flyway:latest-azure）为适配 Azure Pipelines 代理作业需求，未定义入口点，需显式添加 flyway 命令：

docker run --rm redgate/flyway:latest-azure flyway -url=jdbc:h2:mem:test info

4.2 支持的卷

通过挂载以下卷可自定义 Flyway 配置、驱动及迁移文件：

4.3 配置方式

4.3.1 命令行参数

直接通过命令行传入 Flyway 参数，常用参数包括：

• -licenseKey：Flyway 许可证密钥（团队版/企业版必填）
• -url：数据库 JDBC 连接 URL
• -user：数据库用户名
• -password：数据库密码
• -schemas：目标数据库模式

示例：执行迁移命令：

docker run --rm redgate/flyway -licenseKey="FL01..." -url=jdbc:mysql://db:3306/mydb -user=root -password=P@ssw0rd migrate

4.3.2 配置文件

通过 /flyway/conf 卷挂载配置文件（如 flyway.conf），集中管理参数。配置文件格式示例：

flyway.url=jdbc:h2:mem:test
flyway.user=sa
flyway.licenseKey=FL01...
flyway.schemas=public

运行时挂载配置文件目录：

docker run --rm -v /absolute/path/to/confdir:/flyway/conf redgate/flyway info

4.4 添加 SQL 迁移文件

将 SQL 迁移文件（如 V1__Initial.sql）放入本地目录，通过 /flyway/sql 卷挂载：

1. 创建 SQL 文件 V1__Initial.sql：

   CREATE TABLE MyTable (
       MyColumn VARCHAR(100) NOT NULL
   );
   

2. 挂载 SQL 目录并执行迁移：

   docker run --rm -v /absolute/path/to/sqldir:/flyway/sql redgate/flyway -url=jdbc:h2:mem:test -user=sa migrate
   

4.5 添加 JDBC 驱动

若默认未包含目标数据库的 JDBC 驱动（可参考 官方文档 确认），或需使用特定版本驱动，可通过 /flyway/drivers 卷挂载：

1. 将驱动 JAR 文件（如 mysql-connector-java-8.0.32.jar）放入本地目录。

2. 挂载驱动目录并运行：

   docker run --rm -v /absolute/path/to/driverdir:/flyway/drivers -v /absolute/path/to/sqldir:/flyway/sql redgate/flyway -url=jdbc:mysql://db:3306/mydb -user=root migrate
   

4.6 添加 Java 迁移和回调

通过 /flyway/jars 卷挂载包含 Java 迁移类或回调的 JAR 文件：

1. 将 Java 迁移 JAR 文件放入本地目录。

2. 挂载 JAR 目录并执行：

   docker run --rm -v /absolute/path/to/jardir:/flyway/jars -v /absolute/path/to/sqldir:/flyway/sql redgate/flyway -url=jdbc:h2:mem:test -user=sa migrate
   

4.7 Flyway Pipelines 集成

通过 Flyway Pipelines 可集中追踪迁移结果，需使用 个人访问令牌（PAT）。示例：发布迁移结果至 Flyway Pipelines：

docker run --rm -v /absolute/path/to/sqldir:/flyway/sql -v /absolute/path/to/confdir:/flyway/conf redgate/flyway migrate --publishResults=true --email=<Redgate账户邮箱> -token=<PAT令牌>

4.8 Docker Compose 部署示例

通过 docker-compose.yml 可同时启动 Flyway 和目标数据库容器，实现迁移自动化：

version: '3'
services:
  flyway:
    image: redgate/flyway
    # 命令：等待数据库初始化（最多60次重试）后执行迁移
    command: -licenseKey="FL01..." -url=jdbc:mysql://db -schemas=myschema -user=root -password=P@ssw0rd -connectRetries=60 migrate
    volumes:
      - ./sql:/flyway/sql  # 挂载本地SQL迁移文件目录
    depends_on:
      - db  # 依赖数据库服务启动

  db:
    image: mysql:latest
    environment:
      - MYSQL_ROOT_PASSWORD=P@ssw0rd  # 数据库root密码
    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci  # 字符集配置
    ports:
      - 3306:3306  # 暴露数据库端口

启动服务：

docker-compose up

Flyway 将自动等待 MySQL 初始化完成（最多 60 秒），随后执行迁移。