flyway从入门到精通(六):spring boot提供的flyway的配置能力

spring boot对flyway提供了丰富的配置能力,我们只需要在yaml文件添加配置信息,如下

 spring:
    flyway:
        enabled: true
        schemas: lex

默认会下载到如下的配置类

@ConfigurationProperties(prefix = "spring.flyway")
public class FlywayProperties {

    /**
     * 是否开启flyway,默认是开启的
     */
    private boolean enabled = true;

    /**
     * 是否检查 migration 脚本是否存在,默认是检查的.
     */
    private boolean checkLocation = true;

    /**
     * Locations of migrations scripts. Can contain the special "{vendor}" placeholder to
     * use vendor-specific locations.
         *如下,默认会在db/migration的classpath下查找migrations 文件
     */
    private List<String> locations = new ArrayList<>(Collections.singletonList("classpath:db/migration"));

    /**
     *  SQL migrations文件默认编码方式为UTF_8
     */
    private Charset encoding = StandardCharsets.UTF_8;

    /**
     * 尝试连接数据库的最大的次数
     */
    private int connectRetries;

    /**
     * 指定flyway执行的schemas,逗号隔离,区分大小写
     */
    private List<String> schemas = new ArrayList<>();

    /**
     * schema history table的名字,默认为flyway_schema_history
     */
    private String table = "flyway_schema_history";

    /**
     * Tablespace in which the schema history table is created. Ignored when using a
     * database that does not support tablespaces. Defaults to the default tablespace of
     * the connection used by Flyway.
     */
    private String tablespace;

    /**
     * 当对一个已存在的schema使用baseline能力时,控制台输出的描述性
     */
    private String baselineDescription = "<< Flyway Baseline >>";

    /**
     * 执行baseline,已存在的schema设置的版本信息,如果待添加的sql的版本信息设置的
         *大于此版本信息,那么就会执行migration,否则忽略
     */
    private String baselineVersion = "1";

    /**
     * Username recorded in the schema history table as having applied the migration.
     */
    private String installedBy;

    /**
     * Placeholders and their replacements to apply to sql migration scripts.
     */
    private Map<String, String> placeholders = new HashMap<>();

    /**
     * Prefix of placeholders in migration scripts.
     */
    private String placeholderPrefix = "${";

    /**
     * Suffix of placeholders in migration scripts.
     */
    private String placeholderSuffix = "}";

    /**
     * 是否进行占位符替换,默认是true
     */
    private boolean placeholderReplacement = true;

    /**
     * File name prefix for SQL migrations.
     */
    private String sqlMigrationPrefix = "V";

    /**
     *  SQL migrations文件后缀名,默认是.sql
     */
    private List<String> sqlMigrationSuffixes = new ArrayList<>(Collections.singleton(".sql"));

    /**
     * SQL migrations文件分隔符
     */
    private String sqlMigrationSeparator = "__";

    /**
     * File name prefix for repeatable SQL migrations.
     */
    private String repeatableSqlMigrationPrefix = "R";

    /**
     * Target version up to which migrations should be considered.
     */
    private String target;

    /**
     * JDBC url of the database to migrate. If not set, the primary configured data source
     * is used.
     */
    private String url;

    /**
     * Login user of the database to migrate.
     */
    private String user;

    /**
     * Login password of the database to migrate.
     */
    private String password;

    /**
     * SQL statements to execute to initialize a connection immediately after obtaining
     * it.
     */
    private List<String> initSqls = new ArrayList<>();

    /**
     * Whether to automatically call baseline when migrating a non-empty schema.
         *对一和非空的schema执行migration时是否执行baseline
     */
    private boolean baselineOnMigrate;

    /**
     * 是否关闭clean操作,个人建议设置为true,防止意外情况出现
     */
    private boolean cleanDisabled;

    /**
     * Whether to automatically call clean when a validation error occurs.
     */
    private boolean cleanOnValidationError;

    /**
    *是否将所有的migration sql放在同一个事务里面执行,要看db是否支持
     */
    private boolean group;

    /**
     * 是否忽略丢失的migretion文件,保持默认,为了文件的安全性,建议设置为false
     */
    private boolean ignoreMissingMigrations;

    /**
     * Whether to ignore ignored migrations when reading the schema history table.
     */
    private boolean ignoreIgnoredMigrations;

    /**
     * Whether to ignore pending migrations when reading the schema history table.
     */
    private boolean ignorePendingMigrations;

    /**
     * Whether to ignore future migrations when reading the schema history table.
     */
    private boolean ignoreFutureMigrations = true;

    /**
     * Whether to allow mixing transactional and non-transactional statements within the
     * same migration.
     */
    private boolean mixed;

    /**
     * 建议设置为 false,按照order来执行
       */
    private boolean outOfOrder;

    /**
     * Whether to skip default callbacks. If true, only custom callbacks are used.
     */
    private boolean skipDefaultCallbacks;

    /**
     * Whether to skip default resolvers. If true, only custom resolvers are used.
     */
    private boolean skipDefaultResolvers;

    /**
     * Whether to automatically call validate when performing a migration.
     */
    private boolean validateOnMigrate = true;

    /**
     * Whether to batch SQL statements when executing them. Requires Flyway Pro or Flyway
     * Enterprise.
     */
    private Boolean batch;

    /**
     * File to which the SQL statements of a migration dry run should be output. Requires
     * Flyway Pro or Flyway Enterprise.
     */
    private File dryRunOutput;

    /**
     * Rules for the built-in error handling to override specific SQL states and error
     * codes. Requires Flyway Pro or Flyway Enterprise.
     */
    private String[] errorOverrides;

    /**
     * Licence key for Flyway Pro or Flyway Enterprise.
     */
    private String licenseKey;

    /**
     * Whether to enable support for Oracle SQL*Plus commands. Requires Flyway Pro or
     * Flyway Enterprise.
     */
    private Boolean oracleSqlplus;

    /**
     * Whether to issue a warning rather than an error when a not-yet-supported Oracle
     * SQL*Plus statement is encountered. Requires Flyway Pro or Flyway Enterprise.
     */
    private Boolean oracleSqlplusWarn;

    /**
     * 是否流化执行,需要flyway专业版本的支持
     */
    private Boolean stream;

    /**
     * File name prefix for undo SQL migrations. Requires Flyway Pro or Flyway Enterprise.
     */
    private String undoSqlMigrationPrefix;
}

从上可以看到,针对老的数据库,flyway也可以使用baseline的能力,对数据库做升级管理,用户可以针对各自的项目做到非常定制化的配置,如下

spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://127.0.0.1:3306/lexdemo?useUnicode=true&characterEncoding=UTF-8
    driver-class-name: com.mysql.jdbc.Driver

  flyway:
    enabled: true
    schemas: lex
    baseline-on-migrate: true
    baseline-version: 0
    clean-disabled: true

通过分析配置属性,我们可以大概看到flyway提供了callback和resolver两个扩展点,可以让我们定制化回调函数和解析器对sql进行个性化的解析。

flyway从入门到精通(七):spring boot中flyway执行源码分析

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342