org.flywaydb:flyway-community-db-support

Breaking changes

• Logic for the undo command has been moved into the separate 'flyway-proprietary' module, which will need to be present on the classpath in order to use the undo command. This also means that undo migrations will now be resolved in Community edition, and migrations may be marked as undone in the info output, though running the undo migrations still requires a Teams or Enterprise license. Lastly, when implementing undo migrations as java migrations, they should extend 'UndoJavaMigration' instead of 'BaseJavaMigration'.

Bug fixes

• Fix an issue where 'clean.mode' would not be detected in Enterprise

Changes

• We now use 'jackson-dataformat-toml' to read TOML config files, instead of 'night-config'.

• All 'check' results include the operation in the JSON result

• Include the code analysis engine's name in the summary logs

• Bump the version of Redgate Compare to 1.0.0.6319

• Move documentation to main repo

• Create a Dialect configuration to allow configuration of rules engine dialect via Flyway

• Add descriptions to shipped Regex Rules in the check report

• Bundled Regex Rules are now enabled by default

• Issue 3562 The version of 'jackson-dataformat' bundled in the CLI package has been bumped to 2.14.0 to avoid CVE-2022-42003

Database compatibility

• Issue 1317 Add SingleStoreDB support at the Teams level

• Issue 3570 Cockroach DB is now supported up to the latest version of 22.1

New features

• The JSON result for the 'check' command now includes the paths to any generated report

• SingleStoreDB JDBC driver is now shipped in the CLI

• Allows a configuration ('flyway.check.failOnDrift') to trigger an error if drift is detected with check -drift allowing the build to be halted should drift exist.

Thanks to nycjay, engvalla and basweitjens for reporting these issues.

Bug fixes

• Help output for 'check' no longer returns 'null' when 'outputType=json'

• Issue 3552 Fix Snowflake parser to handle nested 'BEGIN...END' statements

Changes

• Rule codes are now visible in Code Analysis HTML Reports

• Update version of MSAL4J to fix CVE-2022-42004

• Update AWS SecretsManager to fix CVE-2022-42004

New features

• Add bundled Code Analasys RegEx rules for Enterprise tiers

• A new rule has been added to the Flyway SQL Fluff plugin, which is applied when running code analysis. This rule checks that all tables created in TSQL have an 'MS_Description' extended property set in the same file.

• Add REGEX rules engine to -code for Enterprise tier

Thanks to pachu for reporting these issues.

Changes

• Move SQLFluff specific components into own module

• Increase hsqldb version from 2.6.1 to 2.7.1 to resolve CVE-2022-41853

• Issue 3489 PostgreSQL history table indexes and constraints now use the configured tablespace

• Issue 3516 Drop PostgreSQL DOMAINs with 'CASCADE'

New features

• Provide a Mac CLI for arm64 CPUs

• Issue 3535 Added error override behavior which excludes the full error/warning message and only shows the SQL state and error code.

Thanks to dev257, Peter-Laws and oaowren for reporting these issues.

Database compatibility

• Remove in-product warnings when using PostgreSQL 15

Changes

• Ensure correct version of SQL Fluff is installed

• Update version of 'commons-text' to fix vulnerability CVE-2022-42889

• Add edition to the version model

• When urls are unsupported by check, ascertain which ones are unsupported, and include them as part of the exception.

Database compatibility

• Issue 3539 Add support for PostgreSQL 15

New features

• Add custom code analysis rule that requires tables to have a primary key

• Add syntax highlighting to dry run reports

• Issue 3519 Replace SQLPlus placeholders that begin with a double '&'

Thanks to cowwoc and ben-peacock-uk for reporting these issues.

Changes

• Code analysis is now available in Community Edition

Database compatibility

• Add support for SQL Server 2022

New features

• Add configuration to allow flyway to fail when sqlfluff finds issues when running check code

Bug fixes

• Fix cases of 'cherryPick' causing issues with change and drift reports

• Fix bug where 'installedBy' wasn't always populated during a baseline

• Fixed bug when checking for changes or drift when multiple schemas are configured

Bug fixes

• Fix issues with Community Fallback

• Fix Windows paths with spaces causing classpath issues

New features

