edu.internet2.middleware.grouper.ddl
Class GrouperDdlUtils

java.lang.Object
  edu.internet2.middleware.grouper.ddl.GrouperDdlUtils

public class GrouperDdlUtils
extends java.lang.Object

Nested Class Summary

static class

GrouperDdlUtils.DbMetadataBean bean

Field Summary

static boolean	compareFromDbDllVersion true to compare ddl from db version to the current java version, false to start over and find all diffs (without deleting existing)
static boolean	deepCheck if check from scratch
static boolean	everythingRightVersion if everything is the right version
static boolean	internal_printDdlUpdateMessage set this to false for testing

Constructor Summary

GrouperDdlUtils()

Method Summary

static boolean	assertColumnThere(boolean expectTrue, java.lang.String tableName, java.lang.String columnName) see if tables are there (at least the grouper groups one)
static boolean	assertTablesThere(boolean expectRecords, boolean expectTrue) see if tables are there (at least the grouper groups one)
static boolean	assertTablesThere(boolean expectRecords, boolean expectTrue, java.lang.String tableName, boolean falseIfDropBeforeCreate) see if tables are there (at least the grouper groups one)
static void	bootstrap(boolean callFromCommandLine, boolean installDefaultGrouperData, boolean promptUser) startup the process, if the version table is not there, print out that ddl
static boolean	bootstrapHelper(boolean callFromCommandLine, boolean fromUnitTest, boolean theCompareFromDbVersion, boolean theDropBeforeCreate, boolean theWriteAndRunScript, boolean dropOnly, boolean installDefaultGrouperData, java.util.Map<java.lang.String,DdlVersionable> maxVersions, boolean promptUser) helper method which is more easily testable
static java.lang.String	changeDatabase(java.lang.String objectName, DdlUtilsChangeDatabase ddlUtilsChangeDatabase) helper method to run custom db ddl, which is more easily testable TODO consolidate this code with the bootstrap code in the DdlVersionBean or somewhere Here is an example: GrouperDdlUtils.changeDatabase(GrouperDdl.V1.getObjectName(), new DdlUtilsChangeDatabase() { public void changeDatabase(DdlVersionBean ddlVersionBean) { Database database = ddlVersionBean.getDatabase(); { Table attributesTable = database.findTable(Attribute.TABLE_GROUPER_ATTRIBUTES); Column attributesFieldIdColumn = attributesTable.findColumn(Attribute.COLUMN_FIELD_ID); attributesTable.removeColumn(attributesFieldIdColumn); } { Table membershipsTable = database.findTable(Membership.TABLE_GROUPER_MEMBERSHIPS); Column membershipsFieldIdColumn = membershipsTable.findColumn(Membership.COLUMN_FIELD_ID); membershipsTable.removeColumn(membershipsFieldIdColumn); } } });
static java.lang.String	convertUrlToDriverClassIfNeeded(java.lang.String connectionUrl, java.lang.String driverClassName) if there is no driver class specified, then try to derive it from the URL
static java.lang.String	convertUrlToHibernateDialectIfNeeded(java.lang.String connectionUrl, java.lang.String hibernateDialect) if there is no driver class specified, then try to derive it from the URL
static java.lang.String	convertUrlToQuartzDriverDelegateClassIfNeeded(java.lang.String connectionUrl, java.lang.String driverClassName) if there is no quartz driver class specified, then try to derive it from the URL
static void	ddlutilsBackupTable(DdlVersionBean ddlVersionBean, java.lang.String tableName, java.lang.String backupTableName) backup a table into another table (which should not exist)
static void	ddlutilsColumnComment(DdlVersionBean ddlVersionBean, java.lang.String objectName, java.lang.String columnName, java.lang.String comment) add a table or view column comment if the DB supports it COMMENT ON COLUMN zip_code.zip_code IS '5 Digit Zip Code';
static void	ddlutilsCreateOrReplaceView(DdlVersionBean ddlVersionBean, java.lang.String viewName, java.lang.String viewComment, java.util.Set<java.lang.String> aliases, java.util.Set<java.lang.String> columnComments, java.lang.String sql) add a view if the DB supports it
static void	ddlutilsDropColumn(org.apache.ddlutils.model.Database database, java.lang.String tableName, java.lang.String columnName, DdlVersionBean ddlVersionBean) find and drop a column if it is there.
static void	ddlutilsDropColumn(org.apache.ddlutils.model.Table table, java.lang.String columnName, DdlVersionBean ddlVersionBean) find and drop a column if it is there also drop all related indexes
static void	ddlutilsDropIndexes(org.apache.ddlutils.model.Table table, java.lang.String columnName) drop all indexes by column name (e.g. if removing column)
static void	ddlutilsDropTable(DdlVersionBean ddlVersionBean, java.lang.String tableName, boolean falseIfDropBeforeCreate) find and drop a table if it is there
static void	ddlutilsDropViewIfExists(DdlVersionBean ddlVersionBean, java.lang.String viewName, boolean falseIfDropBeforeCreate) drop a view if it is detected as existing
static org.apache.ddlutils.model.Column	ddlutilsFindColumn(org.apache.ddlutils.model.Database database, java.lang.String tableName, java.lang.String columnName, boolean exceptionIfNotFound) find table, if not exist, throw exception
static org.apache.ddlutils.model.Column	ddlutilsFindColumn(org.apache.ddlutils.model.Table table, java.lang.String columnName, boolean exceptionOnNotFound) find column, if not exist, throw exception
static org.apache.ddlutils.model.Column	ddlutilsFindOrCreateColumn(org.apache.ddlutils.model.Table table, java.lang.String columnName, int typeCode, java.lang.String size, boolean primaryKey, boolean required) find or create column with various properties
static org.apache.ddlutils.model.Column	ddlutilsFindOrCreateColumn(org.apache.ddlutils.model.Table table, java.lang.String columnName, int typeCode, java.lang.String size, boolean primaryKey, boolean required, java.lang.String defaultValue) find or create column with various properties
static org.apache.ddlutils.model.ForeignKey	ddlutilsFindOrCreateForeignKey(org.apache.ddlutils.model.Database database, java.lang.String tableName, java.lang.String foreignKeyName, java.lang.String foreignTableName, java.util.List<java.lang.String> localColumnNames, java.util.List<java.lang.String> foreignColumnNames) add a foreign key on a table.
static org.apache.ddlutils.model.ForeignKey	ddlutilsFindOrCreateForeignKey(org.apache.ddlutils.model.Database database, java.lang.String tableName, java.lang.String foreignKeyName, java.lang.String foreignTableName, java.lang.String localColumnName, java.lang.String foreignColumnName) add a foreign key on a table.
static org.apache.ddlutils.model.Index	ddlutilsFindOrCreateIndex(org.apache.ddlutils.model.Database database, DdlVersionBean ddlVersionBean, java.lang.String tableName, java.lang.String indexName, java.lang.String customScript, boolean unique, java.lang.String... columnNames) add an index on a table.
static org.apache.ddlutils.model.Index	ddlutilsFindOrCreateIndex(org.apache.ddlutils.model.Database database, java.lang.String tableName, java.lang.String indexName, boolean unique, java.lang.String... columnNames) add an index on a table.
static org.apache.ddlutils.model.Table	ddlutilsFindOrCreateTable(org.apache.ddlutils.model.Database database, java.lang.String tableName) find or create table
static org.apache.ddlutils.model.Table	ddlutilsFindTable(org.apache.ddlutils.model.Database database, java.lang.String tableName, boolean exceptionOnNotFound) find table, if not exist, throw exception
static org.apache.ddlutils.model.Column	ddlutilsFixSizeColumn(org.apache.ddlutils.model.Table table, java.lang.String columnName, int typeCode, java.lang.String size, boolean primaryKey, boolean required) find or create column with various properties
static org.apache.ddlutils.model.Column	ddlutilsFixSizeColumn(org.apache.ddlutils.model.Table table, java.lang.String columnName, int typeCode, java.lang.String size, boolean primaryKey, boolean required, java.lang.String defaultValue) find or create column with various properties
static void	ddlutilsTableComment(DdlVersionBean ddlVersionBean, java.lang.String tableName, java.lang.String tableComment) add a table comment if the DB supports it
static void	ddlutilsViewComment(DdlVersionBean ddlVersionBean, java.lang.String viewName, java.lang.String tableComment) add a view comment if the DB supports it
static void	deleteDdlById(java.lang.String id)
static void	deleteUtfDdls() delete all utf ddls
static void	dropAllForeignKeys(org.apache.ddlutils.model.Database database) drop all foreign keys from a ddlutils database object
static void	dropAllForeignKeysScript(GrouperDdlUtils.DbMetadataBean dbMetadataBean, DdlVersionBean ddlVersionBean) drop all foreign keys (database dependent), and generate the script
static GrouperDdlUtils.DbMetadataBean	findDbMetadataBean(DdlVersionable ddlVersionable) find the correct metadata for the DB
static java.lang.String	findScriptOverride(DdlVersionable dbObjectVersion, java.lang.String dbname) File name must be objectName.V#.dbname.sql e.g.
static java.lang.String	findScriptOverride(java.lang.String objectName, int version, java.lang.String dbNameExact) get an override file (exact, dont look for the all ones like oracleall) File name must be objectName.V#.dbname.sql e.g.
static int	getTableCount(java.lang.String tableName, boolean exceptionIfTableDoesNotExist) Get the number of records in a table
static boolean	isHsql() see if the config file seems to be hsql
static boolean	isHsql(java.lang.String connectionUrl) see if the config file seems to be hsql
static boolean	isMysql() see if the config file seems to be mysql
static boolean	isMysql(java.lang.String connectionUrl) see if the config file seems to be mysql
static boolean	isOracle() see if the config file seems to be oracle
static boolean	isOracle(java.lang.String connectionUrl) see if the config file seems to be oracle
static boolean	isPostgres() see if the config file seems to be postgres
static boolean	isPostgres(java.lang.String connectionUrl) see if the config file seems to be postgres
static boolean	isSQLServer() see if the config file seems to be sql server
static boolean	isSQLServer(java.lang.String connectionUrl) see if the config file seems to be sql server
static void	main(java.lang.String[] args) kick off bootstrap
static java.lang.String	objectName(java.lang.Enum dbObjectVersion) find the object name from the db object version
static boolean	okToUseHibernate() if we are inside the bootstrap, or if everything is ok, we are good to go
static void	removeAllTables(org.apache.ddlutils.model.Database database) remove all objects, the foreign keys, then the tables
static DdlVersionable	retieveVersion(java.lang.String objectName, int version) retrieve a version of a ddl object versionable
static Hib3GrouperDdl	retrieveDdlByIdFromDatabase(java.lang.String id)
static Hib3GrouperDdl	retrieveDdlByNameFromDatabase(java.lang.String objectName) retrieve a DDL by name
static int	retrieveDdlDbVersion(java.lang.String objectName) get the version of a ddl object in the DB
static java.lang.Class<java.lang.Enum>	retrieveDdlEnum(java.lang.String objectName) the relationship between object name and the enum is as follows.
static int	retrieveDdlJavaVersion(java.lang.String objectName) get the version of a ddl object in the DB
static java.util.List<Hib3GrouperDdl>	retrieveDdlsFromDb() get all the ddls, put grouper at the front
static java.lang.StringBuilder	retrieveHistory(java.lang.String objectName) find history for a certain object name
static java.util.List<java.lang.String>	retrieveObjectNames() get the object names from the
static org.apache.ddlutils.Platform	retrievePlatform() retrieve the ddl utils platform
static org.apache.ddlutils.Platform	retrievePlatform(boolean useCache) retrieve the ddl utils platform
static java.lang.String	sqlConcatenation(java.lang.String field1, java.lang.String field2) Returns the sql to concatenate these two fields separated by the separator
static java.lang.String	sqlConcatenation(java.lang.String field1, java.lang.String field2, java.lang.String separator) Returns the sql to concatenate these two fields separated by the separator
static java.lang.String	sqlRun(java.io.File scriptFile, boolean fromUnitTest, boolean printErrorToStdOut) run a script file against the default database
static java.lang.String	sqlRun(java.io.File scriptFile, java.lang.String driver, java.lang.String url, java.lang.String user, java.lang.String pass, boolean fromUnitTest, boolean printErrorToStdOut) run some sql
static Hib3GrouperDdl	storeAndReadUtfString(java.lang.String someUtfString, java.lang.String id, java.lang.String name) store and read a utf string, but dont commit it so its doesnt stay in the database
static Hib3GrouperDdl	storeDdl(HibernateSession hibernateSession, java.lang.String id, java.lang.String name, java.lang.String someUtfString)
static boolean	tableExists(java.lang.String tableName) see if tables are there (at least the grouper groups one)
static void	upgradeDatabaseVersion(org.apache.ddlutils.model.Database baseVersion, org.apache.ddlutils.model.Database oldVersion, int baseDatabaseVersion, java.lang.String objectName, int requestedVersion, int upgradeToVersion, java.lang.StringBuilder additionalScripts, java.lang.StringBuilder fullScript, org.apache.ddlutils.Platform platform, java.sql.Connection connection, java.lang.String schema, org.apache.ddlutils.platform.SqlBuilder sqlBuilder) get a database object of a certain version based on the existing database, and tack on all the enums up to the version we want (if any)
static int	versionIntFromEnum(java.lang.Enum ddlVersion) find a version from an enum version int

