org.flywaydb:flyway-community-db-support

Breaking changes

• Removedcheck.url, check.password and check.username. These undocumented historic fields have been deprecated for a while and have confusing impacts (such as not working in all check functionality). It is recommended to use environments to replace this functionality, alternatively, check does support standard url, username and password

Bug fixes

• Fixed an issue that the Repair command was unable to remove failed Repeatable migration entries in schema history table for MongoDB

Changes

• Backup provisioner now puts database into single user mode before restoring

• Legacy Flyway keys (FL0...) are now deprecated

Java compatibility

• Update H2 2.3.224 to 2.3.232

• Upgrade snowflake-jdbc 3.14.3 to 3.20.0 to fix CVE-2024-43382

Performance improvements

• Improved repair performance when removing failed migrations

Bug fixes

• Fix a bug where error messages are produced when check -drift is run without setting deployedSnapshot

• FLYWAY_PIPELINE_ID environment variable was previously broken but is now fixed

Changes

• The 'createSchema' callback is now deprecated and replaced by 'beforeCreateSchema'

Database compatibility

• Support PostgreSQL 17

Java compatibility

• jetty-server 9.4.53.v20231009 to 9.4.56.v20240826 to fix CVE-2024-8184

Thanks to cowwoc for reporting these issues.

Bug fixes

• Issue 3915 Fixed an issue that could cause Flyway to hang when a database connection is unavailable and there are a large number of pending migrations

Changes

• cleanOnValidationError is now deprecated

Database compatibility

• Updated snowflake driver to 3.14.3

New features

• Flyway now supports setting personal access token (PAT) through API

• Added a warning message if 'group' parameter is enabled for databases which don't support DDL transactions

Thanks to Quairix for reporting these issues.

Bug fixes

• Fixed the bug that prevented powershell scripts from running when located in a folder with spaces in the folder name.

• Fixed the issue where schemas might get inadvertently cleaned when running check in MySQL

Database compatibility

• Cassandra taken out of preview and added to OSS edition

New features

• Azure Identity is now a dependency of Flyway for SQL Server Active Directory MSI authentication

• Flyway now supports Environment Overrides for parameters configuration

Bug fixes

• Fix a bug where mongoDb database name was null

• Removed duplicate libraries from the command line

• Issue with ${flyway:workingDirectory} not using configured working directory has been fixed

• Fixed an issue where failed migrations could report a negative execution time

Changes

• The schema model's location is now also specified in schemaModelLocation in the Flyway namespace in Flyway.toml

Bug fixes

• Fixed bug where certain keywords in BigQuery and HSQL were not handled correctly when in lower case.

• Fix a bug where targetSchemaVersion is not set in API and JSON result objects when migrate fails, or no versioned migrations are applied

• Fix the bug preventing users from initiating a trial using the "auth" command

Database compatibility

• Issue 3900 Increase Cloud Spanner support to 2.18.1

• Issue 3905 Increase H2 support to 2.2.224

Java compatibility

• add file helpers

Thanks to credmond-git and BlueIce for reporting these issues.

Bug fixes

• Flyway shouldn't call SqlFluff if there are no pending migrations found

Changes

• Reworded exception messages when executing scripts fails to say "Script ... failed" instead of "Migration ... failed"

• 'beforeEachMigrateStatement' and 'afterEachMigrateStatement' callbacks are now open source features

• Updated wording on Drift Report

New features

• Personal Access Tokens are now supported as a method of authorizing Flyway

• 'versioned' and 'repeatable' can now be used for 'ignoreMigrationPatterns' in the open-source version.

Breaking changes

• Update ErrorCode and ErrorOutput to allow extending in plugins - The ErrorCode enum is now an interface with the base enum now residing in CoreErrorCode. Any Java usage of this enum will need to be updated accordingly.

Bug fixes

• Add support for stream configuration for ClassPath SQL Migrations

Changes

• Continue to improve the way Flyway honors the workingDirectory parameter

• Remove unrelated warning from polyglot engine.

• Broken up the check page into functional sections and reference & explanation material

• shouldExecuteExpression returned from info output in json format contained expression after placeholder replacement, rather than before placeholder replacement.

New features

