Package com.liferay.portal.kernel.dao.db

Class BaseDBProcess

java.lang.Object

com.liferay.portal.kernel.dao.db.BaseDBProcess

All Implemented Interfaces:

DBProcess

Direct Known Subclasses:

UpgradeProcess

public abstract class BaseDBProcess
extends Object
implements DBProcess

Author:

Hugo Huijser, Brian Wing Shun Chan

Field Summary

Fields

Modifier and Type	Field	Description
protected Connection	connection

Constructor Summary

Constructors

Constructor	Description
BaseDBProcess()

Method Summary

Modifier and Type	Method	Description
protected void	addIndexes(Connection connection, List<IndexMetadata> indexMetadatas)
protected void	alterColumnName(String tableName, String oldColumnName, String newColumnDefinition)
protected void	alterColumnType(String tableName, String columnName, String newColumnType)
protected void	alterTableAddColumn(String tableName, String columnName, String columnType)
protected void	alterTableDropColumn(String tableName, String columnName)
protected void	alterTableName(String tableName, String newTableName)
protected void	closeConnections()
protected void	closeConnections(Thread thread)
protected boolean	doHasTable(String tableName)	Deprecated. As of Cavanaugh (7.4.x), replaced by hasTable(String)
protected List<IndexMetadata>	dropIndexes(String tableName, String columnName)
protected void	dropIndexes(List<String> indexNames, String tableName)
protected void	dropTable(String tableName)
protected Connection	getConnection()
protected String[]	getPrimaryKeyColumnNames(Connection connection, String tableName)
protected boolean	hasColumn(String tableName, String columnName)
protected boolean	hasColumnType(String tableName, String columnName, String columnType)
protected boolean	hasIndex(String tableName, String indexName)
protected boolean	hasRows(String tableName)
protected boolean	hasRows(Connection connection, String tableName)
protected boolean	hasTable(String tableName)
protected boolean	hasView(String viewName)
protected void	process(com.liferay.petra.function.UnsafeConsumer<Long,Exception> unsafeConsumer)
protected void	processConcurrently(String sql, com.liferay.petra.function.UnsafeConsumer<PreparedStatement,Exception> unsafeConsumer, String updateSQL, com.liferay.petra.function.UnsafeFunction<ResultSet,Object[],Exception> unsafeFunction, com.liferay.petra.function.UnsafeBiConsumer<Object[],PreparedStatement,Exception> unsafeBiConsumer, String exceptionMessage)
protected void	processConcurrently(String sql, com.liferay.petra.function.UnsafeFunction<ResultSet,Object[],Exception> unsafeFunction, com.liferay.petra.function.UnsafeConsumer<Object[],Exception> unsafeConsumer, String exceptionMessage)
protected void	processConcurrently(String sql, String updateSQL, com.liferay.petra.function.UnsafeFunction<ResultSet,Object[],Exception> unsafeFunction, com.liferay.petra.function.UnsafeBiConsumer<Object[],PreparedStatement,Exception> unsafeBiConsumer, String exceptionMessage)
protected <T> void	processConcurrently(T[] array, com.liferay.petra.function.UnsafeConsumer<T,Exception> unsafeConsumer, String exceptionMessage)
protected void	removePrimaryKey(String tableName)
void	runSQL(DBTypeToSQLMap dbTypeToSQLMap)
void	runSQL(String template)
void	runSQL(String[] templates)
void	runSQL(Connection connection, String template)
void	runSQLFile(String path)
void	runSQLFile(String path, boolean failOnError)
void	runSQLTemplate(String template, boolean failOnError)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.portal.kernel.dao.db.DBProcess

runSQLTemplate, runSQLTemplateString

Field Details

connection

protected Connection connection

Constructor Details

BaseDBProcess

public BaseDBProcess()

Method Details

runSQL

public void runSQL(Connection connection,
 String template)
            throws IOException,
SQLException

Specified by:

runSQL in interface DBProcess

Throws:

IOException

SQLException

runSQL

public void runSQL(DBTypeToSQLMap dbTypeToSQLMap)
            throws IOException,
SQLException

Specified by:

runSQL in interface DBProcess

Throws:

IOException

SQLException

runSQL

public void runSQL(String template)
            throws IOException,
SQLException

Specified by:

runSQL in interface DBProcess

Throws:

IOException

SQLException

runSQL

public void runSQL(String[] templates)
            throws IOException,
SQLException

Specified by:

runSQL in interface DBProcess

Throws:

IOException

SQLException

runSQLFile

public void runSQLFile(String path)
                throws IOException,
NamingException,
SQLException

Specified by:

runSQLFile in interface DBProcess

Throws:

IOException

NamingException

SQLException

runSQLFile