Methods inherited from class java.lang.Object

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

Field Detail

compareFromDbDllVersion

public static boolean compareFromDbDllVersion

true to compare ddl from db version to the current java version, false to start over and find all diffs (without deleting existing)

everythingRightVersion

public static boolean everythingRightVersion

if everything is the right version

internal_printDdlUpdateMessage

public static boolean internal_printDdlUpdateMessage

set this to false for testing

deepCheck

public static boolean deepCheck

if check from scratch

Constructor Detail

GrouperDdlUtils

public GrouperDdlUtils()

Method Detail

isHsql

public static boolean isHsql()

see if the config file seems to be hsql

Returns:

see if hsql

isHsql

public static boolean isHsql(java.lang.String connectionUrl)

see if the config file seems to be hsql

Parameters:

connectionUrl - url to check against

Returns:

see if hsql

isPostgres

public static boolean isPostgres()

see if the config file seems to be postgres

Returns:

see if postgres

isPostgres

public static boolean isPostgres(java.lang.String connectionUrl)

see if the config file seems to be postgres

Parameters:

connectionUrl -

Returns:

see if postgres

isOracle

public static boolean isOracle()

see if the config file seems to be oracle

Returns:

see if oracle

isOracle

public static boolean isOracle(java.lang.String connectionUrl)

