neo4j-migrations:clean

Full name:

eu.michael-simons.neo4j:neo4j-migrations-maven-plugin:1.16.2:clean

Description:

Goal that cleans the configured database. Can be configured with all set to true for removing everything Neo4j-Migrations created in a schema database. Binds to the clean phase by default

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: 1.1.0.
  • Binds by default to the lifecycle phase: clean.

Required Parameters

Name Type Since Description
<address> URI - 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 - The password of the user connecting to the database.
<user> String - The login of the user connecting to the database.
Default value is: neo4j.

Optional Parameters

Name Type Since Description
<all> boolean - Set to true to delete all migration chains as well as all Neo4j-Migration constraints and not only the chain for the target database.
Default value is: false.
<database> String - The database that should be migrated (Neo4j EE 4.0+).
<impersonatedUser> String - 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[] - Location to scan. Repeat for multiple locations.
Default value is: file://${project.build.outputDirectory}/neo4j/migrations.
<packagesToScan> String[] - Package to scan. Repeat for multiple packages.
<schemaDatabase> String - The database that should be used for storing informations about migrations (Neo4j EE 4.0+).
<transactionMode> MigrationsConfig$TransactionMode - The transaction mode to use.
Default value is: PER_MIGRATION.
<verbose> boolean - 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
  • Required: Yes
  • Default: bolt://localhost:7687

<all>

Set to true to delete all migration chains as well as all Neo4j-Migration constraints and not only the chain for the target database.
  • Type: boolean
  • Required: No
  • Default: false

<database>

The database that should be migrated (Neo4j EE 4.0+).
  • Type: java.lang.String
  • 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
  • Required: No

<locationsToScan>

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

<packagesToScan>

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

<password>

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

<schemaDatabase>

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

<transactionMode>

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

<user>

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

<verbose>

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