• Closed the Teams preview access to Change and Drift report. Please contact sales at sales@flywaydb.org for license information.

Skipped due to a regression.

Changes

• Add Community fallback warning to JSON output object

• Show correct validation message when checking for license keys that have expired.

Bug fixes

• Fix issue with Flyway not running correctly on Macs with a path that has a space

• Added null-check to avoid NPE when scanning inaccessible locations

• Fix bug in 'check' when comparing non-Oracle databases with configured schemas

• Issue 3515 Drop MariaDB JDBC driver back to major version 2 to enable MySQL compatibility

Changes

• Issue 3296 Schemas are now created if the user has edited flyway.schemas after an initial migration

Thanks to juliahayward and hemberger for reporting these issues.

Changes

• Check report UI improvements

• change and drift reports now fail for incompatible database types

Database compatibility

• Issue 3386 Updated to support Snowflake 6 and Snowflake Scripting

Java compatibility

• Remove JNA dependency as no longer needed by MariaDB

• Increase MariaDB driver version to 3.0.7

• Move flyway-commandline runtime dependency to correct scope

Thanks to filiprichtarik for reporting these issues.

Bug fixes

• Fix problems when appending to code analysis reports

• Fix bug in 'check -code' where multiple SQL files were not being correctly linted

• Configured suffixes are now case insensitive

Changes

• Improvements to the 'check' report

• Remove the error information from 'CompareResult' so that the existing JSON error handling is used

Java compatibility

• Remove unnecessary dependencies

• Moved Undo command into flyway-proprietary

• Remove unnecessary maven-model dependency

• Make 'CompositeResult' generic

• Issue 3505 Include transitive GAX dependency in CLI

Thanks to jward-premise for reporting these issues.

Bug fixes

• Issue 3499 connectRetriesInterval now defaults to 120 instead of 0 on the Maven plugin.

Changes

• code analysis now auto detects the dialect if a URL is provided, otherwise a '.sqlfluff' configuration file is needed

Thanks to mihalyr for reporting these issues.

New features

• Add SQLFluff to redgate/flyway Docker image for use with new integrations

Changes

• Issue 3498 Updated dependencies to fix vulnerabilities

New features

• Add 'dryrun' to check as a report that can be generated

Thanks to ggolawski for reporting these issues.

Changes

• Add access to Community features for Teams and Enterprise artifacts when no license key is given

• Issue 3491 PostgreSQL session locks now use one connection

Database compatibility

• Issue 3467 Added support for H2 2.1.214

Thanks to henricook and hackyoMa for reporting these issues.

Bug fixes

• check includes all transitive dependencies so it runs out of the box

• Issue 3479 BigQuery procedures containing END AS are not cut off early.

• Issue 3487 Update ensured supported to latest documented versions for Oracle and Snowflake

New features

• Issue 2895 Use transactional locks in PostgreSQL by default, which enables support for PgBouncer (session locks can be enabled again by setting 'flyway.postgresql.transactional.lock=false')

Java compatibility

• Update bundled JRE to latest version of Java 11 to include security updates

Thanks to arshaknorsoyan, matmannion and odin568 for reporting these issues.

Due to issues in the release process, this version is to be skipped as the artifacts are incomplete.

Due to issues in the release process, this version is to be skipped as the artifacts are incomplete.

Bug fixes

• Change reports now html encode SQL.

Bug fixes

• JSON output for 'drift' now always shows the 'driftDetected' field

Changes

• Improved tab styling of check reports

Changes

• Multiple 'check' reports now appear as tabs

• Serialize the LocalDateTime field in the check JSON result as a string

• No longer include .html when generating the JSON result for a check report

• bash entrypoint now adds 'native' folder to library path for use on Windows

• Only print the version information in Flyway once per execution

• No longer display the underlying 'DELETE' rows during 'info'

• License check now occurs when a Flyway object is constructed

Bug fixes

• Issue 3481 Fix cases where validation fails saying checksums of '0' are now 'null'

Thanks to henricook for reporting these issues.

Skipped due to a regression.

Breaking changes

• Migration patterns that are version numbers are treated as numbers rather than strings when matching to migrations

• Script & Java migrations are no longer executed during a dry run.