see if the config file seems to be oracle

Parameters:

connectionUrl -

Returns:

see if oracle

isMysql

public static boolean isMysql()

see if the config file seems to be mysql

Returns:

see if mysql

isMysql

public static boolean isMysql(java.lang.String connectionUrl)

see if the config file seems to be mysql

Parameters:

connectionUrl -

Returns:

see if mysql

isSQLServer

public static boolean isSQLServer()

see if the config file seems to be sql server

Returns:

see if sql server

isSQLServer

public static boolean isSQLServer(java.lang.String connectionUrl)

see if the config file seems to be sql server

Parameters:

connectionUrl -

Returns:

see if sql server

okToUseHibernate

public static boolean okToUseHibernate()

if we are inside the bootstrap, or if everything is ok, we are good to go

Returns:

true if ok

retrievePlatform

public static org.apache.ddlutils.Platform retrievePlatform()

retrieve the ddl utils platform

Returns:

the platform object

retrievePlatform

public static org.apache.ddlutils.Platform retrievePlatform(boolean useCache)

retrieve the ddl utils platform

Parameters:

useCache - if we should get from cache if it is available

Returns:

the platform object

main

public static void main(java.lang.String[] args)

kick off bootstrap

Parameters:

args -

bootstrap

public static void bootstrap(boolean callFromCommandLine,
                             boolean installDefaultGrouperData,
                             boolean promptUser)

