A C D G I J K L M N O P R S T

A

asString() - Method in class org.avaje.dbmigration.MigrationVersion

Return the trimmed version excluding version comment and un-parsable string.

C

calculate(String) - Static method in class org.avaje.dbmigration.runner.Checksum

Returns the checksum of this string.

Checksum - Class in org.avaje.dbmigration.runner

Calculates the checksum for the given string content.

Checksum() - Constructor for class org.avaje.dbmigration.runner.Checksum

close(Connection) - Static method in class org.avaje.dbmigration.util.JdbcClose

Close the connection logging if an error occurs.

close(PreparedStatement) - Static method in class org.avaje.dbmigration.util.JdbcClose

close(ResultSet) - Static method in class org.avaje.dbmigration.util.JdbcClose

compareTo(MigrationVersion) - Method in class org.avaje.dbmigration.MigrationVersion

compareTo(LocalMigrationResource) - Method in class org.avaje.dbmigration.runner.LocalMigrationResource

Default ordering by version.

createConnection() - Method in class org.avaje.dbmigration.MigrationConfig

Create a Connection to the database using the configured driver, url, username etc.

createIfNeeded() - Method in class org.avaje.dbmigration.runner.MigrationTable

Create the table is it does not exist.

D

DdlParser - Class in org.avaje.dbmigration.ddl

Parses string content into separate SQL/DDL statements.

DdlParser() - Constructor for class org.avaje.dbmigration.ddl.DdlParser

DdlRunner - Class in org.avaje.dbmigration.ddl

Runs DDL scripts.

DdlRunner(boolean, String) - Constructor for class org.avaje.dbmigration.ddl.DdlRunner

Construct with a script name (for logging) and flag indicating if errors are expected.

DdlRunnerException - Exception in org.avaje.dbmigration.ddl

DdlRunnerException(Throwable) - Constructor for exception org.avaje.dbmigration.ddl.DdlRunnerException

G

getApplySuffix() - Method in class org.avaje.dbmigration.MigrationConfig

Return the suffix for migration resources (defaults to .sql).

getClassLoader() - Method in class org.avaje.dbmigration.MigrationConfig

Return the ClassLoader to use to load resources.

getComment() - Method in class org.avaje.dbmigration.MigrationVersion

Return the version comment.

getComment() - Method in class org.avaje.dbmigration.runner.LocalMigrationResource

Return the migration comment.

getContent() - Method in class org.avaje.dbmigration.runner.LocalMigrationResource

Return the content for the migration apply ddl script.

getDbDriver() - Method in class org.avaje.dbmigration.MigrationConfig

Return the DB Driver.

getDbPassword() - Method in class org.avaje.dbmigration.MigrationConfig

Return the DB password.

getDbUrl() - Method in class org.avaje.dbmigration.MigrationConfig

Return the DB connection URL.

getDbUsername() - Method in class org.avaje.dbmigration.MigrationConfig

Return the DB username.

getFull() - Method in class org.avaje.dbmigration.MigrationVersion

Return the full version.

getLocation() - Method in class org.avaje.dbmigration.runner.LocalMigrationResource

Return the resource location.

getMetaTable() - Method in class org.avaje.dbmigration.MigrationConfig

Return the name of the migration table.

getMigrationPath() - Method in class org.avaje.dbmigration.MigrationConfig

Return the root path used to find migrations.

getRaw() - Method in class org.avaje.dbmigration.MigrationVersion

Return the version in raw form.

getRunPlaceholderMap() - Method in class org.avaje.dbmigration.MigrationConfig

Return a map of name/value pairs that can be expressions replaced in migration scripts.

getRunPlaceholders() - Method in class org.avaje.dbmigration.MigrationConfig

Return a Comma and equals delimited key/value placeholders to replace in DDL scripts.

getType() - Method in class org.avaje.dbmigration.runner.LocalMigrationResource

Return the type code ("R" or "V") for this migration.

getVersion() - Method in class org.avaje.dbmigration.runner.LocalMigrationResource

Return the underlying migration version.

getVersions() - Method in class org.avaje.dbmigration.runner.LocalMigrationResources

Return the list of migration resources in version order.

I

IOUtils - Class in org.avaje.dbmigration.util

Utilities for IO.

IOUtils() - Constructor for class org.avaje.dbmigration.util.IOUtils

isRepeatable() - Method in class org.avaje.dbmigration.MigrationVersion

Return true if this is a "repeatable" version.

isRepeatable() - Method in class org.avaje.dbmigration.runner.LocalMigrationResource

Return true if the underlying version is "repeatable".

J

JdbcClose - Class in org.avaje.dbmigration.util

Utility for closing raw Jdbc resources.

JdbcClose() - Constructor for class org.avaje.dbmigration.util.JdbcClose

K

key() - Method in class org.avaje.dbmigration.runner.LocalMigrationResource

Return the "key" that identifies the migration.

L

load(Properties) - Method in class org.avaje.dbmigration.MigrationConfig

Load configuration from standard properties.

LocalMigrationResource - Class in org.avaje.dbmigration.runner

A DB migration resource (DDL script with version).

LocalMigrationResource(MigrationVersion, String, Resource) - Constructor for class org.avaje.dbmigration.runner.LocalMigrationResource

