Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- asString() - Method in class io.ebean.migration.MigrationVersion
-
Return the trimmed version excluding version comment and un-parsable string.
- AutoRunner - Class in io.ebean.migration
-
Automatic running of DB Migrations.
- AutoRunner() - Constructor for class io.ebean.migration.AutoRunner
B
- basePlatform() - Method in interface io.ebean.migration.MigrationContext
-
The base platform of the current migration run.
- BOOTINIT_TYPE - Static variable in class io.ebean.migration.MigrationVersion
C
- checkState() - Method in class io.ebean.migration.MigrationRunner
-
Return the migrations that would be applied if the migration is run.
- checkState(MigrationContext) - Method in class io.ebean.migration.MigrationRunner
-
Return the migrations that would be applied if the migration is run.
- checkState(Connection) - Method in class io.ebean.migration.MigrationRunner
-
Return the migrations that would be applied if the migration is run.
- checkState(DataSource) - Method in class io.ebean.migration.MigrationRunner
-
Return the migrations that would be applied if the migration is run.
- comment() - Method in interface io.ebean.migration.MigrationResource
-
Return the migration comment.
- comment() - Method in class io.ebean.migration.MigrationVersion
-
Return the version comment.
- compareTo(MigrationResource) - Method in interface io.ebean.migration.MigrationResource
-
Default ordering by version.
- compareTo(MigrationVersion) - Method in class io.ebean.migration.MigrationVersion
- ConfigurationAware - Interface in io.ebean.migration
-
Marks a class as configuration aware (JdbcMigrations) Configuration aware classes get the migration configuration injected upon creation.
- connection() - Method in interface io.ebean.migration.MigrationContext
-
The current connection.
- content() - Method in interface io.ebean.migration.MigrationResource
-
Return the content of the migration.
- createConnection() - Method in class io.ebean.migration.MigrationConfig
-
Create a Connection to the database using the configured driver, url, username etc.
- createInstance(String) - Method in interface io.ebean.migration.JdbcMigrationFactory
-
Create a JDBC based migration given the class name.
- createInstance(String) - Method in class io.ebean.migration.MigrationConfig.DefaultMigrationFactory
D
- DefaultMigrationFactory() - Constructor for class io.ebean.migration.MigrationConfig.DefaultMigrationFactory
G
- getBasePlatform() - Method in class io.ebean.migration.MigrationConfig
-
Return the base platform that was set.
- getChecksum() - Method in interface io.ebean.migration.JdbcMigration
- getChecksum() - Method in interface io.ebean.migration.MigrationChecksumProvider
-
Return the checksum for the given migration.
- getClassLoader() - Method in class io.ebean.migration.MigrationConfig
-
Return the ClassLoader to use to load resources.
- getComment() - Method in interface io.ebean.migration.MigrationResource
-
Deprecated.
- getComment() - Method in class io.ebean.migration.MigrationVersion
-
Deprecated.
- getContent() - Method in interface io.ebean.migration.MigrationResource
-
Deprecated.
- getDbPassword() - Method in class io.ebean.migration.MigrationConfig
-
Return the DB password.
- getDbSchema() - Method in class io.ebean.migration.MigrationConfig
-
Return the DB connection Schema.
- getDbUrl() - Method in class io.ebean.migration.MigrationConfig
-
Return the DB connection URL.
- getDbUsername() - Method in class io.ebean.migration.MigrationConfig
-
Return the DB username.
- getFull() - Method in class io.ebean.migration.MigrationVersion
-
Deprecated.
- getJdbcMigrationFactory() - Method in class io.ebean.migration.MigrationConfig
-
Return the jdbcMigrationFactory.
- getLocation() - Method in interface io.ebean.migration.MigrationResource
-
Deprecated.
- getMetaTable() - Method in class io.ebean.migration.MigrationConfig
-
Return the name of the migration table.
- getMigrationInitPath() - Method in class io.ebean.migration.MigrationConfig
-
Return the path for containing init migration scripts.
- getMigrationPath() - Method in class io.ebean.migration.MigrationConfig
-
Return the root path used to find migrations.
- getMinVersion() - Method in class io.ebean.migration.MigrationConfig
-
Return the minVersion.
- getMinVersionFailMessage() - Method in class io.ebean.migration.MigrationConfig
-
Return the optional minVersionFailMessage.
- getPatchInsertOn() - Method in class io.ebean.migration.MigrationConfig
-
Return the migrations that should not be run but inserted into history as if they have run.
- getPatchResetChecksumOn() - Method in class io.ebean.migration.MigrationConfig
-
Return the migrations that should have their checksum reset.
- getPlatform() - Method in class io.ebean.migration.MigrationConfig
-
Return the platform that was set.
- getPlatformName() - Method in class io.ebean.migration.MigrationConfig
-
Deprecated.
- getRaw() - Method in class io.ebean.migration.MigrationVersion
-
Deprecated.
- getRunPlaceholderMap() - Method in class io.ebean.migration.MigrationConfig
-
Return a map of name/value pairs that can be expressions replaced in migration scripts.
- getRunPlaceholders() - Method in class io.ebean.migration.MigrationConfig
-
Return a Comma and equals delimited key/value placeholders to replace in DDL scripts.
- getType() - Method in interface io.ebean.migration.MigrationResource
-
Deprecated.
- getType() - Method in class io.ebean.migration.MigrationVersion
-
Deprecated.
- getVersion() - Method in interface io.ebean.migration.MigrationResource
-
Deprecated.
I
- io.ebean.migration - module io.ebean.migration
- io.ebean.migration - package io.ebean.migration
- isAllowErrorInRepeatable() - Method in class io.ebean.migration.MigrationConfig
-
Return true if we continue running the migration when a repeatable migration fails.
- isCreateSchemaIfNotExists() - Method in class io.ebean.migration.MigrationConfig
-
Return true if migration should create the schema if it does not exist.
- isEarlyChecksumMode() - Method in class io.ebean.migration.MigrationConfig
-
Return true if using the earlyChecksumMode which means checksums are computed before any expressions in the scripts are translated.
- isFastMode() - Method in class io.ebean.migration.MigrationConfig
-
Return true if fastMode is turned on.
- isRepeatable() - Method in class io.ebean.migration.MigrationVersion
-
Return true if this is a "repeatable" version.
- isRepeatableInit() - Method in class io.ebean.migration.MigrationVersion
-
Return true if this is a "repeatable init" verision.
- isRepeatableLast() - Method in class io.ebean.migration.MigrationVersion
-
Return true if this is a "repeatable last" verision.
- isSetCurrentSchema() - Method in class io.ebean.migration.MigrationConfig
-
Return true if the dbSchema should be set as current schema.
- isSkipChecksum() - Method in class io.ebean.migration.MigrationConfig
-
Return true if checksum check should be skipped (during development).
- isSkipMigrationRun() - Method in class io.ebean.migration.MigrationConfig
-
Return true if the migration should NOT execute the migrations but update the migration table.
J
- JdbcMigration - Interface in io.ebean.migration
-
Interface to be implemented by Jdbc Java Migrations.
- JdbcMigrationFactory - Interface in io.ebean.migration
-
Factory to create and initialise a JdbcMigration.
K
- key() - Method in interface io.ebean.migration.MigrationResource
-
Return the "key" that identifies the migration.
L
- load(Properties) - Method in class io.ebean.migration.MigrationConfig
-
Load configuration from standard properties.
- loadProperties(Properties) - Method in class io.ebean.migration.AutoRunner
- location() - Method in interface io.ebean.migration.MigrationResource
-
Return the resource location.
M
- migrate(Connection) - Method in interface io.ebean.migration.JdbcMigration
-
Execute the migration using the connection.
- MigrationChecksumProvider - Interface in io.ebean.migration
-
Migration implementors that also implement this interface will be able to specify their checksum (for validation), instead of having it automatically computed or default to null (for Java Migrations).
- migrationConfig - Variable in class io.ebean.migration.MigrationRunner
- MigrationConfig - Class in io.ebean.migration
-
Configuration used to run the migration.
- MigrationConfig() - Constructor for class io.ebean.migration.MigrationConfig
- MigrationConfig.DefaultMigrationFactory - Class in io.ebean.migration
-
Default factory.
- MigrationContext - Interface in io.ebean.migration
-
The current context while a migration runs.
- MigrationException - Exception Class in io.ebean.migration
- MigrationException(String) - Constructor for exception class io.ebean.migration.MigrationException
- MigrationException(String, Throwable) - Constructor for exception class io.ebean.migration.MigrationException
- migrationPath() - Method in interface io.ebean.migration.MigrationContext
-
The migration path of SQL migrations.
- MigrationResource - Interface in io.ebean.migration
-
A DB migration resource - typically a resource containing SQL.
- MigrationRunner - Class in io.ebean.migration
-
Runs the DB migration typically on application start.
- MigrationRunner(MigrationConfig) - Constructor for class io.ebean.migration.MigrationRunner
- MigrationVersion - Class in io.ebean.migration
-
The version of a migration used so that migrations are processed in order.
N
- nextVersion() - Method in class io.ebean.migration.MigrationVersion
-
Return the next version based on this version.
- normalised() - Method in class io.ebean.migration.MigrationVersion
-
Return the trimmed version with any underscores replaced with '.'
P
- parse(String) - Static method in class io.ebean.migration.MigrationVersion
-
Parse the raw version string into a MigrationVersion.
- platform() - Method in interface io.ebean.migration.MigrationContext
-
The platform of the current migration run.
R
- raw() - Method in class io.ebean.migration.MigrationVersion
-
Return the version in raw form.
- run() - Method in class io.ebean.migration.MigrationRunner
-
Run by creating a DB connection from driver, url, username defined in MigrationConfig.
- run(MigrationContext) - Method in class io.ebean.migration.MigrationRunner
-
Run the migrations if there are any that need running.
- run(Connection) - Method in class io.ebean.migration.MigrationRunner
-
Run the migrations if there are any that need running.
- run(DataSource) - Method in class io.ebean.migration.AutoRunner
- run(DataSource) - Method in class io.ebean.migration.MigrationRunner
-
Run using the connection from the DataSource.
S
- setAllowErrorInRepeatable(boolean) - Method in class io.ebean.migration.MigrationConfig
-
Set to true to continue running the migration when a repeatable migration fails.
- setBasePlatform(String) - Method in class io.ebean.migration.AutoRunner
- setBasePlatform(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the base platform.
- setClassLoader(ClassLoader) - Method in class io.ebean.migration.MigrationConfig
-
Set the ClassLoader to use when loading resources.
- setCreateSchemaIfNotExists(boolean) - Method in class io.ebean.migration.MigrationConfig
-
Set to create Schema if it does not exist.
- setDbDriver(String) - Method in class io.ebean.migration.MigrationConfig
-
Deprecated.
- setDbPassword(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the DB password.
- setDbSchema(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the DB connection Schema.
- setDbUrl(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the DB connection URL.
- setDbUsername(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the DB username.
- setDefaultDbSchema(String) - Method in class io.ebean.migration.AutoRunner
- setEarlyChecksumMode(boolean) - Method in class io.ebean.migration.MigrationConfig
-
Set to true to turn on earlyChecksumMode.
- setFastMode(boolean) - Method in class io.ebean.migration.MigrationConfig
-
Set true to enable fastMode.
- setJdbcMigrationFactory(JdbcMigrationFactory) - Method in class io.ebean.migration.MigrationConfig
-
Set the jdbcMigrationFactory.
- setMetaTable(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the name of the migration table.
- setMigrationConfig(MigrationConfig) - Method in interface io.ebean.migration.ConfigurationAware
-
Set the configuration being used.
- setMigrationInitPath(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the path containing init migration scripts.
- setMigrationPath(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the root path used to find migrations.
- setMinVersion(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the minVersion.
- setMinVersionFailMessage(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the minVersionFailMessage
- setName(String) - Method in class io.ebean.migration.AutoRunner
- setName(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the name of the database to run the migration for.
- setPatchInsertOn(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the migrations that should not be run but inserted into history as if they have run.
- setPatchInsertOn(Set<String>) - Method in class io.ebean.migration.MigrationConfig
-
Set the migrations that should not be run but inserted into history as if they have run.
- setPatchResetChecksumOn(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the migrations that should have their checksum reset as a comma delimited list.
- setPatchResetChecksumOn(Set<String>) - Method in class io.ebean.migration.MigrationConfig
-
Set the migrations that should have their checksum reset.
- setPlatform(String) - Method in class io.ebean.migration.AutoRunner
- setPlatform(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the platform that is running the migration.
- setPlatformName(String) - Method in class io.ebean.migration.MigrationConfig
-
Deprecated.
- setRunPlaceholderMap(Map<String, String>) - Method in class io.ebean.migration.MigrationConfig
-
Set a map of name/value pairs that can be expressions replaced in migration scripts.
- setRunPlaceholders(String) - Method in class io.ebean.migration.MigrationConfig
-
Set a Comma and equals delimited key/value placeholders to replace in DDL scripts.
- setSetCurrentSchema(boolean) - Method in class io.ebean.migration.MigrationConfig
-
Set if the dbSchema should be set as current schema.
- setSkipChecksum(boolean) - Method in class io.ebean.migration.MigrationConfig
-
Set to true to skip the checksum check.
- setSkipMigrationRun(boolean) - Method in class io.ebean.migration.MigrationConfig
-
Set to true if the migration should NOT execute the migrations but update the migration table only.
T
- toString() - Method in class io.ebean.migration.MigrationVersion
- trim(String) - Static method in class io.ebean.migration.MigrationVersion
-
Parse the raw version string and just return the leading version number;
- type() - Method in interface io.ebean.migration.MigrationResource
-
Return the type code ("R" or "V") for this migration.
- type() - Method in class io.ebean.migration.MigrationVersion
-
Return the version type (I, R or V).
V
- version() - Method in interface io.ebean.migration.MigrationResource
-
Return the underlying migration version.
- VERSION_TYPE - Static variable in class io.ebean.migration.MigrationVersion
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form