startup the process, if the version table is not there, print out that ddl

Parameters:

callFromCommandLine -

installDefaultGrouperData -

promptUser - prompt user to see if they really want to do this

bootstrapHelper

public static boolean bootstrapHelper(boolean callFromCommandLine,
                                      boolean fromUnitTest,
                                      boolean theCompareFromDbVersion,
                                      boolean theDropBeforeCreate,
                                      boolean theWriteAndRunScript,
                                      boolean dropOnly,
                                      boolean installDefaultGrouperData,
                                      java.util.Map<java.lang.String,DdlVersionable> maxVersions,
                                      boolean promptUser)

helper method which is more easily testable

Parameters:

callFromCommandLine -

fromUnitTest - true if just testing this method

theCompareFromDbVersion -

theDropBeforeCreate -

theWriteAndRunScript -

dropOnly - just drop stuff, e.g. for unit test

installDefaultGrouperData - if registry install should be called afterwards

maxVersions - if unit testing, and not going to max, then associate object name with max version

promptUser - promptUser to see if they want to do this...

Returns:

true if up to date, false if needs to run a script

sqlRun

public static java.lang.String sqlRun(java.io.File scriptFile,
                                      boolean fromUnitTest,
                                      boolean printErrorToStdOut)

run a script file against the default database

Parameters:

scriptFile -

fromUnitTest -

printErrorToStdOut -

Returns:

the output

convertUrlToDriverClassIfNeeded

public static java.lang.String convertUrlToDriverClassIfNeeded(java.lang.String connectionUrl,
                                                               java.lang.String driverClassName)

if there is no driver class specified, then try to derive it from the URL

Parameters:

connectionUrl -

driverClassName -

Returns:

the driver class

convertUrlToQuartzDriverDelegateClassIfNeeded

public static java.lang.String convertUrlToQuartzDriverDelegateClassIfNeeded(java.lang.String connectionUrl,
                                                                             java.lang.String driverClassName)

if there is no quartz driver class specified, then try to derive it from the URL

Parameters:

connectionUrl -

driverClassName -

Returns:

the driver class

convertUrlToHibernateDialectIfNeeded

public static java.lang.String convertUrlToHibernateDialectIfNeeded(java.lang.String connectionUrl,
                                                                    java.lang.String hibernateDialect)

if there is no driver class specified, then try to derive it from the URL

Parameters:

connectionUrl -

hibernateDialect -

Returns:

the driver class

sqlRun

public static java.lang.String sqlRun(java.io.File scriptFile,
                                      java.lang.String driver,
                                      java.lang.String url,
                                      java.lang.String user,
                                      java.lang.String pass,
                                      boolean fromUnitTest,
                                      boolean printErrorToStdOut)

run some sql

Parameters:

scriptFile -

driver -

url -

user -

pass -

fromUnitTest -

printErrorToStdOut -

Returns:

the output

changeDatabase

