Configuration Reference

Whether Flyway-MongoDB is enabled during the build.

If Flyway-MongoDB is disabled, the Flyway-MongoDB beans won’t be created and Flyway won’t be usable.

Environment variable: QUARKUS_FLYWAY_MONGODB_ENABLED

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 JavaScript and JSON-based migrations.

Locations starting with filesystem: point to a directory on the filesystem, may only contain migration scripts and are only scanned recursively down non-hidden directories.

Environment variable: QUARKUS_FLYWAY_MONGODB_LOCATIONS

Comma-separated list of file suffixes to recognize as migration scripts. Defaults to .js. Set to .json to use JSON-format migrations instead; JSON migrations do not require mongosh to be installed. The flyway-database-nc-mongodb connector does not support mixing .js and .json migrations in the same project.

Environment variable: QUARKUS_FLYWAY_MONGODB_MIGRATION_SUFFIXES

Flag to activate/deactivate Flyway for a specific MongoDB client at runtime.

Environment variable: QUARKUS_FLYWAY_MONGODB_ACTIVE

The maximum number of retries when attempting to connect to the database.

After each failed attempt, Flyway will wait up to the configured connect-retries-interval duration before attempting to connect again, up to the maximum number of times specified by connectRetries.

Environment variable: QUARKUS_FLYWAY_MONGODB_CONNECT_RETRIES

The maximum time between retries when attempting to connect to the database.

This will cap the interval between connect retries to the value provided.

Environment variable: QUARKUS_FLYWAY_MONGODB_CONNECT_RETRIES_INTERVAL

Optional override for the connection string Flyway uses. Defaults to the corresponding quarkus.mongodb.<client>.connection-string.

Environment variable: QUARKUS_FLYWAY_MONGODB_CONNECTION_STRING

Target database for migrations. Defaults to the corresponding quarkus.mongodb.<client>.database.

Environment variable: QUARKUS_FLYWAY_MONGODB_DATABASE

Schema history collection name.

Environment variable: QUARKUS_FLYWAY_MONGODB_COLLECTION

The file name prefix for versioned migrations. Versioned migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix, which using the defaults translates to V1.1__My_description.js

Environment variable: QUARKUS_FLYWAY_MONGODB_MIGRATION_PREFIX

The file name prefix for repeatable migrations. Repeatable migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix, which using the defaults translates to R__My_description.js

Environment variable: QUARKUS_FLYWAY_MONGODB_REPEATABLE_MIGRATION_PREFIX

true to execute Flyway clean command automatically when the application starts, false otherwise.

Environment variable: QUARKUS_FLYWAY_MONGODB_CLEAN_AT_START

true to prevent Flyway clean operations, false otherwise.

Environment variable: QUARKUS_FLYWAY_MONGODB_CLEAN_DISABLED

true to execute Flyway automatically when the application starts, false otherwise.

Environment variable: QUARKUS_FLYWAY_MONGODB_MIGRATE_AT_START

true to execute a Flyway repair command when the application starts, false otherwise.

Environment variable: QUARKUS_FLYWAY_MONGODB_REPAIR_AT_START

true to execute a Flyway validate command when the application starts, false otherwise.

Environment variable: QUARKUS_FLYWAY_MONGODB_VALIDATE_AT_START

true to automatically execute a Flyway clean command when a validation error occurs at start, false otherwise.

Environment variable: QUARKUS_FLYWAY_MONGODB_VALIDATE_AT_START_CLEAN_ON_VALIDATION_ERROR

true to execute Flyway baseline before migrations. This flag is ignored if the flyway_schema_history collection already exists. Note that this will not automatically call migrate, you must either enable baselineAtStart or programmatically call flyway.migrate().

Environment variable: QUARKUS_FLYWAY_MONGODB_BASELINE_ON_MIGRATE

true to execute Flyway baseline automatically when the application starts. This flag is ignored if the flyway_schema_history collection already exists. Note: this does not also call migrate; pair with migrate-at-start if needed.

Environment variable: QUARKUS_FLYWAY_MONGODB_BASELINE_AT_START

The initial baseline version.

Environment variable: QUARKUS_FLYWAY_MONGODB_BASELINE_VERSION

The description to tag an existing schema with when executing baseline.

Environment variable: QUARKUS_FLYWAY_MONGODB_BASELINE_DESCRIPTION

Whether to automatically call validate when performing a migration.

Environment variable: QUARKUS_FLYWAY_MONGODB_VALIDATE_ON_MIGRATE

Allows migrations to be run "out of order".

Environment variable: QUARKUS_FLYWAY_MONGODB_OUT_OF_ORDER

Ignore missing migrations when reading the history table. When set to true migrations from older versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail.

Environment variable: QUARKUS_FLYWAY_MONGODB_IGNORE_MISSING_MIGRATIONS

Ignore future migrations when reading the history table. When set to true migrations from newer versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail.

Environment variable: QUARKUS_FLYWAY_MONGODB_IGNORE_FUTURE_MIGRATIONS

Sets the placeholders to replace in migration scripts.

Environment variable: QUARKUS_FLYWAY_MONGODB_PLACEHOLDERS__PLACEHOLDER_KEY_

Prefix of every placeholder (default: ${ )

Environment variable: QUARKUS_FLYWAY_MONGODB_PLACEHOLDER_PREFIX

Suffix of every placeholder (default: } )

Environment variable: QUARKUS_FLYWAY_MONGODB_PLACEHOLDER_SUFFIX

Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention. A failure can be useful to check that errors such as case sensitivity in migration prefixes have been corrected.

Environment variable: QUARKUS_FLYWAY_MONGODB_VALIDATE_MIGRATION_NAMING

Ignore migrations during validate and repair according to a given list of patterns. When this configuration is set, the ignoreFutureMigrations and ignoreMissingMigrations settings are ignored. Patterns are comma separated.

Environment variable: QUARKUS_FLYWAY_MONGODB_IGNORE_MIGRATION_PATTERNS