• 'getResolvedMigration' method on Java Migrations interface now takes a StatementInterceptor

• Don't clear the Url/Pass/Username when setting a data source

• Change default of cleanDisabled to true.

• Removed deprecated parameters for configuring secrets managers

• Removed parameter 'oracleKerberosConfigFile' as it is replaced by 'kerberosConfigFile'

• Removed parameters 'ignorePendingMigrations', 'ignoreMissingMigrations', 'ignoreIgnoredMigrations' and 'ignoreFutureMigrations' as they are replaced by 'ignoreMigrationPatterns'

• 'MigrationType' moved into 'extensibility' package as an enum and replaced with 'CoreMigrationType'

• 'SQL__BASELINE' and 'JDBC__BASELINE' migration types removed from 'flyway-core'

• 'CoreMigrationType' enum field 'baselineMigration' now called 'baseline', for which the type 'BASELINE' now returns true

• 'baselineMigrationPrefix' removed from Configuration - see the docs for this parameter for how to configure it via the API

• use 'BaselineJavaMigration' from the 'flyway-proprietary' package to make Java-based Baseline Migrations now

• Removed 'isUndo' and 'isBaselineMigration' from 'ResolvedMigration'

• 'Context' in 'resolveMigrations' on a 'MigrationResolver' is now a class which also has 'ResourceProvider', 'SqlScriptFactory' and 'SqlScriptExecutorFactory'

Changes

• Info filter 'infoOfState' now allows multiple states as a comma-separated list

• Handle errors (with warning) when cleaning procs on snowflake

• 'flyway/flyway-azure' Docker images are deprecated and replaced with 'flyway/flyway:*-azure'

Database compatibility

• H2 1.4 is now in Teams

• Oracle 12.2 is now in Teams

• MariaDB 10.2 is now in Teams

• HSQLDB 2.4 is now in Teams

• Issue 3469 Flyway CLI now bundles version 2.6.1 of the HSQLDB driver.

New features

• Add '-migrationIds' flag to 'info' to get a comma-separated list of versions or descriptions for repeatables

• Added the 'check' command to the Flyway CLI which lets you generate deployment reports. You can find more information here

Thanks to pzygielo for reporting these issues.

Bug fixes

• Issue 3388 The Ascii table will not be logged if there are no columns

• Issue 3428 Fix potential parsing bug during 'create package' statement in DB2

• Issue 3440 Always close the underlying Java connection inside a Database object

Thanks to CharmanderJieniJieni, AlexandruKetroy and medwards8 for reporting these issues.

Bug fixes

• Fix relative locations not being relative to the working directory

• Issue 3444 When using the delimiter keyword the value can be placed on the next line without entering an infinite loop

• Issue 3449 Update checker times out if it doesn't receive a response

• Issue 3454 The filename placeholder no longer causes errors in repeatable SQL migrations

Changes

• 'version' command now has JSON output

Thanks to sleepkever, csudhirr and alexandrugrigor for reporting these issues.

Changes

• Optimize param tokenization

• Update GCS dependency due to vulnerability

Java compatibility

• Update AWS ASK , AWS_SECRETSMANAGER-JDBC, Maven Core and MSAL4J dependencies to fix vulnerabilities

Bug fixes

• Fix NPE in Oracle when 'echo' is set to 'on' during spool

Changes

• Manually register the Oracle driver so Flyway CLI works with AWS Secrets Manager

Java compatibility

• Update recommended Spring JDBC version due to Spring vulnerability

Bug fixes

• Issue 3427 PLSQL division on new line in package body is no longer classified as a delimiter

• Issue 3433 Fix bug where connection details set in placeholders were overriding the main details

Changes

• Handle errors (with warning) when cleaning procs on snowflake

Thanks to olavquorum and bennyr1003 for reporting these issues.

Bug fixes

• Issue 3418 Fix error where the 'version' command fails to be handled

Thanks to cies for reporting these issues.

Changes

• Update S3 dependency to fix vulnerability

Changes

• Add a failed state for Baseline Migrations

• Update version of Jackson Databind due to GHSA-57j2-w4cx-62h2

• Mask any parameter that ends with 'password' in the logs

• Issue 3414 Ensure we close the connection created during the update stage

Database compatibility