public static java.lang.String changeDatabase(java.lang.String objectName,
                                              DdlUtilsChangeDatabase ddlUtilsChangeDatabase)

 helper method to run custom db ddl, which is more easily testable
 TODO consolidate this code with the bootstrap code in the DdlVersionBean or somewhere
 Here is an example:
 
     GrouperDdlUtils.changeDatabase(GrouperDdl.V1.getObjectName(), new DdlUtilsChangeDatabase() {
 
       public void changeDatabase(DdlVersionBean ddlVersionBean) {
         
         Database database = ddlVersionBean.getDatabase();
         {
           Table attributesTable = database.findTable(Attribute.TABLE_GROUPER_ATTRIBUTES);
           Column attributesFieldIdColumn = attributesTable.findColumn(Attribute.COLUMN_FIELD_ID);
           attributesTable.removeColumn(attributesFieldIdColumn);
         }
         
         {
           Table membershipsTable = database.findTable(Membership.TABLE_GROUPER_MEMBERSHIPS);
           Column membershipsFieldIdColumn = membershipsTable.findColumn(Membership.COLUMN_FIELD_ID);
           membershipsTable.removeColumn(membershipsFieldIdColumn);
         }
         
       }
       
     });
 
 
 

Parameters:

objectName - (from enum of ddl utils type)

ddlUtilsChangeDatabase - is the callback to change the database

Returns:

string

dropAllForeignKeysScript

public static void dropAllForeignKeysScript(GrouperDdlUtils.DbMetadataBean dbMetadataBean,
                                            DdlVersionBean ddlVersionBean)

drop all foreign keys (database dependent), and generate the script

Parameters:

dbMetadataBean -

ddlVersionBean -

removeAllTables

public static void removeAllTables(org.apache.ddlutils.model.Database database)

remove all objects, the foreign keys, then the tables

Parameters:

database -

retrieveHistory

public static java.lang.StringBuilder retrieveHistory(java.lang.String objectName)

find history for a certain object name

Parameters:

objectName -

Returns:

the history or new stringbuilder if none available

retieveVersion

public static DdlVersionable retieveVersion(java.lang.String objectName,
                                            int version)

retrieve a version of a ddl object versionable

Parameters:

objectName -

version -

Returns:

the ddl versionable

retrieveDdlJavaVersion

public static int retrieveDdlJavaVersion(java.lang.String objectName)

get the version of a ddl object in the DB

Parameters:

objectName -

Returns:

the version or -1 if not in the DB

retrieveDdlEnum

public static java.lang.Class<java.lang.Enum> retrieveDdlEnum(java.lang.String objectName)

the relationship between object name and the enum is as follows. If the object name is "Grouper", then the enum is edu.internet2.middleware.grouper.ddl.GrouperDdl

Parameters:

objectName -

Returns:

the enum

ddlutilsDropViewIfExists

public static void ddlutilsDropViewIfExists(DdlVersionBean ddlVersionBean,
                                            java.lang.String viewName,
                                            boolean falseIfDropBeforeCreate)

drop a view if it is detected as existing

Parameters:

ddlVersionBean -

viewName -

falseIfDropBeforeCreate -

ddlutilsBackupTable

public static void ddlutilsBackupTable(DdlVersionBean ddlVersionBean,
                                       java.lang.String tableName,
                                       java.lang.String backupTableName)

backup a table into another table (which should not exist)

Parameters:

ddlVersionBean -

tableName -

backupTableName -

ddlutilsCreateOrReplaceView

public static void ddlutilsCreateOrReplaceView(DdlVersionBean ddlVersionBean,
                                               java.lang.String viewName,
                                               java.lang.String viewComment,
                                               java.util.Set<java.lang.String> aliases,
                                               java.util.Set<java.lang.String> columnComments,
                                               java.lang.String sql)

add a view if the DB supports it

Parameters:

ddlVersionBean -

viewName -

viewComment -

aliases -

columnComments -

sql - should not have a semicolon at end

ddlutilsTableComment

public static void ddlutilsTableComment(DdlVersionBean ddlVersionBean,
                                        java.lang.String tableName,
                                        java.lang.String tableComment)

add a table comment if the DB supports it

Parameters:

ddlVersionBean -

tableName -

tableComment -

ddlutilsViewComment

public static void ddlutilsViewComment(DdlVersionBean ddlVersionBean,
                                       java.lang.String viewName,
                                       java.lang.String tableComment)

add a view comment if the DB supports it

Parameters:

ddlVersionBean -

viewName -

tableComment -

ddlutilsColumnComment

public static void ddlutilsColumnComment(DdlVersionBean ddlVersionBean,
                                         java.lang.String objectName,
                                         java.lang.String columnName,
                                         java.lang.String comment)

 add a table or view column comment if the DB supports it
   COMMENT ON COLUMN zip_code.zip_code IS '5 Digit Zip Code';
 

Parameters:

ddlVersionBean -

objectName -

comment -

columnName -

retrieveObjectNames

public static java.util.List<java.lang.String> retrieveObjectNames()

get the object names from the

Returns:

the list of object names

retrieveDdlDbVersion

public static int retrieveDdlDbVersion(java.lang.String objectName)

get the version of a ddl object in the DB