• Added an init command which will create a project compatible with Flyway Desktop

• Create flyway.communityDBSupportEnabled to turn off community db support database types if desired

Java compatibility

• Update AWS S3 dependency to fix CVE-2024-29025

• Issue 3860 Remove need for java.desktop

Thanks to axelfontaine for reporting these issues.

Bug fixes

• Issue 3841 Fix issue with PostgreSQL when running in a transaction

Database compatibility

• Removed Oceanbase from Flyway CLI. If required, please download from Maven Central .

Changes

• output from flyway info can return the contents of a shouldExecute condition, if provided

• Issue 3835 Downgrade MariaDB Connect/J from 3.3.2 to 2.7.11 to continue to support latest MariaDB without compatibility issues with MySQL. MariaDB 3.X Connect/J requires for permitMysqlScheme flag in the URL

New features

• Provide Regex rules to replace the SQLFluff rules Flyway_L001 and Flyway_L002

Java compatibility

• Upgrade com.nimbusds:nimbus-jose-jwt@9.37.2 to fix CVE-2023-52428

Thanks to bhavneshpateloptum for reporting these issues.

Bug fixes

• Flyway errors running check -dryrun for MongoDB

• Fixed a bug with the Oracle PL/SQL parser which caused certain view definitions containing the 'FORCE' keyword to break.

• Issue 3837 Parameter settings through Environment variables got ignored if combined with command line parameter settings

Changes

• Bump Flyway-Community-DB-Support to 10.7.2

• Update AWS secrets manager JDBC dependency to 2.0.2.

• Flyway matches Oracle SQL*Plus behavior when parsing 'SHOW ERR[ORS]'.

Database compatibility

• Add Community DB Support for Oceanbase

Thanks to jerdaane for reporting these issues.

Bug fixes

• Resolve RedgateCompare toml being read incorrectly.

Changes

• Improved auth logging to be more concise

• Make Flyway "Target" an open source feature

• Make Flyway Detect Encoding an open source feature

• Make Flyway Batch an open source feature

• Make Flyway Stream an open source feature

Java compatibility

• Adding API friendly method to getEngines

New features

• adding support to configure environments via command line

New features

• Allow build environments to be processed by resolvers

Bug fixes

• Use instance variable of defaultProperties in DriverDataSource constructor instead of parameter variable

Database compatibility

• Add additional connection attributes when connecting to SingleStore

Thanks to AdalbertMemSQL for reporting these issues.

Breaking changes

• The clean command will also drop services and queues in SQL Server.

Bug fixes

• Correct redgate-compare options when using TOML with check and drift or changes.

• Fixed reports not displaying Teams and Enterprise level features

Database compatibility

• Issue 3806 Correct HSQLDB support message and increase driver support to 2.7.2

Thanks to ashtonbatty for reporting these issues.

Bug fixes

• Fix parsing of boolean comparison options

• Fixed a bug where comma-separated lists for configuration parameters passed in via command line would fail with a parsing error

Changes

• Update document on setting environment parameter through environment variable

• Upgrade version of Maven dependencies used by the Flyway Maven plugin to 3.9.6.

• Make datasource in classic config environment aware

• Improve error message for misconfigured environment variables in TOML config.

• Issue 3797 Use latest version of Apache Derby dependencies to avoid CVE-2022-46337.

Database compatibility

• Added support for cleaning table snapshots and table clones in Google BigQuery.

New features

• Can now start a trial with the auth command

• add supported-databases command.

Java compatibility

• Move flyway-sqlserver into flyway-database folder space

Thanks to fage88 for reporting these issues.

Bug fixes

• Correct urls for fetching offline permits

• Fix dropping views from GCP Spanner when running clean.

• Add new groupId to flyway-gradle-plugin

• Issue 3793 Fix index out of bounds issue in ConfigUtils

Database compatibility

• Flyway now supports PostgreSQL version 16.

• MongoDB 7.0 support available. Currently shipped as preview in Redgate edition CLI.

Breaking changes

• Updated to use dotnet 8 which drops support for RHEL 7 - this only impacts the check verb (drift and changes)

New features

• Flyway now uses Schema History Table locking to allow parallel migrations in Google Cloud Spanner.

