Index (ebean-migration 13.6.0 API)

A B C D G H I J K L M N O P R S T U V
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

BOOTINIT_TYPE - Static variable in class io.ebean.migration.MigrationVersion

C

checkMigrations - Variable in class io.ebean.migration.MigrationRunner
checkState() - 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.
COCKROACH - Static variable in interface io.ebean.migration.DbPlatformNames
compareTo(MigrationVersion) - Method in class io.ebean.migration.MigrationVersion
compareTo(LocalMigrationResource) - Method in class io.ebean.migration.runner.LocalMigrationResource: Default ordering by version.
ConfigurationAware - Interface in io.ebean.migration: Marks a class as configuration aware (JdbcMigrations) Configuration aware classes get the migration configuration injected upon creation.
createAndSetIfNeeded() - Method in class io.ebean.migration.runner.MigrationSchema: Create and set the DB schema if desired.
createConnection() - Method in class io.ebean.migration.MigrationConfig: Create a Connection to the database using the configured driver, url, username etc.
createIfNeededAndLock() - Method in class io.ebean.migration.runner.MigrationTable: Create the table is it does not exist.
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

DB2 - Static variable in interface io.ebean.migration.DbPlatformNames
DbPlatformNames - Interface in io.ebean.migration: Known database platform names.
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.MigrationChecksumProvider: Return the checksum for the given migration.
getChecksum() - Method in class io.ebean.migration.runner.LocalJdbcMigrationResource: Returns the checksum of the migration routine.
getClassLoader() - Method in class io.ebean.migration.MigrationConfig: Return the ClassLoader to use to load resources.
getComment() - Method in class io.ebean.migration.MigrationVersion: Return the version comment.
getComment() - Method in class io.ebean.migration.runner.LocalMigrationResource: Return the migration comment.
getContent() - Method in class io.ebean.migration.runner.LocalDdlMigrationResource: Return the content for the migration apply ddl script.
getContent() - Method in class io.ebean.migration.runner.LocalJdbcMigrationResource
getContent() - Method in class io.ebean.migration.runner.LocalMigrationResource: Return the content of the migration.
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: Return the full version.
getJdbcMigrationFactory() - Method in class io.ebean.migration.MigrationConfig: Return the jdbcMigrationFactory.
getLocation() - Method in class io.ebean.migration.runner.LocalMigrationResource: Return the resource location.
getMetaTable() - Method in class io.ebean.migration.MigrationConfig: Return the name of the migration table.
getMigration() - Method in class io.ebean.migration.runner.LocalJdbcMigrationResource: Return the migration
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: Return the version in raw form.
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 class io.ebean.migration.MigrationVersion: Return the version type (I, R or V).
getType() - Method in class io.ebean.migration.runner.LocalMigrationResource: Return the type code ("R" or "V") for this migration.
getVersion() - Method in class io.ebean.migration.runner.LocalMigrationResource: Return the underlying migration version.
getVersions() - Method in class io.ebean.migration.runner.LocalMigrationResources: Return the list of migration resources in version order.
getVersions() - Method in class io.ebean.migration.runner.MigrationTable: Returns the versions that are already applied.

H

H2 - Static variable in interface io.ebean.migration.DbPlatformNames
HSQL - Static variable in interface io.ebean.migration.DbPlatformNames

I

io.ebean.migration - module io.ebean.migration
io.ebean.migration - package io.ebean.migration
io.ebean.migration.runner - package io.ebean.migration.runner
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.
isEmpty() - Method in class io.ebean.migration.runner.MigrationTable: Return true if there are no migrations.
isRepeatable() - Method in class io.ebean.migration.MigrationVersion: Return true if this is a "repeatable" version.
isRepeatable() - Method in class io.ebean.migration.runner.LocalMigrationResource: Return true if the underlying version is "repeatable".
isRepeatableInit() - Method in class io.ebean.migration.MigrationVersion: Return true if this is a "repeatable init" verision.
isRepeatableInit() - Method in class io.ebean.migration.runner.LocalMigrationResource: Return true if the underlying version is "repeatable init".
isRepeatableLast() - Method in class io.ebean.migration.MigrationVersion: Return true if this is a "repeatable last" verision.
isRepeatableLast() - Method in class io.ebean.migration.runner.LocalMigrationResource: Return true if the underlying version is "repeatable last".
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 class io.ebean.migration.runner.LocalMigrationResource: Return the "key" that identifies the migration.

L

lines() - Method in class io.ebean.migration.runner.LocalDdlMigrationResource
load(Properties) - Method in class io.ebean.migration.MigrationConfig: Load configuration from standard properties.
loadProperties(Properties) - Method in class io.ebean.migration.AutoRunner
LocalDdlMigrationResource - Class in io.ebean.migration.runner: A DB migration resource (DDL script with version).
LocalDdlMigrationResource(MigrationVersion, String, Resource) - Constructor for class io.ebean.migration.runner.LocalDdlMigrationResource: Construct with version and resource.
LocalJdbcMigrationResource - Class in io.ebean.migration.runner: A DB migration resource (JdbcMigration with version).
LocalJdbcMigrationResource(MigrationVersion, String, JdbcMigration) - Constructor for class io.ebean.migration.runner.LocalJdbcMigrationResource: Construct with version and resource.
LocalMigrationResource - Class in io.ebean.migration.runner: A DB migration resource (DDL or Jdbc)
LocalMigrationResource(MigrationVersion, String) - Constructor for class io.ebean.migration.runner.LocalMigrationResource: Construct with version and resource.
LocalMigrationResources - Class in io.ebean.migration.runner: Loads the DB migration resources and sorts them into execution order.
LocalMigrationResources(MigrationConfig) - Constructor for class io.ebean.migration.runner.LocalMigrationResources: Construct with configuration options.
location - Variable in class io.ebean.migration.runner.LocalMigrationResource
LogicalLock() - Constructor for class io.ebean.migration.runner.MigrationPlatform.LogicalLock

