Package ac.simons.neo4j.migrations.core

Class MigrationsConfig

java.lang.Object
ac.simons.neo4j.migrations.core.MigrationsConfig
public final class MigrationsConfig extends Object
Configuration for Migrations.
Since:
0.0.1
Author:
Michael J. Simons

  • Method Details

    • builder

      public static MigrationsConfig.Builder builder()
      Start building a new configuration.
      Returns:
      The entry point for creating a new configuration.
      Since:
      0.0.1

    • defaultConfig

      public static MigrationsConfig defaultConfig()
      Returns:
      The default config
      Since:
      0.0.6

    • getPackagesToScan

      public String[] getPackagesToScan()

    • getLocationsToScan

      public String[] getLocationsToScan()

    • getTransactionMode

      public MigrationsConfig.TransactionMode getTransactionMode()

    • getDatabase

      @Deprecated public String getDatabase()
      Deprecated.
      since 1.1.0, please use getOptionalDatabase()
      Returns:
      An optional target database, maybe null

    • getOptionalDatabase

      public Optional<String> getOptionalDatabase()
      Returns:
      An optional target database
      Since:
      1.1.0

    • getOptionalSchemaDatabase

      public Optional<String> getOptionalSchemaDatabase()
      Returns:
      An optional schema database
      Since:
      1.1.0

    • getImpersonatedUser

      @Deprecated public String getImpersonatedUser()
      Deprecated.
      since 1.1.0, please use getOptionalImpersonatedUser()
      Returns:
      An optional user to impersonate, maybe null

    • getOptionalImpersonatedUser

      public Optional<String> getOptionalImpersonatedUser()
      Returns:
      An optional user to impersonate
      Since:
      1.1.0

    • getInstalledBy

      @Deprecated public String getInstalledBy()
      Deprecated.
      since 1.1.0, please use getOptionalInstalledBy()
      Returns:
      Optional user information about the user executing the migration, maybe null

    • getOptionalInstalledBy

      public Optional<String> getOptionalInstalledBy()
      Returns:
      Optional user information about the user executing the migration
      Since:
      1.1.0

    • isValidateOnMigrate

      public boolean isValidateOnMigrate()

    • isAutocrlf

      public boolean isAutocrlf()

    • logTo

      public void logTo(Logger logger, boolean verbose)

    • hasPlacesToLookForMigrations

      @Deprecated public boolean hasPlacesToLookForMigrations()
      Deprecated.
      Since 1.1.0, will be removed from public without replace.
      This is internal API and will be made package private in 2.0.0
      Returns:
      True if there are packages to scan