Parameters:

objectName -

Returns:

the version or -1 if not in the DB

retrieveDdlByIdFromDatabase

public static Hib3GrouperDdl retrieveDdlByIdFromDatabase(java.lang.String id)

Parameters:

id -

Returns:

the ddl

deleteDdlById

public static void deleteDdlById(java.lang.String id)

Parameters:

id -

deleteUtfDdls

public static void deleteUtfDdls()

delete all utf ddls

retrieveDdlByNameFromDatabase

public static Hib3GrouperDdl retrieveDdlByNameFromDatabase(java.lang.String objectName)

retrieve a DDL by name

Parameters:

objectName -

Returns:

the ddl or null

storeAndReadUtfString

public static Hib3GrouperDdl storeAndReadUtfString(java.lang.String someUtfString,
                                                   java.lang.String id,
                                                   java.lang.String name)

store and read a utf string, but dont commit it so its doesnt stay in the database

Parameters:

someUtfString -

id -

name -

Returns:

the ddl if it is found

storeDdl

public static Hib3GrouperDdl storeDdl(HibernateSession hibernateSession,
                                      java.lang.String id,
                                      java.lang.String name,
                                      java.lang.String someUtfString)

Parameters:

someUtfString -

id -

name -

hibernateSession -

Returns:

the object

retrieveDdlsFromDb

public static java.util.List<Hib3GrouperDdl> retrieveDdlsFromDb()

get all the ddls, put grouper at the front

Returns:

the ddls

findScriptOverride

public static java.lang.String findScriptOverride(DdlVersionable dbObjectVersion,
                                                  java.lang.String dbname)

 File name must be objectName.V#.dbname.sql
 e.g. Grouper.5.oracle10.sql
 
 The dbname must be a valid ddlutils dbname:
 axion, cloudscape, db2, db2v8, derby, firebird, hsqldb, interbase, maxdb, mckoi, 
 mssql, mysql, mysql5, oracle, oracle10, oracle9, postgresql, sapdb, sybase, sybasease15

 Also the following catchalls are acceptable: oracleall, mysqlall, db2all, sybaseall
 

Parameters:

dbObjectVersion - e.g. Grouper or GrouperLoader

dbname - e.g. oracle10 or mysql5

Returns:

the script or blank if it is not found

findScriptOverride

public static java.lang.String findScriptOverride(java.lang.String objectName,
                                                  int version,
                                                  java.lang.String dbNameExact)

 get an override file (exact, dont look for the all ones like oracleall)
 File name must be objectName.V#.dbname.sql
 e.g. Grouper.5.oracle10.sql
 
 

Parameters:

objectName -

version -

dbNameExact -

Returns:

the script or null if none found

versionIntFromEnum

public static int versionIntFromEnum(java.lang.Enum ddlVersion)

find a version from an enum version int

Parameters:

ddlVersion -

Returns:

the version

objectName

public static java.lang.String objectName(java.lang.Enum dbObjectVersion)

find the object name from the db object version

Parameters:

dbObjectVersion -

Returns:

the object name

upgradeDatabaseVersion

public static void upgradeDatabaseVersion(org.apache.ddlutils.model.Database baseVersion,
                                          org.apache.ddlutils.model.Database oldVersion,
                                          int baseDatabaseVersion,
                                          java.lang.String objectName,
                                          int requestedVersion,
                                          int upgradeToVersion,
                                          java.lang.StringBuilder additionalScripts,
                                          java.lang.StringBuilder fullScript,
                                          org.apache.ddlutils.Platform platform,
                                          java.sql.Connection connection,
                                          java.lang.String schema,
                                          org.apache.ddlutils.platform.SqlBuilder sqlBuilder)

get a database object of a certain version based on the existing database, and tack on all the enums up to the version we want (if any)

Parameters:

baseVersion -

oldVersion - old version if there is one, null if not

baseDatabaseVersion -

objectName -

requestedVersion -

upgradeToVersion - eventual upgrade version

additionalScripts -

fullScript - so far

platform -

connection -

schema -

sqlBuilder -

ddlutilsFindOrCreateTable

public static org.apache.ddlutils.model.Table ddlutilsFindOrCreateTable(org.apache.ddlutils.model.Database database,
                                                                        java.lang.String tableName)

find or create table

Parameters:

database -

tableName -

Returns:

the table

ddlutilsFindOrCreateIndex

public static org.apache.ddlutils.model.Index ddlutilsFindOrCreateIndex(org.apache.ddlutils.model.Database database,
                                                                        java.lang.String tableName,
                                                                        java.lang.String indexName,
                                                                        boolean unique,
                                                                        java.lang.String... columnNames)

add an index on a table. drop a misnamed or a misuniqued index which is existing

Parameters:

database -

tableName -

indexName -

unique -

columnNames -

Returns:

the index which is the new one, or existing one if it already exists, or null if a custom index

