neo4j-migrations:migrate

Full name:

eu.michael-simons.neo4j:neo4j-migrations-maven-plugin:1.4.0:migrate

Description:

Goal that applies the configured migrations.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 0.0.11.
  • Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name Type Since Description
<address> URI 0.0.11 The address this migration should connect to. The driver supports bolt, bolt+routing or neo4j as schemes.
Default value is: bolt://localhost:7687.
<password> String 0.0.11 The password of the user connecting to the database.
<user> String 0.0.11 The login of the user connecting to the database.
Default value is: neo4j.

Optional Parameters

Name Type Since Description
<database> String 0.0.11 The database that should be migrated (Neo4j EE 4.0+).
<impersonatedUser> String 0.0.11 An alternative user to impersonate during migration. Might have higher privileges than the user connected, which will be dropped again after migration. Requires Neo4j EE 4.4+. Leave null for using the connected user.
<locationsToScan> String[] 0.0.11 Location to scan. Repeat for multiple locations.
Default value is: file://${project.build.outputDirectory}/neo4j/migrations.
<packagesToScan> String[] 0.0.11 Package to scan. Repeat for multiple packages.
<schemaDatabase> String 0.0.11 The database that should be used for storing informations about migrations (Neo4j EE 4.0+).
<transactionMode> MigrationsConfig$TransactionMode 0.0.11 The transaction mode to use.
Default value is: PER_MIGRATION.
<verbose> boolean 0.0.11 Log the configuration and a couple of other things.
Default value is: false.

Parameter Details

<address>

The address this migration should connect to. The driver supports bolt, bolt+routing or neo4j as schemes.
  • Type: java.net.URI
  • Since: 0.0.11
  • Required: Yes
  • Default: bolt://localhost:7687

<database>

The database that should be migrated (Neo4j EE 4.0+).
  • Type: java.lang.String
  • Since: 0.0.11
  • Required: No

<impersonatedUser>

An alternative user to impersonate during migration. Might have higher privileges than the user connected, which will be dropped again after migration. Requires Neo4j EE 4.4+. Leave null for using the connected user.
  • Type: java.lang.String
  • Since: 0.0.11
  • Required: No

<locationsToScan>

Location to scan. Repeat for multiple locations.
  • Type: java.lang.String[]
  • Since: 0.0.11
  • Required: No
  • Default: file://${project.build.outputDirectory}/neo4j/migrations

<packagesToScan>

Package to scan. Repeat for multiple packages.
  • Type: java.lang.String[]
  • Since: 0.0.11
  • Required: No

<password>

The password of the user connecting to the database.
  • Type: java.lang.String
  • Since: 0.0.11
  • Required: Yes

<schemaDatabase>

The database that should be used for storing informations about migrations (Neo4j EE 4.0+).
  • Type: java.lang.String
  • Since: 0.0.11
  • Required: No

<transactionMode>

The transaction mode to use.
  • Type: ac.simons.neo4j.migrations.core.MigrationsConfig$TransactionMode
  • Since: 0.0.11
  • Required: No
  • Default: PER_MIGRATION

<user>

The login of the user connecting to the database.
  • Type: java.lang.String
  • Since: 0.0.11
  • Required: Yes
  • Default: neo4j

<verbose>

Log the configuration and a couple of other things.
  • Type: boolean
  • Since: 0.0.11
  • Required: No
  • Default: false