migratedb:scan

Full name:

de.unentscheidbar:migratedb-maven-plugin:0.3.0:scan

Description:

Scans the output of this project (and optionally its dependencies) for database migration resources, e.g. scripts, so they can be found as a 'classpath:' location.

MigrateDB looks for the scan results in db/migration unless you tweak its configuration.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile+runtime.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: process-classes.

Optional Parameters

Name Type Since Description
<failBuildOnUnprocessableClassPathElement> boolean - Whether the build will fail if the class path contains an unsupported element (such as .war or .ear files). When set to false a warning is logged instead.
Default value is: true.
<followSymlinks> boolean - Whether the scan will follow symlinks, which can lead to an exception when symlinks create a cycle, e.g., by pointing to one of their parent directories.
Default value is: false.
<includeDependencies> boolean - Whether the dependencies of this project should be included in the scan. Otherwise only the direct output is scanned.
Default value is: false.
<includes> String[] - Resource name prefixes to include in the scan. To include package com.foo.bar you specify com/foo/bar here. The separator is always a forward slash and does not depend on the file system implementation.

The default value corresponds to the default migration directory/package: "db/migration"
<outputDirectory> File - The directory where scan results are placed. The default value corresponds to the default "migratedb.location" configuration ("db/migration").
Default value is: ${project.build.outputDirectory}/db/migration.

Parameter Details

<failBuildOnUnprocessableClassPathElement>

Whether the build will fail if the class path contains an unsupported element (such as .war or .ear files). When set to false a warning is logged instead.
  • Type: boolean
  • Required: No
  • Default: true

<followSymlinks>

Whether the scan will follow symlinks, which can lead to an exception when symlinks create a cycle, e.g., by pointing to one of their parent directories.
  • Type: boolean
  • Required: No
  • Default: false

<includeDependencies>

Whether the dependencies of this project should be included in the scan. Otherwise only the direct output is scanned.
  • Type: boolean
  • Required: No
  • Default: false

<includes>

Resource name prefixes to include in the scan. To include package com.foo.bar you specify com/foo/bar here. The separator is always a forward slash and does not depend on the file system implementation.

The default value corresponds to the default migration directory/package: "db/migration"

  • Type: java.lang.String[]
  • Required: No

<outputDirectory>

The directory where scan results are placed. The default value corresponds to the default "migratedb.location" configuration ("db/migration").
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.outputDirectory}/db/migration