Thanks to AlejandroYuste for reporting these issues.

Bug fixes

• Fixed handling of FLYWAY_JDBC_PROPERTIES_ACCESSTOKEN environment variable with toml projects

• Fixed bug caused by generation of unrecognized parameters when starting the Redgate Comparison engine process.

• Fixed making locations relative to the working directory when using TOML configuration.

• When using the new TOML configuration format, 'jarDirs' and 'schemas' will no longer be erased when also configuring certain parameters through the command line or environment variables.

New features

• add support for progress logging to STDERR with json output

Notes

• Flyway Gradle Plugin is currently unable to be released.

Flyway V10 has landed

Breaking changes

• Removed deprecated flyway.check.reportFilename. Please use flyway.reportFilename.

• The 'cherryPick' configuration option has been moved to a configuration extension. When using the API, it can no longer be directly set through configuration object - instead it is set using an 'cherryPickConfigurationExtension' object which must be retrieved from the plugin register. See the docs for this configuration parameter for more information.

• License key logic has been moved into a different module ('flyway-key-licensing'). This is not shipped in the open-source edition of Flyway so attempting to configure the license key will cause an error. In the Redgate edition of Flyway, license keys must be configured as a configuration extension (see configuration docs for more information).

• Rename lib/community with lib/flyway

• Removal of the default sql folder from Flyway CLI and Docker release

• Modularized database support in Flyway to allow greater flexibility. This includes; DB2, Derby, HSQLDB, Informix, PostgreSQL, CockroachDB, Redshift, SAP HANA, Snowflake and Sybase ASE. See Database Support page for your database for module dependency. If you are including Flyway in your project, either as a dependency or via the maven and gradle plugins please include the respective database module in your project configuration.

Changes

• Remove unused Edition flags documentation, E.G -community or -teams. These flags are no longer used by Flyway and have been marked for deprecation.

• The lowest supported Gradle version for the Flyway Gradle plugin is now 7.6. This is due to a known issue with older Gradle versions where it cannot handle dependencies with multi-release chars containing Java 19 code.

• Move older db support handling into OSS

• If flyway fails due to a licensing issue, return a unique (35) exit code

• Adjusted the wording on the 'deleted' Repair action to mention it only marks migrations as deleted

Database compatibility

• Flyway now supports MySQL 8.1.0.

• Include singlestore into Flyway Community Edition.

• Google Cloud Spanner has been released and is no longer BETA

New features

• Info filters are now available in community

• Added auth command to authorize Flyway online using Redgate username and password

• Added support for REDGATE_LICENSING_PERMIT_PATH and REDGATE_LICENSING_PERMIT environment variables along with offline licensing for offline machines

• beforeEachMigrateStatement, afterEachMigrateStatement, afterEachMigrateStatementError, and beforeConnect callbacks are now Community features

• add support for LocalSecrets resolvers

• Script migrations are now a Community feature

Java compatibility

• Retired Java 8 from use. Java 17 is now required for development

• Move packages and groupID from org.flywaydb.enterprise to com.redgate.flyway. Duplicate packages will be deployed to org.flywaydb.enterprise until a future release.

Notes

• Flyway Gradle Plugin is currently unable to be released.

Changes

• The AWS-Secrets JDBC driver included in the Commandline package has been upgraded to 2.0.0.

• Issue 3752 add "END CASE" support in BigQuery sql script

Database compatibility

• Update newest supported version of Snowflake to 7.33

Java compatibility

• Keep software.amazon.awssdk:s3 on latest 2.20.X release to get fix for CVE-2023-4586

• Upgrade software.amazon.awssdk:s3@2.20.94 to software.amazon.awssdk:s3@2.20.158 to fix CWE-295

Thanks to kankaiz for reporting these issues.

Bug fixes

• Fixed configuration disclosure in extended debug output. CVE-2023-43564

• improve parsing of 'ACCESSIBLE BY' clauses in Oracle

• Fix parsing issue caused by statements containing multiple sets of parentheses.

• Issue 3730 Make SLF4J detection also work with SLF4J 2.0

Changes

• Enhance Comparison engine error output

Database compatibility

• Flyway now supports MariaDB version 10.11

Java compatibility

