Package migratedb.core.api.configuration

Interface Configuration

    • Method Detail

      • getClassLoader

        ClassLoader getClassLoader()
        Retrieves the ClassLoader to use for loading migrations, resolvers, etc. from the classpath.
        Returns:
        The ClassLoader to use for loading migrations, resolvers, etc. from the classpath. (default: Thread.currentThread().getContextClassLoader() )

      • getUrl

        String getUrl()
        Retrieves the url used to construct the dataSource. May be null if the dataSource was passed in directly.
        Returns:
        The url used to construct the dataSource. May be null if the dataSource was passed in directly.

      • getUser

        String getUser()
        Retrieves the user used to construct the dataSource. May be null if the dataSource was passed in directly, or if dataSource did not need a user.
        Returns:
        The user used to construct the dataSource. May be null if the dataSource was passed in directly, or if dataSource did not need a user.

      • getPassword

        String getPassword()
        Retrieves the password used to construct the dataSource. May be null if the dataSource was passed in directly, or if dataSource did not need a password.
        Returns:
        The password used to construct the dataSource. May be null if the dataSource was passed in directly, or if dataSource did not need a password.

      • getDataSource

        DataSource getDataSource()
        Retrieves the dataSource to use to access the database. Must have the necessary privileges to execute DDL.
        Returns:
        The dataSource to use to access the database. Must have the necessary privileges to execute DDL.

      • getConnectRetries

        int getConnectRetries()
        The maximum number of retries when attempting to connect to the database. After each failed attempt, MigrateDB will wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries. The interval between retries doubles with each subsequent attempt.
        Returns:
        The maximum number of retries when attempting to connect to the database. (default: 0)

      • getConnectRetriesInterval

        int getConnectRetriesInterval()
        The maximum time between retries when attempting to connect to the database in seconds. This will cap the interval between connect retry to the value provided.
        Returns:
        The maximum time between retries in seconds (default: 120)

      • getInitSql

        String getInitSql()
        The SQL statements to run to initialize a new database connection immediately after opening it.
        Returns:
        The SQL statements. (default: null)

      • getBaselineVersion

        Version getBaselineVersion()
        Retrieves the version to tag an existing schema with when executing baseline.
        Returns:
        The version to tag an existing schema with when executing baseline. (default: 1)

      • getBaselineDescription

        String getBaselineDescription()
        Retrieves the description to tag an existing schema with when executing baseline.
        Returns:
        The description to tag an existing schema with when executing baseline. (default: << MigrateDB Baseline >>)

      • getResolvers

        MigrationResolver[] getResolvers()
        Retrieves the custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
        Returns:
        The custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply. An empty array if none. (default: none)

      • isSkipDefaultResolvers

        boolean isSkipDefaultResolvers()
        Whether MigrateDB should skip the default resolvers. If true, only custom resolvers are used.
        Returns:
        Whether default built-in resolvers should be skipped. (default: false)

      • getCallbacks

        Callback[] getCallbacks()
        Gets the callbacks for lifecycle notifications.
        Returns:
        The callbacks for lifecycle notifications. An empty array if none. (default: none)

      • isSkipDefaultCallbacks

        boolean isSkipDefaultCallbacks()
        Whether MigrateDB should skip the default callbacks. If true, only custom callbacks are used.
        Returns:
        Whether default built-in callbacks should be skipped. (default: false)

      • getSqlMigrationPrefix

        String getSqlMigrationPrefix()
        The file name prefix for versioned SQL migrations. Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix, which using the defaults translates to V1.1__My_description.sql
        Returns:
        The file name prefix for sql migrations. (default: V)

      • getBaselineMigrationPrefix

        String getBaselineMigrationPrefix()
        The file name prefix for baseline migrations. Baseline migrations represent all migrations with version <= current baseline migration version while keeping older migrations if needed for upgrading older deployments. They have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix, which using the defaults translates to SB.1__My_description.sql
        Returns:
        The file name prefix for baseline migration. (default: B)

      • getRepeatableSqlMigrationPrefix

        String getRepeatableSqlMigrationPrefix()
        Retrieves the file name prefix for repeatable SQL migrations. Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix, which using the defaults translates to R__My_description.sql
        Returns:
        The file name prefix for repeatable sql migrations. (default: R)

      • getSqlMigrationSeparator

        String getSqlMigrationSeparator()
        Retrieves the file name separator for sql migrations. SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix, which using the defaults translates to V1_1__My_description.sql
        Returns:
        The file name separator for sql migrations. (default: __)

      • getSqlMigrationSuffixes

        String[] getSqlMigrationSuffixes()
        The file name suffixes for SQL migrations. (default: .sql) SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix, which using the defaults translates to V1_1__My_description.sql Multiple suffixes (like .sql,.pkg,.pkb) can be specified for easier compatibility with other tools such as editors with specific file associations.
        Returns:
        The file name suffixes for SQL migrations.

      • getJavaMigrations

        JavaMigration[] getJavaMigrations()
        The additional Java-based migrations. These are not Java-based migrations discovered through classpath scanning and instantiated by MigrateDB. Instead these are manually added instances of JavaMigration. This is particularly useful when working with a dependency injection container, where you may want the DI container to instantiate the class and wire up its dependencies for you.
        Returns:
        The additional Java-based migrations. An empty array if none. (default: none)

      • isPlaceholderReplacement

        boolean isPlaceholderReplacement()
        Checks whether placeholders should be replaced.
        Returns:
        Whether placeholders should be replaced. (default: true)

      • getPlaceholderSuffix

        String getPlaceholderSuffix()
        Retrieves the suffix of every placeholder.
        Returns:
        The suffix of every placeholder. (default: } )

      • getPlaceholderPrefix

        String getPlaceholderPrefix()
        Retrieves the prefix of every placeholder.
        Returns:
        The prefix of every placeholder. (default: ${ )

      • getScriptPlaceholderSuffix

        String getScriptPlaceholderSuffix()
        Retrieves the suffix of every script placeholder.
        Returns:
        The suffix of every script placeholder. (default: __ )

      • getScriptPlaceholderPrefix

        String getScriptPlaceholderPrefix()
        Retrieves the prefix of every script placeholder.
        Returns:
        The prefix of every script placeholder. (default: FP__ )

      • getPlaceholders

        Map<String,​String> getPlaceholders()
        Retrieves the map of <placeholder, replacementValue> to apply to sql migration scripts.
        Returns:
        The map of <placeholder, replacementValue> to apply to sql migration scripts.

      • getTarget

        TargetVersion getTarget()
        Gets the target version up to which MigrateDB should consider migrations. Migrations with a higher version number will be ignored. Special values:
        • current: Designates the current version of the schema
        • latest: The latest version of the schema, as defined by the migration with the highest version
        • <version>? (end with a '?'): Instructs MigrateDB not to fail if the target version doesn't exist. In this case, MigrateDB will go up to but not beyond the specified target (default: fail if the target version doesn't exist)
        Returns:
        The target version up to which MigrateDB should consider migrations. Defaults to latest

      • getFailOnMissingTarget

        boolean getFailOnMissingTarget()
        Whether to fail if no migration with the configured target version exists (default: true)

      • getCherryPick

        MigrationPattern[] getCherryPick()
        Gets the migrations that MigrateDB should consider when migrating. Leave empty to consider all available migrations. Migrations not in this list will be ignored.
        Returns:
        The migrations that MigrateDb should consider when migrating.

      • getTable

        String getTable()
        Retrieves the name of the schema history table that will be used by MigrateDB. By default (single-schema mode) the schema history table is placed in the default schema for the connection provided by the datasource. When the migratedb.schemas property is set (multi-schema mode), the schema history table is placed in the first schema of the list.
        Returns:
        The name of the schema history table that will be used by MigrateDb. (default: migratedb_state)

      • getOldTable

        @Nullable String getOldTable()
        The old table to convert into the format used by MigrateDB. Only used for the "liberate" command.

      • getTablespace

        @Nullable String getTablespace()
        The tablespace where to create the schema history table that will be used by MigrateDB. If not specified, MigrateDB uses the default tablespace for the database connection. This setting is only relevant for databases that do support the notion of tablespaces. Its value is simply ignored for all others.
        Returns:
        The tablespace where to create the schema history table that will be used by MigrateDb.

      • getDefaultSchema

        String getDefaultSchema()
        The default schema managed by MigrateDB. This schema name is case-sensitive. If not specified, but schemas is, MigrateDB uses the first schema in that list. If that is also not specified, MigrateDb uses the default schema for the database connection.

        Consequences:

        • This schema will be the one containing the schema history table.
        • This schema will be the default for the database connection (provided the database supports this concept) .
        Returns:
        The schemas managed by MigrateDB. (default: The first schema specified in getSchemas(), and failing that the default schema for the database connection)

      • getSchemas

        String[] getSchemas()
        The schemas managed by MigrateDB. These schema names are case-sensitive. If not specified, MigrateDB uses the default schema for the database connection. If defaultSchemaName is not specified, then the first of this list also acts as default schema.

        Consequences:

        • MigrateDB will automatically attempt to create all these schemas, unless they already exist.
        • The schemas will be cleaned in the order of this list.
        • If MigrateDB created them, the schemas themselves will be dropped when cleaning.
        Returns:
        The schemas managed by MigrateDB. (default: The default schema for the database connection)

      • getEncoding

        Charset getEncoding()
        Retrieves the encoding of SQL migrations.
        Returns:
        The encoding of SQL migrations. (default: UTF-8)

      • getLocations

        Location[] getLocations()
        Retrieves the 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 SQL and Java-based migrations. Locations starting with filesystem: point to a directory on the filesystem, may only contain SQL migrations and are only scanned recursively down non-hidden directories.
        Returns:
        Locations to scan recursively for migrations. (default: classpath:db/migration)

      • isBaselineOnMigrate

        boolean isBaselineOnMigrate()
        Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table. This schema will then be initialized with the baselineVersion before executing the migrations. Only migrations above baselineVersion will then be applied.

        This is useful for initial MigrateDB production deployments on projects with an existing DB.

        Be careful when enabling this as it removes the safety net that ensures MigrateDB does not migrate the wrong database in case of a configuration mistake!

        Returns:
        true if baseline should be called on migrate for non-empty schemas, false if not. (default: false)

      • isSkipExecutingMigrations

        boolean isSkipExecutingMigrations()
        Whether MigrateDB should skip actually executing the contents of the migrations and only update the schema history table. This should be used when you have applied a migration manually (via executing the sql yourself, or via an ide), and just want the schema history table to reflect this.

        Use in conjunction with cherryPick to skip specific migrations instead of all pending ones.

        Returns:
        true if executing the migrations should be skipped on migrate, false if not. (default: false)

      • isOutOfOrder

        boolean isOutOfOrder()
        Allows migrations to be run "out of order". If you already have versions 1 and 3 applied, and now a version 2 is found, it will be applied too instead of being ignored.
        Returns:
        true if outOfOrder migrations should be applied, false if not. (default: false)

      • isIgnoreMissingMigrations

        boolean isIgnoreMissingMigrations()
        Ignore missing migrations when reading the schema history table. These are migrations that were performed by an older deployment of the application that are no longer available in this version. For example: we have migrations available on the classpath with versions 1.0 and 3.0. The schema history table indicates that a migration with version 2.0 (unknown to us) has also been applied. Instead of bombing out (fail fast) with an exception, a warning is logged and MigrateDB continues normally. This is useful for situations where one must be able to deploy a newer version of the application even though it doesn't contain migrations included with an older one anymore. Note that if the most recently applied migration is removed, MigrateDb has no way to know it is missing and will mark it as future instead.
        Returns:
        true to continue normally and log a warning, false to fail fast with an exception. (default: false)

      • isIgnoreIgnoredMigrations

        boolean isIgnoreIgnoredMigrations()
        Ignore ignored migrations when reading the schema history table. These are migrations that were added in between already migrated migrations in this version. For example: we have migrations available on the classpath with versions from 1.0 to 3.0. The schema history table indicates that version 1 was finished on 1.0.15, and the next one was 2.0.0. But with the next release a new migration was added to version 1: 1.0.16. Such scenario is ignored by migrate command, but by default is rejected by validate. When ignoreIgnoredMigrations is enabled, such case will not be reported by validate command. This is useful for situations where one must be able to deliver complete set of migrations in a delivery package for multiple versions of the product, and allows for further development of older versions.
        Returns:
        true to continue normally, false to fail fast with an exception. (default: false)

      • isIgnorePendingMigrations

        boolean isIgnorePendingMigrations()
        Ignore pending migrations when reading the schema history table. These are migrations that are available but have not yet been applied. This can be useful for verifying that in-development migration changes don't contain any validation-breaking changes of migrations that have already been applied to a production environment, e.g. as part of a CI/CD process, without failing because of the existence of new migration versions.
        Returns:
        true to continue normally, false to fail fast with an exception. (default: false)

      • isIgnoreFutureMigrations

        boolean isIgnoreFutureMigrations()
        Ignore future migrations when reading the schema history table. These are migrations that were performed by a newer deployment of the application that are not yet available in this version. For example: we have migrations available on the classpath up to version 3.0. The schema history table indicates that a migration to version 4.0 (unknown to us) has already been applied. Instead of bombing out (fail fast) with an exception, a warning is logged and MigrateDB continues normally. This is useful for situations where one must be able to redeploy an older version of the application after the database has been migrated by a newer one.
        Returns:
        true to continue normally and log a warning, false to fail fast with an exception. (default: true)

      • getIgnoreMigrationPatterns

        ValidatePattern[] getIgnoreMigrationPatterns()
        Ignore migrations that match this comma-separated list of patterns when validating migrations. Each pattern is of the form <migration_type>:<migration_state>. See the website for full details.

        Example: repeatable:missing,versioned:pending,*:failed

      • isValidateMigrationNaming

        boolean isValidateMigrationNaming()
        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.
        Returns:
        false to continue normally, true to fail fast with an exception. (default: false)

      • isValidateOnMigrate

        boolean isValidateOnMigrate()
        Whether to automatically call validate or not when running migrate.
        Returns:
        true if validate should be called. false if not. (default: true)

      • isCleanOnValidationError

        boolean isCleanOnValidationError()
        Whether to automatically call clean or not when a validation error occurs. This is exclusively intended as a convenience for development. even though we strongly recommend not to change migration scripts once they have been checked into SCM and run, this provides a way of dealing with this case in a smooth manner. The database will be wiped clean automatically, ensuring that the next migration will bring you back to the state checked into SCM. Warning! Do not enable in production!
        Returns:
        true if clean should be called. false if not. (default: false)

      • isCleanDisabled

        boolean isCleanDisabled()
        Whether to disable clean. This is especially useful for production environments where running clean can be quite a career limiting move.
        Returns:
        true to disable clean. false to leave it enabled. (default: true)

      • isMixed

        boolean isMixed()
        Whether to allow mixing transactional and non-transactional statements within the same migration. Enabling this automatically causes the entire affected migration to be run without a transaction.

        Note that this is only applicable for PostgreSQL, Aurora PostgreSQL, SQL Server and SQLite which all have statements that do not run at all within a transaction. This is not to be confused with implicit transaction, as they occur in MySQL or Oracle, where even though a DDL statement was run within a transaction, the database will issue an implicit commit before and after its execution.

        Returns:
        true if mixed migrations should be allowed. false if an error should be thrown instead. (default: false)

      • isGroup

        boolean isGroup()
        Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).
        Returns:
        true if migrations should be grouped. false if they should be applied individually instead. (default: false)

      • getInstalledBy

        String getInstalledBy()
        The username that will be recorded in the schema history table as having applied the migration.
        Returns:
        The username or null for the current database user of the connection. (default: null).

      • getErrorOverrides

        String[] getErrorOverrides()
        Rules for the built-in error handler that let you override specific SQL states and errors codes in order to force specific errors or warnings to be treated as debug messages, info messages, warnings or errors.

        Each error override has the following format: STATE:12345:W. It is a 5 character SQL state (or * to match all SQL states), a colon, the SQL error code (or * to match all SQL error codes), a colon and finally the desired behavior that should override the initial one.

        The following behaviors are accepted:

        • D to force a debug message
        • D- to force a debug message, but do not show the original sql state and error code
        • I to force an info message
        • I- to force an info message, but do not show the original sql state and error code
        • W to force a warning
        • W- to force a warning, but do not show the original sql state and error code
        • E to force an error
        • E- to force an error, but do not show the original sql state and error code

        Example 1: to force Oracle stored procedure compilation issues to produce errors instead of warnings, the following errorOverride can be used: 99999:17110:E

        Example 2: to force SQL Server PRINT messages to be displayed as info messages (without SQL state and error code details) instead of warnings, the following errorOverride can be used: S0001:0:I-

        Example 3: to force all errors with SQL error code 123 to be treated as warnings instead, the following errorOverride can be used: *:123:W

        Returns:
        The ErrorOverrides or an empty array if none are defined. (default: none)

      • isOutputQueryResults

        boolean isOutputQueryResults()
        Whether MigrateDB should output a table with the results of queries when executing migrations.
        Returns:
        true to output the results table (default: true)

      • getResourceProvider

        ResourceProvider getResourceProvider()
        Retrieves the custom ResourceProvider to be used to look up resources. If not set, the default strategy will be used.
        Returns:
        The custom ResourceProvider to be used to look up resources (default: null)

      • getJavaMigrationClassProvider

        ClassProvider<JavaMigration> getJavaMigrationClassProvider()
        Retrieves the custom ClassProvider to be used to look up JavaMigration classes. If not set, the default strategy will be used.
        Returns:
        The custom ClassProvider to be used to look up JavaMigration classes (default: null)

      • getCreateSchemas

        boolean getCreateSchemas()
        Whether MigrateDB should attempt to create the schemas specified in the schemas property.
        Returns:
        true to attempt to create the schemas (default: true)

      • getLockRetryCount

        int getLockRetryCount()
        The maximum number of retries when trying to obtain a lock. -1 indicates attempting to repeat indefinitely.

      • getJdbcProperties

        Map<String,​String> getJdbcProperties()
        Properties to pass to the JDBC driver object
        Returns:
        Properties that will be passed to the JDBC driver object

      • getFailOnMissingLocations

        boolean getFailOnMissingLocations()
        Whether to fail if a location specified in the migratedb.locations option doesn't exist
        Returns:
        true to fail (default: false)

      • getLogger

        LogSystem getLogger()
        The log system MigrateDB should use.

      • getDatabaseTypeRegister

        DatabaseTypeRegister getDatabaseTypeRegister()
        The database type register.

      • getLoadedExtensions

        Set<MigrateDbExtension> getLoadedExtensions()
        Unmodifiable set of extensions that have been loaded into this configuration.