• Issue 3399 Add support for STRICT and LEGACY modes in H2

Thanks to medwards8 and MMaus for reporting these issues.

Bug fixes

• SQL*Plus 'spool' now ignores value of 'feedback' for update statements

• Issue 3413 Script migrations applied previously using Teams Edition no longer cause an error in Community Edition

Java compatibility

• Upgrade jackson-databind to address CVE-2020-36518

Thanks to xmanemran for reporting these issues.

Changes

• Update PostgreSQL driver to fix code injection vulnerability

New features

• Issue 3358 Add 'placeholderSeparator' parameter to allow an alternative to ':' in default placeholders

Thanks to Phil-Factor for reporting these issues.

Breaking changes

• Issue 3405 Update shipped MSSQL JDBC driver to 10.2.0, which defaults 'encrypt' to 'true'

Bug fixes

• Fix issue where post schema clean didn't include correct schemas.

• Clean mode now cleans more schemas for SQL Server integrated authentication logins.

• Issue 3396 Maven and Gradle plugins load configuration files from current directory by default

Thanks to caseyhall and lbreuss for reporting these issues.

Bug fixes

• Clean mode now cleans more schemas for SQL Server integrated authentication logins.

Changes

• Issue 3403 Add info log saying number of SQL migrations skipped due to invalid naming, if any.

Thanks to sesgoe for reporting these issues.

Bug fixes

• Check if default 'jarDir' exists before using it

Changes

• Update Jackson Databind to 2.12.6

Bug fixes

• Fix exit code in Windows returning as 0 during error

• Fix possible NPE when no default schema is specified

• Ensure 'defaultSchema' is used over the first schema in 'schemas'

Changes

• Upgrade PostgreSQL driver to fix RCE vulnerability

• Remove displaying "user 'null'" when using Windows Authentication with SQL Server

Bug fixes

• Fix rare NPE when checking for updates

Changes

• Printing version no longer exits early

Changes

• Bump H2 version to avoid vulnerability

• Removing Autotrial feature

New features

• Add the path to the undo migration in the 'info' JSON output

• Issue 3378 New callback, triggered by migrations with newly applied scripts

Thanks to troosan for reporting these issues.

Bug fixes

• Fix bug in Vault integration where it thinks the user is running Community edition incorrectly

Changes

• Update Google dependencies to fix DoS vulnerability in protobuf

Changes

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

• Bump Log4J suggested version to 2.17.1 to mitigate CVE-2021-44832

• Issue 3372 Bump H2 to 2.0.206 due to GHSA-h376-j262-vhq6

Database compatibility

• Issue 3357 Add MariaDB 10.2 support back to Community edition

Thanks to everflux and dblackstock for reporting these issues.

Changes

• Upgrade suggested version of Log4J to 2.17

Thanks to everyone who reported these issues.

Bug fixes

• Issue 3347 Fix NPE when parsing single-line 'BEGIN' statements in SQL Server and detect 'BEGIN CONVERSATION' and 'BEGIN DIALOG'

Changes

• Teams license check no longer requires valid URL

Database compatibility

• Issue 3343 Continue supporting TiDB in Community

New features

• Issue 3365 Allow disabling placeholder replacement on a per-script basis

Thanks to noobgramming, jasouyris and md5 for reporting these issues.

Changes

• Upgrade suggested version of Log4J to 2.16

Changes

• Upgrade suggested version of Log4J to 2.15

• Issue 3339 Upgrade H2 version to 2.0.202

• Issue 3341 Remove unnecessary warning for MariaDB driver when connecting to a MySQL database on compatible database versions

Thanks to zenpaul and hemberger for reporting these issues.

Bug fixes

• Escape db name during doExists in MSSQL

Changes

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

Breaking changes

• Removing MySQL Driver from inclusion in Flyway distribution due to License. MariaDB will be used as fallback driver if no MySQL driver is present on the Classpath.

Bug fixes

• Issue 3331 Stop Flyway dropping schemas it did not create

Thanks to chipilov for reporting these issues.

Bug fixes

• Grab DBMS_OUTPUT from Oracle when handling errors

Changes

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

• Clean XML Schema Collections in SQL Server

