GitHub LogoView the Project on GitHub

  • Overview
  • Get Started
    • Overview
    • Why database migrations
    • How MigrateDB works
  • First steps
    • API
  • Concepts
    • Migrations
    • Callbacks
    • Baseline Migrations
  • Commands
    • Migrate
    • Info
    • Validate
    • Baseline
    • Repair
  • Usage
  • API (Java)
    • Overview
    • Hooks
    • Javadoc
  • Maven
    • Overview
    • Site
  • Gradle
    • Overview
    • Error Codes
    • Community Plugins
  • Tutorials
    • Baseline Migrations
    • Java-based migrations
    • Callbacks
    • Custom Validation Rules
  • Configuration
  • Parameters
    • Overview
    • baselineDescription
    • baselineMigrationPrefix
    • baselineOnMigrate
    • baselineVersion
    • batch
    • callbacks
    • cherryPick
    • connectRetries
    • connectRetriesInterval
    • createSchemas
    • defaultSchema
    • encoding
    • failOnMissingLocations
    • group
    • ignoreFutureMigrations
    • ignoreIgnoredMigrations
    • ignoreMissingMigrations
    • ignorePendingMigrations
    • ignoreMigrationPatterns
    • initSql
    • installedBy
    • jdbcProperties
    • locations
    • lockRetryCount
    • loggers
    • mixed
    • oracleKerberosCacheFile
    • oracleKerberosConfigFile
    • oracleSqlPlus
    • oracleSqlPlusWarn
    • oracleWalletLocation
    • outOfOrder
    • outputQueryResults
    • placeholderPrefix
    • placeholderReplacement
    • placeholders
    • placeholderSeparator
    • placeholderSuffix
    • repeatableSqlMigrationPrefix
    • resolvers
    • schemas
    • scriptPlaceholderPrefix
    • scriptPlaceholderSuffix
    • skipDefaultCallbacks
    • skipDefaultResolvers
    • skipExecutingMigrations
    • sqlMigrationPrefix
    • sqlMigrationSeparator
    • sqlMigrationSuffixes
    • table
    • tablespace
    • target
    • validateMigrationNaming
    • validateOnMigrate
    • Script Config Files
    • Placeholders
  • Supported Databases
    • Aurora MySQL
    • Aurora PostgreSQL
    • Azure Synapse
    • Google Big Query
    • Cloud Spanner
    • CockroachDB
    • DB2
    • Derby
    • Firebird
    • H2
    • HSQLDB
    • Informix
    • MariaDB
    • MySQL
    • Oracle
    • Percona XtraDB Cluster
    • PostgreSQL
    • Redshift
    • SAP HANA
    • Snowflake
    • SQLite
    • SQL Server
    • Sybase ASE
    • TestContainers
    • TimescaleDB
    • TiDB
    • YugabyteDB
  • Learn more
    • Existing Database Setup
    • FAQ
  • Contribute
    • Contributing to MigrateDB
    • Database Compatibility
    • Documentation
    • Code
    • Attribution

Configuration

MigrateDB has many different parameters that can be set to configure its behavior. These parameters can be set through a variety of different means, depending on how you are using MigrateDB.

Usage

When using the API, config parameters can be set via calling methods on the configuration object returned by MigrateDb.configure() (e.g. MigrateDb.configure().connectRetries(5).load()) , configuration files.

Parameters

Connection

  • connectRetries
  • connectRetriesInterval
  • initSql

General

  • batch
  • callbacks
  • cherryPick
  • configFileEncoding
  • configFiles
  • encoding
  • errorOverrides
  • group
  • installedBy
  • jarDirs
  • kerberosConfigFile
  • licenseKey
  • locations
  • failOnMissingLocations
  • lockRetryCount
  • loggers
  • mixed
  • outOfOrder
  • outputQueryResults
  • skipDefaultCallbacks
  • skipDefaultResolvers
  • skipExecutingMigrations
  • stream
  • table
  • tablespace
  • target
  • validateMigrationNaming
  • validateOnMigrate

Schema

  • createSchemas
  • defaultSchema
  • schemas

Baseline

  • baselineDescription
  • baselineOnMigrate
  • baselineVersion

Validate

  • ignoreFutureMigrations
  • ignoreIgnoredMigrations
  • ignoreMissingMigrations
  • ignorePendingMigrations
  • ignoreMigrationPatterns

Migrations

  • repeatableSqlMigrationPrefix
  • resolvers
  • sqlMigrationPrefix
  • sqlMigrationSeparator
  • sqlMigrationSuffixes
  • baselineMigrationPrefix

Placeholders

  • placeholderPrefix
  • scriptPlaceholderPrefix
  • placeholderReplacement
  • placeholders
  • placeholderSeparator
  • placeholderSuffix
  • scriptPlaceholderSuffix

 

 

This work, "MigrateDB Documentation", is a derivative of "Flywaydb.org" by the Flyway contributors, used under CC BY SA 4.0. "MigrateDB Documentation" is licensed under CC BY SA 4.0 by the MigrateDB contributors.

Code licensed under Apache License, Version 2

All trademarks, trade names, logos or service marks mentioned on this site belong to their respective owners.