• update mariadb-java-client to 2.7.10 to resolve CONJ-1091

Thanks to hho for reporting these issues.

Bug fixes

• Correctly parse Oracle wrapped statements.

• Fix filter file option detection

• Fix invalid flags not correctly erroring at the end of the arguments

Changes

• update Java 17 JRE included in Flyway CLI

Database compatibility

• Issue 3736 Increase CockroachDB support to V22.2

Thanks to trourance for reporting these issues.

Bug fixes

• Fix issue with check.reportFilename parameter

Changes

• Code Analysis will honor BaselineVersion configuration if SchemaHistory table is absent.

Changes

• check.buildUrl, check.buildUser and check.buildPassword are now deprecated. These will be replaced by check.buildEnvironment in Flyway 10.0

Database compatibility

• Flyway now supports Oracle 21.

• Issue 3726 Add MariaDB to Flyway H2 compatibility mode

New features

• allow external browser SSO in Snowflake

Java compatibility

• Issue 3723 Upgrade Jackson to 2.15.2

Thanks to oujesky and iamniche-too for reporting these issues.

Changes

• Added working directory variable to config

New features

• When running the SQL*Plus '@' command, Flyway will also search 'SQLPATH' and 'ORACLE_PATH' for runnable scripts. It will also attempt to load from absolute paths.

Java compatibility

• Upgrade H2 to 2.2.220

Bug fixes

• fix handling of plugin string array properties

• Previously, when migrating using Flyway's SQL*Plus feature, Flyway parsed the first statement of the migration script before reading 'login.sql'/'glogin.sql' files. These files are now fully read beforehand.

Changes

• Drop B Script functionality from teams into OSS

Changes

• Update Maven Version check to use Maven Metadata to avoid website deprecation issues

New features

• Added table feedback for SQL Plus

Java compatibility

• Upgrade AWS SDK to fix SNYK issue CVE-2023-34462

• Upgrade google-cloud-spanner to fix SNYK issue SNYK-JAVA-COMGOOGLEGUAVA-5710356

• Upgrade Google Cloud Secretmanager to 2.22.5 to fix SNYK-JAVA-COMGOOGLEGUAVA-5710356

• Upgrade Google Cloud Storage to 2.22.5 to fix SNYK-JAVA-COMGOOGLEGUAVA-5710356

• Update AWS Java SDK to 2.20.69 to fix SNYK-JAVA-IONETTY-5725787

• Issue 3690 flyway-core now has a dependency on jackson-dataformat-toml.

Thanks to froque for reporting these issues.

Changes

• RGCompare MySql support has gone GA

Database compatibility

• Flyway now supports the latest version on SQL Server 2022.

Bug fixes

• incorrect license shown above correct license

• Issue 3682 Fixed parsing of boolean values in configuration

Thanks to TheHenrick for reporting these issues.

Bug fixes

• Fix missing Jackson-Annotation dependency in CLI bundle

Bug fixes

• Improved parsing of CASE expressions inside function bodies.

• Fixed a bug encountered when cleaning Azure Synapse instances where Flyway referred to 'sys.xml_schema_collections` which only exists in SQL Server.

Bug fixes

• Fixed exit code when report is disabled and error occurs

Changes

• The SQLite driver shipped with the Flyway CLI has been updated to 3.41.2.2 to avoid CVE-2023-32697

• Flyway's SQLPlus 'FEEDBACK' output wording has been adjusted to match Oracle SQLPlus.

Database compatibility

• Fixed an issue where IF(..) function calls in MySQL functions could cause the statement parser to incorrectly split the function in two

Changes

• Extract Oracle code to plugin. This will need to be added as a new dependency. See Oracle documentation.

• Change error code on migration failure to be more specific and include script path and line number of failure in JSON error output

• Disable GET_LOCK on MariaDB connections when WSRERP=ON is present. This is to allow for usage of MariaDB with Galera clusters

• An event connection will be created to handle callbacks, and this connection will be released instantly after the event handle work is done.

• Baseline scripts with the same version number as an applied '<< Flyway Baseline >>' are now put in the 'Ignored (Baseline)' state. Also, migrations in this state appear before the '<< Flyway Baseline >>' in the info output instead of being put at the end.

