com.j256.ormlite.table

Class SchemaUtils

java.lang.Object

com.j256.ormlite.table.SchemaUtils

public class SchemaUtils
extends Object

Couple utility methods for the creating, dropping, and maintenance of schemas.

Method Summary

Modifier and Type	Method and Description
static <T> int	createSchema(ConnectionSource connectionSource, Class<T> dataClass) Issue the database statements to create the schema associated with a class.
static <T> int	createSchema(ConnectionSource connectionSource, String schemaName) Issue the database statements to create the schema associated with a schema configuration.
static int	createSchema(Dao<?,?> dao) Issue the database statements to create the schema associated with a table configuration.
static <T> int	createSchemaIfNotExists(ConnectionSource connectionSource, Class<T> dataClass) Create a schema if it does not already exist.
static <T> int	createSchemaIfNotExists(ConnectionSource connectionSource, String schemaName) Create a schema if it does not already exist.
static <T,ID> int	dropSchema(ConnectionSource connectionSource, Class<T> dataClass, boolean ignoreErrors) Issue the database statements to drop the schema associated with a class.
static <T,ID> int	dropSchema(ConnectionSource connectionSource, String schemaName, boolean ignoreErrors) Issue the database statements to drop the schema associated with a schema configuration.
static <T> List<String>	getCreateSchemaStatements(DatabaseType databaseType, String schemaName) Return an list of SQL statements that need to be run to create a schema.

Methods inherited from class java.lang.Object

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

Method Detail

createSchema

public static <T> int createSchema(ConnectionSource connectionSource,
                                   Class<T> dataClass)
                            throws SQLException

Issue the database statements to create the schema associated with a class.

Parameters:

connectionSource - Associated connection source.

dataClass - The class for which a schema will be created.

Returns:

The number of statements executed to do so.

Throws:

SQLException

createSchema

public static int createSchema(Dao<?,?> dao)
                        throws SQLException

Issue the database statements to create the schema associated with a table configuration.

Parameters:

dao - Associated dao.

Returns:

The number of statements executed to do so.

Throws:

SQLException

createSchemaIfNotExists

public static <T> int createSchemaIfNotExists(ConnectionSource connectionSource,
                                              Class<T> dataClass)
                                       throws SQLException

Create a schema if it does not already exist. This is not supported by all databases.

Throws:

SQLException

createSchema

public static <T> int createSchema(ConnectionSource connectionSource,
                                   String schemaName)
                            throws SQLException

Issue the database statements to create the schema associated with a schema configuration.

Parameters:

connectionSource - connectionSource Associated connection source.

schemaName - schema name

Returns:

The number of statements executed to do so.

Throws:

SQLException

createSchemaIfNotExists

public static <T> int createSchemaIfNotExists(ConnectionSource connectionSource,
                                              String schemaName)
                                       throws SQLException

Create a schema if it does not already exist. This is not supported by all databases.

Throws:

SQLException

getCreateSchemaStatements

public static <T> List<String> getCreateSchemaStatements(DatabaseType databaseType,
                                                         String schemaName)

Return an list of SQL statements that need to be run to create a schema. To do the work of creating, you should call createSchema(com.j256.ormlite.support.ConnectionSource, java.lang.Class<T>).

Parameters:

databaseType - The type of database which will be executing the create schema statements.

schemaName - Schema Name.

Returns:

A list of schema create statements.

dropSchema

public static <T,ID> int dropSchema(ConnectionSource connectionSource,
                                    Class<T> dataClass,
                                    boolean ignoreErrors)
                             throws SQLException

Issue the database statements to drop the schema associated with a class.

WARNING: This is [obviously] very destructive and is unrecoverable.

Parameters:

connectionSource - Associated connection source.

dataClass - The class for which a schema will be dropped.

ignoreErrors - If set to true then try each statement regardless of SQLException thrown previously.

Returns:

The number of statements executed to do so.

Throws:

SQLException

dropSchema

public static <T,ID> int dropSchema(ConnectionSource connectionSource,
                                    String schemaName,
                                    boolean ignoreErrors)
                             throws SQLException

Issue the database statements to drop the schema associated with a schema configuration.

WARNING: This is [obviously] very destructive and is unrecoverable.

Parameters:

connectionSource - Associated connection source.

schemaName - schema name

ignoreErrors - If set to true then try each statement regardless of SQLException thrown previously.

Returns:

The number of statements executed to do so.

Throws:

SQLException