public void runSQLFile(String path,
 boolean failOnError)
                throws IOException,
NamingException,
SQLException

Specified by:

runSQLFile in interface DBProcess

Throws:

IOException

NamingException

SQLException

runSQLTemplate

public void runSQLTemplate(String template,
 boolean failOnError)
                    throws IOException,
NamingException,
SQLException

Specified by:

runSQLTemplate in interface DBProcess

Throws:

IOException

NamingException

SQLException

addIndexes

protected void addIndexes(Connection connection,
 List<IndexMetadata> indexMetadatas)
                   throws IOException,
SQLException

Throws:

IOException

SQLException

alterColumnName

protected void alterColumnName(String tableName,
 String oldColumnName,
 String newColumnDefinition)
                        throws Exception

Throws:

Exception

alterColumnType

protected void alterColumnType(String tableName,
 String columnName,
 String newColumnType)
                        throws Exception

Throws:

Exception

alterTableAddColumn

protected void alterTableAddColumn(String tableName,
 String columnName,
 String columnType)
                            throws Exception

Throws:

Exception

alterTableDropColumn

protected void alterTableDropColumn(String tableName,
 String columnName)
                             throws Exception

Throws:

Exception

alterTableName

protected void alterTableName(String tableName,
 String newTableName)
                       throws Exception

Throws:

Exception

closeConnections

protected void closeConnections()

closeConnections

protected void closeConnections(Thread thread)

doHasTable

@Deprecated
protected boolean doHasTable(String tableName)
                      throws Exception

Deprecated.

As of Cavanaugh (7.4.x), replaced by hasTable(String)

Throws:

Exception

dropIndexes

protected void dropIndexes(List<String> indexNames,
 String tableName)
                    throws Exception

Throws:

Exception

dropIndexes

protected List<IndexMetadata> dropIndexes(String tableName,
 String columnName)
                                   throws Exception

Throws:

Exception

dropTable

protected void dropTable(String tableName)
                  throws Exception

Throws:

Exception

getConnection

protected Connection getConnection()
                            throws Exception

Throws:

Exception

getPrimaryKeyColumnNames

protected String[] getPrimaryKeyColumnNames(Connection connection,
 String tableName)
                                     throws SQLException

Throws:

SQLException

hasColumn

protected boolean hasColumn(String tableName,
 String columnName)
                     throws Exception

Throws:

Exception

hasColumnType

protected boolean hasColumnType(String tableName,
 String columnName,
 String columnType)
                         throws Exception

Throws:

Exception

hasIndex

protected boolean hasIndex(String tableName,
 String indexName)
                    throws Exception

Throws:

Exception

hasRows

protected boolean hasRows(Connection connection,
 String tableName)

hasRows

protected boolean hasRows(String tableName)
                   throws Exception

Throws:

Exception

hasTable

protected boolean hasTable(String tableName)
                    throws Exception

Throws:

Exception

hasView

protected boolean hasView(String viewName)
                   throws Exception

Throws:

Exception

process

protected void process(com.liferay.petra.function.UnsafeConsumer<Long,Exception> unsafeConsumer)
                throws Exception

Throws:

Exception

processConcurrently

protected void processConcurrently(String sql,
 String updateSQL,
 com.liferay.petra.function.UnsafeFunction<ResultSet,Object[],Exception> unsafeFunction,
 com.liferay.petra.function.UnsafeBiConsumer<Object[],PreparedStatement,Exception> unsafeBiConsumer,
 String exceptionMessage)
                            throws Exception

Throws:

Exception

processConcurrently

protected void processConcurrently(String sql,
 com.liferay.petra.function.UnsafeConsumer<PreparedStatement,Exception> unsafeConsumer,
 String updateSQL,
 com.liferay.petra.function.UnsafeFunction<ResultSet,Object[],Exception> unsafeFunction,
 com.liferay.petra.function.UnsafeBiConsumer<Object[],PreparedStatement,Exception> unsafeBiConsumer,
 String exceptionMessage)
                            throws Exception

Throws:

Exception

processConcurrently

protected void processConcurrently(String sql,
 com.liferay.petra.function.UnsafeFunction<ResultSet,Object[],Exception> unsafeFunction,
 com.liferay.petra.function.UnsafeConsumer<Object[],Exception> unsafeConsumer,
 String exceptionMessage)
                            throws Exception

Throws:

Exception

processConcurrently

protected <T> void processConcurrently(T[] array,
 com.liferay.petra.function.UnsafeConsumer<T,Exception> unsafeConsumer,
 String exceptionMessage)
                                throws Exception

Throws:

Exception

removePrimaryKey

protected void removePrimaryKey(String tableName)
                         throws Exception

Throws:

Exception