Construct with version and resource.

LocalMigrationResources - Class in org.avaje.dbmigration.runner

Loads the DB migration resources and sorts them into execution order.

LocalMigrationResources(MigrationConfig) - Constructor for class org.avaje.dbmigration.runner.LocalMigrationResources

Construct with configuration options.

M

MigrationConfig - Class in org.avaje.dbmigration

Configuration used to run the migration.

MigrationConfig() - Constructor for class org.avaje.dbmigration.MigrationConfig

MigrationException - Exception in org.avaje.dbmigration

MigrationException(String, Throwable) - Constructor for exception org.avaje.dbmigration.MigrationException

MigrationException(String) - Constructor for exception org.avaje.dbmigration.MigrationException

MigrationRunner - Class in org.avaje.dbmigration

Runs the DB migration typically on application start.

MigrationRunner(MigrationConfig) - Constructor for class org.avaje.dbmigration.MigrationRunner

MigrationScriptRunner - Class in org.avaje.dbmigration.runner

Runs the DDL migration scripts.

MigrationScriptRunner(Connection) - Constructor for class org.avaje.dbmigration.runner.MigrationScriptRunner

Construct with a given connection.

MigrationTable - Class in org.avaje.dbmigration.runner

Manages the migration table.

MigrationTable(MigrationConfig, Connection) - Constructor for class org.avaje.dbmigration.runner.MigrationTable

Construct with server, configuration and jdbc connection (DB admin user).

MigrationVersion - Class in org.avaje.dbmigration

The version of a migration used so that migrations are processed in order.

N

nextVersion() - Method in class org.avaje.dbmigration.MigrationVersion

Return the next version based on this version.

normalised() - Method in class org.avaje.dbmigration.MigrationVersion

Return the trimmed version with any underscores replaced with '.'

O

org.avaje.dbmigration - package org.avaje.dbmigration

org.avaje.dbmigration.ddl - package org.avaje.dbmigration.ddl

org.avaje.dbmigration.runner - package org.avaje.dbmigration.runner

org.avaje.dbmigration.util - package org.avaje.dbmigration.util

P

parse(StringReader) - Method in class org.avaje.dbmigration.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 org.avaje.dbmigration.MigrationVersion

Parse the raw version string into a MigrationVersion.

R

readResources() - Method in class org.avaje.dbmigration.runner.LocalMigrationResources

Read all the migration resources (SQL scripts) returning true if there are versions.

readUtf8(InputStream) - Static method in class org.avaje.dbmigration.util.IOUtils

Reads the entire contents of the specified input stream and returns them as UTF-8 string.

rollback(Connection) - Static method in class org.avaje.dbmigration.util.JdbcClose

Rollback the connection logging if an error occurs.

run() - Method in class org.avaje.dbmigration.MigrationRunner

Run by creating a DB connection from driver, url, username defined in MigrationConfig.

run(DataSource) - Method in class org.avaje.dbmigration.MigrationRunner

run(Connection) - Method in class org.avaje.dbmigration.MigrationRunner

Run the migrations if there are any that need running.

runAll(String, Connection) - Method in class org.avaje.dbmigration.ddl.DdlRunner

Parse the content into sql statements and execute them in a transaction.

S

setApplySuffix(String) - Method in class org.avaje.dbmigration.MigrationConfig

Set the suffix for migration resources.

setClassLoader(ClassLoader) - Method in class org.avaje.dbmigration.MigrationConfig

Set the ClassLoader to use when loading resources.

setDbDriver(String) - Method in class org.avaje.dbmigration.MigrationConfig

Set the DB Driver.

setDbPassword(String) - Method in class org.avaje.dbmigration.MigrationConfig

Set the DB password.

setDbUrl(String) - Method in class org.avaje.dbmigration.MigrationConfig

Set the DB connection URL.

setDbUsername(String) - Method in class org.avaje.dbmigration.MigrationConfig

Set the DB username.

setMetaTable(String) - Method in class org.avaje.dbmigration.MigrationConfig

Set the name of the migration table.

setMigrationPath(String) - Method in class org.avaje.dbmigration.MigrationConfig

Set the root path used to find migrations.

setRunPlaceholderMap(Map<String, String>) - Method in class org.avaje.dbmigration.MigrationConfig

Set a map of name/value pairs that can be expressions replaced in migration scripts.

setRunPlaceholders(String) - Method in class org.avaje.dbmigration.MigrationConfig

Set a Comma and equals delimited key/value placeholders to replace in DDL scripts.

shouldRun(LocalMigrationResource, LocalMigrationResource) - Method in class org.avaje.dbmigration.runner.MigrationTable

Return true if the migration ran successfully and false if the migration failed.

size() - Method in class org.avaje.dbmigration.runner.MigrationTable

Return the number of migrations in the DB migration table.

T

toString() - Method in class org.avaje.dbmigration.MigrationVersion

toString() - Method in class org.avaje.dbmigration.runner.LocalMigrationResource

trim(String) - Static method in class org.avaje.dbmigration.MigrationVersion

Parse the raw version string and just return the leading version number;

A C D G I J K L M N O P R S T