• Issue 3329 Allow null values for installed on by using commit timestamp in GCP Cloud Spanner

• Issue 3332 Update GSON to 2.8.9

New features

• Add validation patterns to repair for missing migrations

Thanks to plaflamme and leyuzhu for reporting these issues.

Bug fixes

• fix bug where notice level logs ignored the minimum log level configured

Changes

• Clean XML Schema Collections in SQL Server

• Rename 'FlywayExtension' in the API to 'PluginMetadata'

• Issue 3327 Replace SET SQLBLANKLINES warning with debug message

New features

• Add 'beforeConnect' callback to Teams that executes before Flyway establishes a connection

• Add support for SQL*Plus variable concatenation

Thanks to everyone who reported these issues.

Breaking changes

• Replace 'ApiExtension' with 'ConfigurationExtension'. Instead of calling 'getExtensionConfiguration()' on a Configuration object, you must now call 'getConfigurationExtension()' on 'PluginRegister' which returns a 'ConfigurationExtension'

Bug fixes

• Add look ahead to parser to fix wrapped sql statements

• Fix bug with logs not appearing when using 'jarDirs'

Changes

• add notice log pointing to Flyway Hub on completion of validate command

Bug fixes

• Issue 3304 Fix bug in parsing MySQL with multiple 'CASE' statements inside 'ORDER BY'

• Issue 3310 Fix bug in detecting emptiness in non-existent schemas

• Issue 3311 Fix bug in time function used when updating BigQuery lock

Changes

• Issue 3307 Remove warning around schemas from CockroachDB

Database compatibility

• Issue 3309 Support MariaDB 10.6

• Issue 3313 Add support for PostgreSQL 14

New features

• Add ability to specify 'target=next' to apply just the next migration

• Add Kerberos authentication support for SQL Server

• Issue 3306 Add 'ignoreMigrationPatterns' setter that takes an array of 'ValidatePattern's

Thanks to kevinrjones, cowwoc, todd-dev, A248, geirolz, klesniewski and md5 for reporting these issues.

Changes

• The JSON output for 'flyway migrate' now contains additional information about successful migrations run up to the point of failure when a migration fails

New features

• Allow wildcard usage of 'ignoreMigrationPatterns' from within Community Edition

Bug fixes

• Fix bug where encoding detection would fail if the file was empty

• Issue 3299 Fix bug in the availability of custom placeholders in script migrations

Changes

• Set 10G field limit to using GCP Spanner in Community Edition

New features

• All Gradle tasks now return a result object

Thanks to Phil-Factor for reporting these issues.

Breaking changes

Flyway V8 introduced breaking changes incrementally over 3 beta releases. Check them below to see all breaking changes when upgrading to Flyway V8.

Bug fixes

• Fix issues in applying new migrations on top of baseline migrations

• Issue 3291 Fix parsing of multiline configuration parameters that contain a '='

• Issue 3292 Fix parsing of empty statements in SQLServer

Thanks to vincentoconnell and brynjulv for reporting these issues.

Breaking changes

• change Configuration boolean getter methods to match Java standard naming convention. (FailOnMissingTarget, DetectEncoding, OutputQueryResults, CreateSchemas and FailOnMissingLocations)

Bug fixes

• Issue 3279 Fix constantly repairing migrations with an empty description

• Issue 3284 HSQLDB not parsing DECLARE CURSOR foo FOR SELECT ... correctly

Changes

• Set 10GB data size limit to using GCP BigQuery in Community Edition

• Rename State Scripts to Baseline Migrations

Database compatibility

• Support latest version of Azure SQL Server in Community Edition

New features

• Add Command-line extensibility point to allow custom CLI verbs

• Add support for DAPR and GCSM Secrets Managers

Java compatibility

• Add base dependencies for Project Lombok

Thanks to StefanA2 for reporting these issues.

Bug fixes

• Issue 3275 Fix parsing of identifiers with quotes in PostgreSQL

• Issue 3279 Repair now checks for an empty description

New features

• Issue 3277 Add default placeholders to script migrations

Performance improvements

• Issue 3278 Remove redundant update check during license check

Thanks to tychokamphuis-accommodatiehuur, ewie, StefanA2 and Phil-Factor for reporting these issues.