中文翻译站Quarkus - 使用 Flyway
Flyway 是 JVM 环境中常用的数据库迁移工具.
Quarkus provides first class support for using Flyway as will be explained in this guide.
设置 Flyway 支持
项目中要开始使用 Flyway 你需要 :
-
将迁移脚本文件添加到 Flyway 常用的
src/main/resources/db/migration文件夹 -
activate the
migrate-at-startoption to migrate the schema automatically or inject theFlywayobject and run your migration as you normally do -
激活
migrate-at-start选项以启用自动迁移 schema 或者注入Flyway执行迁移工作
在 pom.xml 中, 添加下列依赖:
-
Flyway 扩展
-
对应 JDBC 驱动扩展 (
quarkus-jdbc-postgresql,quarkus-jdbc-h2,quarkus-jdbc-mariadb, …)
<dependencies>
<!-- Flyway specific dependencies -->
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-flyway</artifactId>
</dependency>
<!-- JDBC driver dependencies -->
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-jdbc-postgresql</artifactId>
</dependency>
</dependencies>Flyway 支持依赖 Quarkus datasource 配置.
对于有多数据源 named datasource 可以指定默认 datasource .
首先， 为了允许 Flyway 管理 schema 需要添加 datasource 配置到 application.properties 文件.
当然，你也可以用下边的配置定制 Flyway 行为:
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Type |
Default |
|
|---|---|---|
Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix. Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain both SQL and Java-based migrations. Locations starting with filesystem: point to a directory on the filesystem, may only contain SQL migrations and are only scanned recursively down non-hidden directories. |
list of string |
|
The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries. |
int |
|
Comma-separated case-sensitive list of schemas managed by Flyway. The first schema in the list will be automatically set as the default one during the migration. It will also be the one containing the schema history table. |
list of string |
|
The name of Flyway’s schema history table. By default (single-schema mode) the schema history table is placed in the default schema for the connection provided by the datasource. When the flyway.schemas property is set (multi-schema mode), the schema history table is placed in the first schema of the list. |
string |
|
The file name prefix for versioned SQL migrations. Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1.1__My_description.sql |
string |
|
The file name prefix for repeatable SQL migrations. Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix , which using the defaults translates to R__My_description.sql |
string |
|
true to execute Flyway clean command automatically when the application starts, false otherwise. |
boolean |
|
true to execute Flyway automatically when the application starts, false otherwise. |
boolean |
|
Enable the creation of the history table if it does not exist already. |
boolean |
|
The initial baseline version. |
string |
|
The description to tag an existing schema with when executing baseline. |
string |
|
Whether to automatically call validate when performing a migration. |
boolean |
|
Allows migrations to be run "out of order". |
boolean |
|
Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix. Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain both SQL and Java-based migrations. Locations starting with filesystem: point to a directory on the filesystem, may only contain SQL migrations and are only scanned recursively down non-hidden directories. |
list of string |
|
Sets the placeholders to replace in SQL migration scripts. |
|
required |
The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries. |
int |
|
Comma-separated case-sensitive list of schemas managed by Flyway. The first schema in the list will be automatically set as the default one during the migration. It will also be the one containing the schema history table. |
list of string |
|
The name of Flyway’s schema history table. By default (single-schema mode) the schema history table is placed in the default schema for the connection provided by the datasource. When the flyway.schemas property is set (multi-schema mode), the schema history table is placed in the first schema of the list. |
string |
|
The file name prefix for versioned SQL migrations. Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1.1__My_description.sql |
string |
|
The file name prefix for repeatable SQL migrations. Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix , which using the defaults translates to R__My_description.sql |
string |
|
true to execute Flyway clean command automatically when the application starts, false otherwise. |
boolean |
|
true to execute Flyway automatically when the application starts, false otherwise. |
boolean |
|
Enable the creation of the history table if it does not exist already. |
boolean |
|
The initial baseline version. |
string |
|
The description to tag an existing schema with when executing baseline. |
string |
|
Whether to automatically call validate when performing a migration. |
boolean |
|
Allows migrations to be run "out of order". |
boolean |
|
Sets the placeholders to replace in SQL migration scripts. |
|
required |
下边是一个 application.properties 文件示例:
# configure your datasource
quarkus.datasource.db-kind=postgresql
quarkus.datasource.username=sarah
quarkus.datasource.password=connor
quarkus.datasource.jdbc.url=jdbc:postgresql://localhost:5432/mydatabase
# Flyway minimal config properties
quarkus.flyway.migrate-at-start=true
# Flyway optional config properties
# quarkus.flyway.baseline-on-migrate=true
# quarkus.flyway.baseline-version=1.0.0
# quarkus.flyway.baseline-description=Initial version
# quarkus.flyway.connect-retries=10
# quarkus.flyway.schemas=TEST_SCHEMA
# quarkus.flyway.table=flyway_quarkus_history
# quarkus.flyway.locations=db/location1,db/location2
# quarkus.flyway.sql-migration-prefix=X
# quarkus.flyway.repeatable-sql-migration-prefix=K添加一个符合 Flyway 命名约定的 SQL 迁移脚本文件 : src/main/resources/db/migration/V1.0.0__Quarkus.sql 到默认文件夹 .
CREATE TABLE quarkus
(
id INT,
name VARCHAR(20)
);
INSERT INTO quarkus(id, name)
VALUES (1, 'QUARKED');现在启动应用 Quarkus 会根据你的配置运行 Flyway 的迁移方法:
@ApplicationScoped
public class MigrationService {
// You can Inject the object if you want to use it manually
@Inject
Flyway flyway; (1)
public void checkMigration() {
// This will print 1.0.0
System.out.println(flyway.info().current().getVersion().toString());
}
}| 1 | 如果想直接使用可以注入 Flyway 对象 |
多 datasources
Flyway 可以配置为多 datasources. Flyway 配置属性名用 datasource 相同的前缀，如：
quarkus.datasource.db-kind=h2
quarkus.datasource.username=username-default
quarkus.datasource.jdbc.url=jdbc:h2:tcp://localhost/mem:default
quarkus.datasource.jdbc.min-size=3
quarkus.datasource.jdbc.max-size=13
quarkus.datasource.users.db-kind=h2
quarkus.datasource.users.username=username1
quarkus.datasource.users.jdbc.url=jdbc:h2:tcp://localhost/mem:users
quarkus.datasource.users.jdbc.min-size=1
quarkus.datasource.users.jdbc.max-size=11
quarkus.datasource.inventory.db-kind=h2
quarkus.datasource.inventory.username=username2
quarkus.datasource.inventory.jdbc.url=jdbc:h2:tcp://localhost/mem:inventory
quarkus.datasource.inventory.jdbc.min-size=2
quarkus.datasource.inventory.jdbc.max-size=12
# Flyway configuration for the default datasource
quarkus.flyway.schemas=DEFAULT_TEST_SCHEMA
quarkus.flyway.locations=db/default/location1,db/default/location2
quarkus.flyway.migrate-at-start=true
# Flyway configuration for the "users" datasource
quarkus.flyway.users.schemas=USERS_TEST_SCHEMA
quarkus.flyway.users.locations=db/users/location1,db/users/location2
quarkus.flyway.users.migrate-at-start=true
# Flyway configuration for the "inventory" datasource
quarkus.flyway.inventory.schemas=INVENTORY_TEST_SCHEMA
quarkus.flyway.inventory.locations=db/inventory/location1,db/inventory/location2
quarkus.flyway.inventory.migrate-at-start=trueNotice there’s an extra bit in the key.
The syntax is as follows: quarkus.flyway.[optional name.][datasource property].
| 不配置的话, Flyway 设置为每个 datasource 都用默认设置. |
使用 Flyway 对象
如果你对直接使用 Flyway 对象感兴趣，你可以像下边一样注入它：
如果启用了 quarkus.flyway.migrate-at-start 属性, 使用 Flyway 实例的时候,
Quarkus 已经运行过迁移操作了
|
@ApplicationScoped
public class MigrationService {
// You can Inject the object if you want to use it manually
@Inject
Flyway flyway; (1)
@Inject
@FlywayDataSource("inventory") (2)
Flyway flywayForInventory;
@Inject
@Named("flyway_users") (3)
Flyway flywayForUsers;
public void checkMigration() {
// Use the flyway instance manually
flyway.clean(); (4)
flyway.migrate();
// This will print 1.0.0
System.out.println(flyway.info().current().getVersion().toString());
}
}| 1 | 如果想直接使用, 注入 Flyway 对象 |
| 2 | 针对 Quarkus FlywayDataSource datasource 注解注入 Flyway 对象 |
| 3 | 注入命名 datasource 对应的 Flyway |
| 4 | 直接使用 Flyway 实例 |
