Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel


Summary

Extension to support the tool pt-online-schema-change from Percona Toolkit. This extension replaces a couple of the default changes to use pt-online-schema-change instead of SQL. This allows to perform a non-locking database upgrade.

Current Version

1.34.10

Author

Andreas Dangel (adangel [at] users.sourceforge.net)

Issue Tracking

https://github.com/adangel/liquibase-percona/issues

Source Repository

https://github.com/adangel/liquibase-percona.git

Maven Coordinates

com.github.adangel.liquibase.ext:liquibase-percona

Supported Database

MySQL


...

October 19, 2014

1.0.0

  • compatible with liquibase 3.2.x
November 6, 20141.1.0
  • compatible with liquibase 3.3.0
July 26, 20151.1.1
  • Fixed #1: Tables with foreign keys
April 2, 20161.2.0
  • Fixed #2: Adding indexes via pt-online-schema-change
  • Fixed #3: Altering column data types via pt-online-schema-change
  • Added configuration property "liquibase.percona.skipChanges"
  • Upgraded liquibase to 3.4.2
September 13, 20161.2.1
  • PR #4: Allow passing additional command line options to pt-online-schema-change
  • PR #5: Support afterColum attribute
December 18, 20161.3.0
  • Upgraded liquibase to 3.5.3
  • Support for MySQL Connector 6.0.x in addition to 5.1.x.
  • Fixed #7: Foreign key constraints of AddColumn is ignored
  • Fixed #8: Support addForeignKeyConstraintChange, addUniqueConstraintChange
  • Fixed #9: Support for enabling pt-online-schema-changes on a per-change basis
  • Fixed #10: Build fails with java7: UnsupportedClassVersion when running DatabaseConnectionUtilTest.testGetPasswordMySQL_6
July 21, 20171.3.1
  • Fixed
#12: Cannot run migrations with the percona extension on a Spring Boot app with embedded Tomcat
July 21, 20171.4.0
  • Fixed
#13: Use default liquibase.properties as fallback


Attachments

Readme

Supported Databases

...

  • Liquibase 3.2.0 (liquibase-percona 1.0.0)
  • Liquibase 3.3.0 (liquibase-percona 1.1.1)
  • Liquibase 3.3.5 and 3.4.2 (liquibase-percona 1.2.1)
  • Liquibase 3.3.5, 3.4.2, and 3.5.3 (liquibase-percona 1.3.1, 1.4.0)

Supported Changes and examples

...

  • liquibase.percona.failIfNoPT: true/false. Default: false. If set to true, the database update will fail, if the command pt-online-schema-change is not found. This can be used, to enforce, that percona toolkit is used.

  • liquibase.percona.noAlterSqlDryMode: true/false. Default: false. When running updateSQL or rollbackSQL in order to generate a migration SQL file, the command line, that would be executed, will be added as a comment. In addition, the SQL statements (as produced by liquibase-core) will also be generated and output into the migration file. This allows to simply execute the generated migration SQL to perform an update. However, the Percona toolkit won't be used. If this property is set to true, then no such SQL statements will be output into the migration file.

  • liquibase.percona.skipChanges: comma separated list of changes. Default: <empty>. This option can be used in order to selectively disable one or more changes. If a change is disabled, then the change will be executed by the default liquibase core implementation and percona toolkit won't be used. By default, this property is empty, so that all supported changes are executed using the percona toolkit. Example: Set this to addColumn,dropColumn in order to not use percona for adding/dropping a column.

  • liquibase.percona.options: String of options. Default: <empty>.
    This option allows the user to pass additional command line options to pt-online-schema-change. This e.g. can be used in complication replication setup to change the way slaves are detected and how their state is used. You can also specify a percona configuration file via --config file.conf, see Configuration Files. Multiple options are separated by space. If argument itself contains a space, it must be quoted with double-quotes, e.g. --config "filename with spaces.conf.
  • liquibase.percona.defaultOn: true/false. Default: true. Since liquibase-percona 1.3.0 This options allows to change the default behavior for the UsePercona flag. By default, all changes, that do not explicitly specify this flag, use the value from this system property. Settings this property to false allows to control for each single change, whether to use Percona Toolkit or not.

You can set these properties by using the standard java -D option:

...

  • liquibase.password: String with the password needed to connect to the database. Default: <empty>. Since liquibase-percona 1.4.0. With this property, you can shortcut the automatic detection of the password from the underlying java.sql.Connection (if that fails) or from the default liquibase.properties file. If this property is set, then it is used for the password when executing pt-online-schema-change.

You can set these properties by using the standard java -D option:

java -Dliquibase.percona.skipChanges=createIndex,dropColumn -jar liquibase.jar ...

...

After extracting the zip file of liquibase, place liquibase-percona-1.34.10.jar file in the sub directory lib. The shell script liquibase / liquibase.bat will automatically pick this up and the extension is available.

...

<dependency>
    <groupId>com.github.adangel.liquibase.ext</groupId>
    <artifactId>liquibase-percona</artifactId>
    <version>1.34.1<0</version>
</dependency>

Using snapshots

...

And just use the latest SNAPSHOT version for liquibase-percona dependency, e.g. 1.4.01-SNAPSHOT:

<dependency>
    <groupId>com.github.adangel.liquibase.ext</groupId>
    <artifactId>liquibase-percona</artifactId>
    <version>1.4.01-SNAPSHOT</version>
</dependency>

...