• Update RGCompare version to 1.11.2.9265

New features

• Added driver() method to FluentConfiguration

Bug fixes

• Avoid hanging indefinitely during 'check' comparisons when running on Windows.

• Running check -changes or check -drift now handles schema creation rows in the schema history table.

Changes

• All undo migrations will no longer have their own rows in the ASCII-table output. This seemed redundant given that there's a separate Undoable column to provide this information. Also, there was some inconsistency whereby undo migrations in the AVAILABLE state were already filtered out but others were not.

• Baseline migrations now have the 'baseline' category in info output

• Issue 3665 Only warn if reports are unable to write to the default location rather than print an error

New features

• Flyway now handles defining PostgreSQL functions using BEGIN ATOMIC.

Java compatibility

• Bump maven version to address CVE-2021-29425

• Update documentation to provide solution to Snowflake JDBC JRE16+ issues

Thanks to sseide for reporting these issues.

Bug fixes

• Fixed the issue causing empty dry run reports when running flyway using the Maven plugin.

• Issue 3621 The Snowflake SQL parser can now handle escaping single quotes inside strings using backslash.

Changes

• Undo migrations which have not been applied will no longer cause validation to fail.

• add direct support for Alpine linux

• Remove unused Edition flags documentation, E.G -community or -teams. These flags are no longer used by Flyway and have been marked for deprecation. These flags will be removed in V10.

• Issue 3648 Ensure Flyway uses ALL_CREDENTIALS when using versions of Oracle where ALL_SCHEDULER_CREDENTIALS is deprecated. This is to avoid continuting to rely on functionality only retained in Oracle for backwards compatibility.

• Issue 3652 Remove redundant html extension on automatically generated reports and prevent generation of reports for currently unsupported verbs

New features

• Add Info report. You can now get a report of an info call as a tab in a flyway HTML report.

• We have improved support for WHENEVER SQLERROR EXIT in Oracle SQL*Plus. This now works on its own and no longer needs to be followed by FAILURE or SQL.SQLCODE.

• Add migration report

• Adding Flyway Reports; Single file HTML reports that expose important details and stats about your Flyway pipeline in an easy to read and share format.

Java compatibility

• Update version of snowflake-jdbc to 3.13.29 to fix SNYK-JAVA-NETSNOWFLAKE-5425048

• Issue 3664 Bump Snowflake JDBC to 3.13.3

• Issue 3664 ]Bump SQLite JDBC to 3.41.2.1 to address CVE-2021-20227, CVE-2022-35737 and CVE-2022-46908

• Issue 3664 Bump MariaDB JDBC to 2.7.9 to address race condition, metadata catalog, ArrayIndexOutOfBounceExcetions and other issues in JDBC driver

Thanks to lm-net, ryangraffy, jdmendozaa and frichtarik for reporting these issues.

Bug fixes

• Remove placeholder text from report summary

• Fix Nullpointer exception on empty exception in reports

Bug fixes

• Removed unwanted SLF4J messages on stderr

• Issue 3636 EnvironmentModel: swap back connectRetries and connectRetriesInterval default values

Changes

• Updated Postgres password change regex to use latest form

Java compatibility

• Update msal4j to fix SNYK-JAVA-NETMINIDEV-3369748

Performance improvements

• Reduce allocations from class loading through FeatureDetector

Thanks to mihalyr for reporting these issues.

Bug fixes

• Issue 3618 Fix reading in configuration from standard input in Teams and Enterprise edition.

• Issue 3621 Fixed a parsing error caused by begin transaction statements in Snowflake.

Changes

• Drift report titles have been renamed from 'Before' and 'After' to 'Expected' and 'Actual'.

Java compatibility

• Issue 3628 Update flyway-bom to use correct versioning system and deploy to Maven Central

Thanks to eddumelendez, frichtarik and Phil-Factor for reporting these issues.

Bug fixes

• SQL errors with configured overrides no longer cause the Oracle SQLPlus spool output to close prematurely and lead to a null pointer exception.

• Issue 3621 Further improvements to the Snowflake parser when detecting conditionally creatable objects.

Changes

