sirius.db.jdbc.schema

Class SchemaTool

java.lang.Object

sirius.db.jdbc.schema.SchemaTool

public class SchemaTool
extends Object

Helper class for manipulating and inspecting db metadata.

Constructor Summary

Constructors

Constructor and Description
SchemaTool(String realm, DatabaseDialect dialect) Creates a new instance for the given dialect.

Method Summary

Modifier and Type	Method and Description
static String	getJdbcTypeName(int jdbcType) Generates a type name for the given int constant for a JDBC type defined in Types.
List<Table>	getSchema(Database db) Reads the DB-schema for the given connection.
List<SchemaUpdateAction>	migrateSchemaTo(Database db, List<Table> targetSchema, boolean dropTables) Generates a list of schema change actions.
protected void	readTableRow(List<Table> tables, Connection c, ResultSet rs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemaTool

public SchemaTool(String realm,
                  DatabaseDialect dialect)

Creates a new instance for the given dialect.

Parameters:

realm - the realm this schema is for

dialect - the dialect to use when generatic schema change actions.

Method Detail

getSchema

public List<Table> getSchema(Database db)
                      throws SQLException

Reads the DB-schema for the given connection.

Parameters:

db - the database to read the schema from

Returns:

the determined schema

Throws:

SQLException - in case of a database error

readTableRow

protected void readTableRow(List<Table> tables,
                            Connection c,
                            ResultSet rs)
                     throws SQLException

Throws:

SQLException

migrateSchemaTo

public List<SchemaUpdateAction> migrateSchemaTo(Database db,
                                                List<Table> targetSchema,
                                                boolean dropTables)
                                         throws SQLException

Generates a list of schema change actions.

Compares the expected target schema to the database connected via the given connection.

Parameters:

db - the database used to determine the existing schema

targetSchema - the target schema defined by Schema

dropTables - determines if unknown tables should be dropped or not

Returns:

a list of change actions to that the existing schema matches the expected one

Throws:

SQLException - in case of a database error

getJdbcTypeName

public static String getJdbcTypeName(int jdbcType)

Generates a type name for the given int constant for a JDBC type defined in Types.

Parameters:

jdbcType - the type to convert

Returns:

the string representation of the given type