A B C D F G H I J K L M N O P R S T V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- asString() - Method in class io.ebean.migration.MigrationVersion
-
Return the trimmed version excluding version comment and un-parsable string.
B
- BOOTINIT_TYPE - Static variable in class io.ebean.migration.MigrationVersion
- build(String, Map<String, String>) - Static method in class io.ebean.migration.runner.ScriptTransform
-
Build and return a ScriptTransform that replaces placeholder values in DDL scripts.
C
- 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.
- close(Connection) - Static method in class io.ebean.migration.util.JdbcClose
-
Close the connection logging if an error occurs.
- COCKROACH - Static variable in interface io.ebean.migration.DbPlatformNames
- COCKROACH - Static variable in interface io.ebean.migration.ddl.DdlAutoCommit
- 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.
- DdlAutoCommit - Interface in io.ebean.migration.ddl
-
Detect non transactional SQL statements that must run after normal sql statements with connection set to auto commit true.
- DdlParser - Class in io.ebean.migration.ddl
-
Parses string content into separate SQL/DDL statements.
- DdlParser(DdlAutoCommit) - Constructor for class io.ebean.migration.ddl.DdlParser
- DdlRunner - Class in io.ebean.migration.ddl
-
Runs DDL scripts.
- DdlRunner(boolean, String) - Constructor for class io.ebean.migration.ddl.DdlRunner
-
Construct with a script name (for logging) and flag indicating if auto commit is used (in which case errors are allowed).
- DdlRunner(boolean, String, DdlAutoCommit) - Constructor for class io.ebean.migration.ddl.DdlRunner
-
Create specifying the auto commit behaviour (for the database platform).
- DdlRunner(boolean, String, String) - Constructor for class io.ebean.migration.ddl.DdlRunner
-
Create specifying the database platform by name.
- DdlRunnerException - Exception in io.ebean.migration.ddl
- DdlRunnerException(Throwable) - Constructor for exception io.ebean.migration.ddl.DdlRunnerException
- DefaultMigrationFactory() - Constructor for class io.ebean.migration.MigrationConfig.DefaultMigrationFactory
F
- forPlatform(String) - Static method in interface io.ebean.migration.ddl.DdlAutoCommit
-
Return the implementation for the given platform.
G
- getApplySuffix() - Method in class io.ebean.migration.MigrationConfig
-
Return the suffix for migration resources (defaults to .sql).
- 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.
- getDbDriver() - Method in class io.ebean.migration.MigrationConfig
-
Return the DB Driver.
- 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
-
Returns 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
-
Returns the minVersion.
- getMinVersionFailMessage() - Method in class io.ebean.migration.MigrationConfig
-
Sets the optional minVersionFailMessage.
- getNonTransactional() - Method in class io.ebean.migration.ddl.DdlParser
-
Return the non-transactional statements which run later with auto commit true.
- 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.
- getPlatformName() - Method in class io.ebean.migration.MigrationConfig
-
Return the DB platform name (used for platform create table and select for update syntax).
- 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 - package io.ebean.migration
- io.ebean.migration.ddl - package io.ebean.migration.ddl
- io.ebean.migration.runner - package io.ebean.migration.runner
- io.ebean.migration.util - package io.ebean.migration.util
- IOUtils - Class in io.ebean.migration.util
-
Utilities for IO.
- IOUtils() - Constructor for class io.ebean.migration.util.IOUtils
- isAllowErrorInRepeatable() - Method in class io.ebean.migration.MigrationConfig
-
Return true if we continue running the migration when a repeatable migration fails.
- isAutoCommit() - Method in interface io.ebean.migration.ddl.DdlAutoCommit
-
Return true if auto commit true should be used for all DDL for the database platform.
- 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).
J
- JdbcClose - Class in io.ebean.migration.util
-
Utility for closing raw Jdbc resources.
- JdbcClose() - Constructor for class io.ebean.migration.util.JdbcClose
- 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
- load(Properties) - Method in class io.ebean.migration.MigrationConfig
-
Load configuration from standard properties.
- 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.
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 - 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.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 - 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
- NONE - Static variable in interface io.ebean.migration.ddl.DdlAutoCommit
- 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(Reader) - Method in class io.ebean.migration.ddl.DdlParser
-
Break up the sql in reader into a list of statements using the semi-colon and $$ delimiters;
- 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
- POSTGRES - Static variable in interface io.ebean.migration.ddl.DdlAutoCommit
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.
- readUtf8(InputStream) - Static method in class io.ebean.migration.util.IOUtils
-
Reads the entire contents of the specified input stream and return them as UTF-8 string.
- readUtf8(URL) - Static method in class io.ebean.migration.util.IOUtils
-
Reads the entire contents of the specified URL and return them as UTF-8 string.
- replace(String, String, String) - Static method in class io.ebean.migration.runner.ScriptTransform
-
Transform just ${table} with the table name.
- rollback(Connection) - Static method in class io.ebean.migration.util.JdbcClose
-
Rollback the connection logging if an error occurs.
- 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(DataSource) - Method in class io.ebean.migration.MigrationRunner
-
Run using the connection from the DataSource.
- runAll(String, Connection) - Method in class io.ebean.migration.ddl.DdlRunner
-
Parse the content into sql statements and execute them in a transaction.
- 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.
- runNonTransactional(Connection) - Method in class io.ebean.migration.ddl.DdlRunner
-
Run any non-transactional statements from the just parsed script.
- runNonTransactional(Connection, List<String>) - Method in class io.ebean.migration.ddl.DdlRunner
-
Run the non-transactional statements with auto commit true.
S
- ScriptTransform - Class in io.ebean.migration.runner
-
Transforms a SQL script given a map of key/value substitutions.
- setAllowErrorInRepeatable(boolean) - Method in class io.ebean.migration.MigrationConfig
-
Set to true to continue running the migration when a repeatable migration fails.
- setApplySuffix(String) - Method in class io.ebean.migration.MigrationConfig
-
Set the suffix for migration resources.
- 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
-
Set the DB Driver.
- 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.
- 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
-
Sets 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
- 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.
- setPlatformName(String) - Method in class io.ebean.migration.MigrationConfig
-
Set a DB platform name (to load specific create table and select for update syntax).
- 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.
- 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
- transactional(String) - Method in interface io.ebean.migration.ddl.DdlAutoCommit
-
Return false if the SQL is non transactional and should run with auto commit.
- transform(String) - Method in class io.ebean.migration.runner.ScriptTransform
-
Transform the script replacing placeholders in the form
${key}withvalue. - trim(String) - Static method in class io.ebean.migration.MigrationVersion
-
Parse the raw version string and just return the leading version number;
V
- VERSION_TYPE - Static variable in class io.ebean.migration.MigrationVersion
All Classes All Packages