• When running 'check' commands with involve database comparison (i.e. '-drift' and '-changes') and Flyway has debug enabled, debug output from the Redgate Compare engine will be logged as well.

Java compatibility

• Update Ant dependency version to address CVE-2020-11979, CVE-2021-36374, CVE-2021-36373 and CVE-2020-1945 vulnerabilities.

Thanks to frichtarik for reporting these issues.

Changes

• If Flyway encounters a SQL exception while Oracle Spool is set, the error information is now written to the Spool output.

Bug fixes

• Issue 3613 Allow the Snowflake parser to handle more conditionally creatable objects.

Thanks to niegowic for reporting these issues.

Breaking changes

• When Flyway is running in Oracle SQLPlus mode, character escaping is now disabled by default in order to be consistent with Oracle's SQLPlus command-line tool.

Bug fixes

• Issue 3616 Fixed a bug where migration patterns display names incorrectly changed case depending on default locale.

New features

• Introduced a flyway-bom pom for Maven. This BOM includes all modules of Flyway which are compatible with each other to be used in Maven dependency management.

Thanks to zihniogmen for reporting these issues.

Bug fixes

• Issue 3583 Fixed issues with the Snowflake SQL parser which failed to correctly parse scripting blocks containing 'if' and 'for' statements

• Fix issue with code analysis reports not generating when major or minor tolerance threshold has been passed and set build to fail.

Database compatibility

• Issue 3557 Update latest supported MariaDB version to 10.10

• Issue 3602 Flyway now officially supports snowflake versions up to 7.1

New features

• Added 'NON_EMPTY_SCHEMA_WITHOUT_SCHEMA_HISTORY_TABLE' as a new error code

Java compatibility

• As part of the ongoing work to improve Flyway we are looking at the current Java landscape and to the future. As a result, we are introducing Multi-Release builds for Flyway which will support Java 8 and Java 17. This allows us access to modern Java practices and technologies. This is with the aim to move fully to Java 17 in the next major release.

Thanks to pachu, hackyoMa and frichtarik for reporting these issues.

Bug fixes

• Explicitly drop Oracle package bodies so that package bodies not tied to an existing package are also cleaned

Changes

• 'check' reports now produce all successful reports and fail on the first non-successful report

• Update RGCompare engine to 1.6.0.7325

New features

• Regex Rule code analysis results now include the line and column number of where violations occurred

Bug fixes

• Issue 3581 Resolves migration resolvers not fully supporting instances for API users

Changes

• version operations (version or -v or --version) will now list the versions of all plugins (and if they are correctly licensed)

• Update AWS dependency to resolve CVE-2022-41915

Thanks to nafg for reporting these issues.

Bug fixes

• Flyway includes a custom SQL Fluff plugin, containing extra rules for enterprise users. Previously, if this custom plugin failed to install it would fail the whole process citing an absence of the correct SQL Fluff installation. It now only gives a warning so core SQL Fluff rules can still be run.

• Incorrectly errored when validating the configuration for the 'check -changes' command, when using a URL and a snapshot.

• Config parameter flyway.executeInTransaction should now correctly set when doing so via an environment variable.

• Issue 3582 Fix missing setBaselineVersion(MigrationVersion baselineVersion) on ClassicConfiguration

Changes

• Update RG Compare to 1.3.1.7159

Thanks to bmarcaur for reporting these issues.

Bug fixes

• Fix NPE that results when configuring either 'workingDirectory' or 'jarDirs'

New features

• Adds a new configuration parameter ('flyway.executeInTransaction') which determines whether SQL execution in a transaction is enabled.

Bug fixes

• Removed the parsing of nested multiline comments from Oracle. This is in line with their documentation that states nested multiline comments are not supported.

• Drift results now appear in the JSON and HTML reports when 'failOnDrift' is set and drift is present.

Changes

• The bundled Regex Rules are now case insensitive

• Update error message for invalid CLI argument to reflect possible fixes

• The version of the Postgres driver included in the CLI has been increased to 42.4.3 to avoid CVE-2022-41946

• Issue 3578 Fix documentation to use correct method to configure url, user and password in API

Database compatibility

• Support for BigQuery is now out of beta and in GA

Thanks to gastaldi for reporting these issues.