M

MARIADB - Static variable in interface io.ebean.migration.DbPlatformNames
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.
MigrationException - Exception in io.ebean.migration
MigrationException(String) - Constructor for exception io.ebean.migration.MigrationException
MigrationException(String, Throwable) - Constructor for exception io.ebean.migration.MigrationException
MigrationPlatform - Class in io.ebean.migration.runner: Handle database platform specific locking on db migration table.
MigrationPlatform() - Constructor for class io.ebean.migration.runner.MigrationPlatform
MigrationPlatform.LogicalLock - Class in io.ebean.migration.runner
MigrationPlatform.MySql - Class in io.ebean.migration.runner: MySql and MariaDB need to use named locks due to implicit commits with DDL.
MigrationPlatform.NoLocking - Class in io.ebean.migration.runner
MigrationPlatform.Postgres - Class in io.ebean.migration.runner
MigrationPlatform.SqlServer - Class in io.ebean.migration.runner
MigrationRunner - Class in io.ebean.migration: Runs the DB migration typically on application start.
MigrationRunner(MigrationConfig) - Constructor for class io.ebean.migration.MigrationRunner
MigrationSchema - Class in io.ebean.migration.runner: Create Schema if needed and set current Schema in Migration
MigrationSchema(MigrationConfig, Connection) - Constructor for class io.ebean.migration.runner.MigrationSchema: Construct with configuration and connection.
MigrationTable - Class in io.ebean.migration.runner: Manages the migration table.
MigrationTable(MigrationConfig, Connection, boolean, MigrationPlatform) - Constructor for class io.ebean.migration.runner.MigrationTable: Construct with server, configuration and jdbc connection (DB admin user).
MigrationVersion - Class in io.ebean.migration: The version of a migration used so that migrations are processed in order.
MySql() - Constructor for class io.ebean.migration.runner.MigrationPlatform.MySql
MYSQL - Static variable in interface io.ebean.migration.DbPlatformNames

N

nextVersion() - Method in class io.ebean.migration.MigrationVersion: Return the next version based on this version.
NoLocking() - Constructor for class io.ebean.migration.runner.MigrationPlatform.NoLocking
normalised() - Method in class io.ebean.migration.MigrationVersion: Return the trimmed version with any underscores replaced with '.'

O

ORACLE - Static variable in interface io.ebean.migration.DbPlatformNames

P

parse(String) - Static method in class io.ebean.migration.MigrationVersion: Parse the raw version string into a MigrationVersion.
Postgres() - Constructor for class io.ebean.migration.runner.MigrationPlatform.Postgres
POSTGRES - Static variable in interface io.ebean.migration.DbPlatformNames

R

readInitResources() - Method in class io.ebean.migration.runner.LocalMigrationResources: Read the init migration resources (usually only 1) returning true if there are versions.
readResources() - Method in class io.ebean.migration.runner.LocalMigrationResources: Read all the migration resources (SQL scripts) returning true if there are versions.
run() - Method in class io.ebean.migration.MigrationRunner: Run by creating a DB connection from driver, url, username defined in MigrationConfig.
run(Connection) - Method in class io.ebean.migration.MigrationRunner: Run the migrations if there are any that need running.
run(Connection, boolean) - 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.
runAll(List<LocalMigrationResource>) - Method in class io.ebean.migration.runner.MigrationTable: Run all the migrations in order as needed.
runInit(LocalMigrationResource, List<LocalMigrationResource>) - Method in class io.ebean.migration.runner.MigrationTable: Run using an init migration.
runNonTransactional() - Method in class io.ebean.migration.runner.MigrationTable: Run non transactional statements (if any) after migration commit.

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
setInitType() - Method in class io.ebean.migration.runner.LocalMigrationResource: Set the migration to be an Init migration.
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.
size() - Method in class io.ebean.migration.runner.MigrationTable: Return the number of migrations in the DB migration table.
SQLANYWHERE - Static variable in interface io.ebean.migration.DbPlatformNames
SQLITE - Static variable in interface io.ebean.migration.DbPlatformNames
SqlServer() - Constructor for class io.ebean.migration.runner.MigrationPlatform.SqlServer
SQLSERVER - Static variable in interface io.ebean.migration.DbPlatformNames

T

toString() - Method in class io.ebean.migration.MigrationVersion
toString() - Method in class io.ebean.migration.runner.LocalMigrationResource
trim(String) - Static method in class io.ebean.migration.MigrationVersion: Parse the raw version string and just return the leading version number;

U

unlockMigrationTable() - Method in class io.ebean.migration.runner.MigrationTable: Release a lock on the migration table (MySql, MariaDB only).

V

version - Variable in class io.ebean.migration.runner.LocalMigrationResource
VERSION_TYPE - Static variable in class io.ebean.migration.MigrationVersion

A B C D G H I J K L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form