com.imageworks.migration

JavaMigrator

class JavaMigrator extends AnyRef

The Scala Migrator class uses Scala case classes in its public constructors and public methods which makes it difficult to use from a pure Java environment. This class exposes a Java-style interface and delegates to the Scala Migrator class.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JavaMigrator
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JavaMigrator(jdbcUrl: String, jdbcUsername: String, jdbcPassword: String, adapter: DatabaseAdapter)

    JavaMigrator constructor.

    JavaMigrator constructor.

    jdbcUrl

    the JDBC URL to connect to the database

    jdbcUsername

    the username to log into the database

    jdbcPassword

    the password associated with the database username

    adapter

    a concrete DatabaseAdapter that the migrator uses to handle database specific features

  2. new JavaMigrator(jdbcUrl: String, adapter: DatabaseAdapter)

    JavaMigrator constructor.

    JavaMigrator constructor.

    jdbcUrl

    the JDBC URL to connect to the database

    adapter

    a concrete DatabaseAdapter that the migrator uses to handle database specific features

  3. new JavaMigrator(connectionBuilder: ConnectionBuilder, adapter: DatabaseAdapter)

    JavaMigrator constructor.

    JavaMigrator constructor.

    connectionBuilder

    a builder of connections to the database

    adapter

    a concrete DatabaseAdapter that the migrator uses to handle database specific features

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  12. def getTableNames: Set[String]

    Get a list of table names.

    Get a list of table names. If the database adapter was given a schema name then only the tables in that schema are returned.

    returns

    a set of table names; no modifications of the case of table names is done

  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  14. def installAllMigrations(packageName: String, searchSubPackages: Boolean): Unit

    Install all available migrations into the database.

    Install all available migrations into the database.

    packageName

    the package name that the Migration subclasses should be searched for

    searchSubPackages

    true if sub-packages of packageName should be searched

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. def migrateTo(version: Long, packageName: String, searchSubPackages: Boolean): Unit

    Migrate the database to the given version.

    Migrate the database to the given version.

    version

    the version number the database should be migrated to

    packageName

    the package name that the Migration subclasses should be searched for

    searchSubPackages

    true if sub-packages of packageName should be searched

  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. def removeAllMigrations(packageName: String, searchSubPackages: Boolean): Unit

    Remove all installed migrations from the database.

    Remove all installed migrations from the database.

    packageName

    the package name that the Migration subclasses should be searched for

    searchSubPackages

    true if sub-packages of packageName should be searched

  21. def rollback(count: Int, packageName: String, searchSubPackages: Boolean): Unit

    Rollback a given number of migrations in the database.

    Rollback a given number of migrations in the database.

    count

    the number of migrations to rollback to

    packageName

    the package name that the Migration subclasses should be searched for

    searchSubPackages

    true if sub-packages of packageName should be searched

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  23. def toString(): String

    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  25. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  27. def whyNotMigrated(packageName: String, searchSubPackages: Boolean): String

    Determine if the database has all available migrations installed in it and no migrations installed that do not have a corresponding concrete Migration subclass; that is, the database must have only those migrations installed that are found by searching the package name for concrete Migration subclasses.

    Determine if the database has all available migrations installed in it and no migrations installed that do not have a corresponding concrete Migration subclass; that is, the database must have only those migrations installed that are found by searching the package name for concrete Migration subclasses.

    Running this method does not modify the database in any way. The schema migrations table is not created.

    packageName

    the Java package name to search for Migration subclasses

    searchSubPackages

    true if sub-packages of packageName should be searched

    returns

    null if all available migrations are installed and all installed migrations have a corresponding Migration subclass; a non-null message suitable for logging with the not-installed migrations and the installed migrations that do not have a matching Migration subclass

Inherited from AnyRef

Inherited from Any

Ungrouped