ddlutilsFindOrCreateIndex

public static org.apache.ddlutils.model.Index ddlutilsFindOrCreateIndex(org.apache.ddlutils.model.Database database,
                                                                        DdlVersionBean ddlVersionBean,
                                                                        java.lang.String tableName,
                                                                        java.lang.String indexName,
                                                                        java.lang.String customScript,
                                                                        boolean unique,
                                                                        java.lang.String... columnNames)

add an index on a table. drop a misnamed or a misuniqued index which is existing

Parameters:

database -

ddlVersionBean - can be null unless custom script

tableName -

indexName -

customScript - use this script to create the index, not ddlutils

unique -

columnNames -

Returns:

the index which is the new one, or existing one if it already exists, or null if a custom index

ddlutilsFindOrCreateForeignKey

public static org.apache.ddlutils.model.ForeignKey ddlutilsFindOrCreateForeignKey(org.apache.ddlutils.model.Database database,
                                                                                  java.lang.String tableName,
                                                                                  java.lang.String foreignKeyName,
                                                                                  java.lang.String foreignTableName,
                                                                                  java.lang.String localColumnName,
                                                                                  java.lang.String foreignColumnName)

add a foreign key on a table. drop a misnamed foreign key which is existing

Parameters:

database -

tableName -

foreignKeyName -

foreignTableName -

localColumnName -

foreignColumnName -

Returns:

the foreign key which is the new one, or existing one if it already exists

ddlutilsFindOrCreateForeignKey

public static org.apache.ddlutils.model.ForeignKey ddlutilsFindOrCreateForeignKey(org.apache.ddlutils.model.Database database,
                                                                                  java.lang.String tableName,
                                                                                  java.lang.String foreignKeyName,
                                                                                  java.lang.String foreignTableName,
                                                                                  java.util.List<java.lang.String> localColumnNames,
                                                                                  java.util.List<java.lang.String> foreignColumnNames)

add a foreign key on a table. drop a misnamed foreign key which is existing

Parameters:

database -

tableName -

foreignKeyName -

foreignTableName -

localColumnNames -

foreignColumnNames -

Returns:

the foreign key which is the new one, or existing one if it already exists

dropAllForeignKeys

public static void dropAllForeignKeys(org.apache.ddlutils.model.Database database)

drop all foreign keys from a ddlutils database object

Parameters:

database -

ddlutilsFindTable

public static org.apache.ddlutils.model.Table ddlutilsFindTable(org.apache.ddlutils.model.Database database,
                                                                java.lang.String tableName,
                                                                boolean exceptionOnNotFound)

find table, if not exist, throw exception

Parameters:

database -

tableName -

exceptionOnNotFound -

Returns:

the table

ddlutilsFindColumn

public static org.apache.ddlutils.model.Column ddlutilsFindColumn(org.apache.ddlutils.model.Database database,
                                                                  java.lang.String tableName,
                                                                  java.lang.String columnName,
                                                                  boolean exceptionIfNotFound)

find table, if not exist, throw exception

Parameters:

database -

tableName -

columnName -

exceptionIfNotFound -

Returns:

the table

ddlutilsFindColumn

public static org.apache.ddlutils.model.Column ddlutilsFindColumn(org.apache.ddlutils.model.Table table,
                                                                  java.lang.String columnName,
                                                                  boolean exceptionOnNotFound)

find column, if not exist, throw exception

Parameters:

table - table to get column from

columnName - column name of column (case insensitive)

exceptionOnNotFound -

Returns:

the column

ddlutilsFindOrCreateColumn

public static org.apache.ddlutils.model.Column ddlutilsFindOrCreateColumn(org.apache.ddlutils.model.Table table,
                                                                          java.lang.String columnName,
                                                                          int typeCode,
                                                                          java.lang.String size,
                                                                          boolean primaryKey,
                                                                          boolean required)

find or create column with various properties

Parameters:

table -

columnName -

typeCode - from java.sql.Types

size - string, can be a simple int, or comma separated, see ddlutils docs

primaryKey - this should only be true for new tables

required - this should probably only be true for new tables (since ddlutils will copy to temp table)

Returns:

the column

ddlutilsFindOrCreateColumn

public static org.apache.ddlutils.model.Column ddlutilsFindOrCreateColumn(org.apache.ddlutils.model.Table table,
                                                                          java.lang.String columnName,
                                                                          int typeCode,
                                                                          java.lang.String size,
                                                                          boolean primaryKey,
                                                                          boolean required,
                                                                          java.lang.String defaultValue)

find or create column with various properties

Parameters:

table -

columnName -

typeCode - from java.sql.Types

size - string, can be a simple int, or comma separated, see ddlutils docs

primaryKey - this should only be true for new tables

required - this should probably only be true for new tables (since ddlutils will copy to temp table)

defaultValue - is null for none, or something for default value

Returns:

the column

ddlutilsFixSizeColumn

public static org.apache.ddlutils.model.Column ddlutilsFixSizeColumn(org.apache.ddlutils.model.Table table,
                                                                     java.lang.String columnName,
                                                                     int typeCode,
                                                                     java.lang.String size,
                                                                     boolean primaryKey,
                                                                     boolean required)

find or create column with various properties

Parameters:

table -

columnName -

typeCode - from java.sql.Types

size - string, can be a simple int, or comma separated, see ddlutils docs

primaryKey - this should only be true for new tables

required - this should probably only be true for new tables (since ddlutils will copy to temp table)

Returns:

the column

ddlutilsFixSizeColumn

public static org.apache.ddlutils.model.Column ddlutilsFixSizeColumn(org.apache.ddlutils.model.Table table,
                                                                     java.lang.String columnName,
                                                                     int typeCode,
                                                                     java.lang.String size,
                                                                     boolean primaryKey,
                                                                     boolean required,
                                                                     java.lang.String defaultValue)

find or create column with various properties

Parameters:

table -

columnName -

typeCode - from java.sql.Types

size - string, can be a simple int, or comma separated, see ddlutils docs

primaryKey - this should only be true for new tables

required - this should probably only be true for new tables (since ddlutils will copy to temp table)

defaultValue - is null for none, or something for default value

Returns:

the column

ddlutilsDropColumn

public static void ddlutilsDropColumn(org.apache.ddlutils.model.Database database,
                                      java.lang.String tableName,
                                      java.lang.String columnName,
                                      DdlVersionBean ddlVersionBean)

find and drop a column if it is there. If table not there, thats ok also drop all related indexes

Parameters:

database -

tableName -

ddlVersionBean -

columnName -

ddlutilsDropTable

public static void ddlutilsDropTable(DdlVersionBean ddlVersionBean,
                                     java.lang.String tableName,
                                     boolean falseIfDropBeforeCreate)

find and drop a table if it is there

Parameters:

ddlVersionBean -

tableName -

falseIfDropBeforeCreate -

ddlutilsDropColumn

public static void ddlutilsDropColumn(org.apache.ddlutils.model.Table table,
                                      java.lang.String columnName,
                                      DdlVersionBean ddlVersionBean)

find and drop a column if it is there also drop all related indexes

Parameters:

table -

columnName -

ddlVersionBean -

ddlutilsDropIndexes

public static void ddlutilsDropIndexes(org.apache.ddlutils.model.Table table,
                                       java.lang.String columnName)

drop all indexes by column name (e.g. if removing column)

Parameters:

table -

columnName -

assertTablesThere

public static boolean assertTablesThere(boolean expectRecords,
                                        boolean expectTrue)

see if tables are there (at least the grouper groups one)

Parameters:

expectRecords -

expectTrue - pritn exception if expecting true

Returns:

true if expect records, and records there. false if records not there. exception if exception is thrown and expect true.false if exception and not expect true

assertTablesThere

public static boolean assertTablesThere(boolean expectRecords,
                                        boolean expectTrue,
                                        java.lang.String tableName,
                                        boolean falseIfDropBeforeCreate)

see if tables are there (at least the grouper groups one)

Parameters:

expectRecords -

expectTrue - pritn exception if expecting true

tableName -

falseIfDropBeforeCreate -

Returns:

true if expect records, and records there. false if records not there. exception if exception is thrown and expect true.false if exception and not expect true

assertColumnThere

public static boolean assertColumnThere(boolean expectTrue,
                                        java.lang.String tableName,
                                        java.lang.String columnName)

see if tables are there (at least the grouper groups one)

Parameters:

expectTrue - throw exception if expecting true and not there or vice versa

tableName -

columnName -

Returns:

true if everything ok, false if not

tableExists

public static boolean tableExists(java.lang.String tableName)

see if tables are there (at least the grouper groups one)

Parameters:

tableName -

Returns:

true if everything ok, false if not

findDbMetadataBean

public static GrouperDdlUtils.DbMetadataBean findDbMetadataBean(DdlVersionable ddlVersionable)

find the correct metadata for the DB

Parameters:

ddlVersionable -

Returns:

the metadatabean

sqlConcatenation

public static java.lang.String sqlConcatenation(java.lang.String field1,
                                                java.lang.String field2,
                                                java.lang.String separator)

Returns the sql to concatenate these two fields separated by the separator

Parameters:

field1 -

field2 -

separator -

Returns:

sql for concatenation

sqlConcatenation

public static java.lang.String sqlConcatenation(java.lang.String field1,
                                                java.lang.String field2)

Returns the sql to concatenate these two fields separated by the separator

Parameters:

field1 -

field2 -

Returns:

sql for concatenation

getTableCount

public static int getTableCount(java.lang.String tableName,
                                boolean exceptionIfTableDoesNotExist)

Get the number of records in a table

Parameters:

tableName -

exceptionIfTableDoesNotExist -

Returns:

count