com.liferay.portal.dao.db

Class BaseDB

java.lang.Object

com.liferay.portal.dao.db.BaseDB

All Implemented Interfaces:

com.liferay.portal.kernel.dao.db.DB

Direct Known Subclasses:

HypersonicDB, MySQLDB, PostgreSQLDB

public abstract class BaseDB
extends java.lang.Object
implements com.liferay.portal.kernel.dao.db.DB

Author:

Alexander Chow, Ganesh Ram, Brian Wing Shun Chan, Daniel Kocsis

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ALTER_COLUMN_NAME
protected static java.lang.String	ALTER_COLUMN_TYPE
protected static java.lang.String	ALTER_TABLE_NAME
protected static java.util.regex.Pattern	columnTypePattern
protected static java.lang.String	CREATE_TABLE
protected static java.lang.String	DROP_INDEX
protected static java.lang.String	DROP_PRIMARY_KEY
protected static java.lang.String[]	RENAME_TABLE_TEMPLATE
protected static java.lang.String[]	REWORD_TEMPLATE
protected static int[]	SQL_VARCHAR_TYPES
protected static java.lang.String[]	TEMPLATE

Fields inherited from interface com.liferay.portal.kernel.dao.db.DB

SQL_SIZE_NONE, SQL_VARCHAR_MAX_SIZE, SQL_VARCHAR_MAX_SIZE_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseDB(com.liferay.portal.kernel.dao.db.DBType dbType, int majorVersion, int minorVersion)

Method Summary

Modifier and Type	Method and Description
void	addIndexes(java.sql.Connection connection, java.util.List<com.liferay.portal.kernel.dao.db.IndexMetadata> indexMetadatas)
protected void	addPrimaryKey(java.sql.Connection connection, java.lang.String tableName, java.lang.String[] columnNames)
void	alterColumnName(java.sql.Connection connection, java.lang.String tableName, java.lang.String oldColumnName, java.lang.String newColumnDefinition)
void	alterColumnType(java.sql.Connection connection, java.lang.String tableName, java.lang.String columnName, java.lang.String newColumnType)
void	alterTableAddColumn(java.sql.Connection connection, java.lang.String tableName, java.lang.String columnName, java.lang.String columnType)
void	alterTableDropColumn(java.sql.Connection connection, java.lang.String tableName, java.lang.String columnName)
protected java.lang.String[]	buildColumnNameTokens(java.lang.String line)
protected java.lang.String[]	buildColumnTypeTokens(java.lang.String line)
abstract java.lang.String	buildSQL(java.lang.String template)
protected java.lang.String[]	buildTableNameTokens(java.lang.String line)
java.util.List<com.liferay.portal.kernel.dao.db.IndexMetadata>	dropIndexes(java.sql.Connection connection, java.lang.String tableName, java.lang.String columnName)
protected java.util.Set<java.lang.String>	dropIndexes(java.sql.Connection connection, java.lang.String tablesSQL, java.lang.String indexesSQL, java.util.List<com.liferay.portal.kernel.dao.db.Index> indexes)
com.liferay.portal.kernel.dao.db.DBType	getDBType()
java.util.List<com.liferay.portal.kernel.dao.db.Index>	getIndexes(java.sql.Connection connection)
protected java.util.List<com.liferay.portal.kernel.dao.db.IndexMetadata>	getIndexes(java.sql.Connection connection, java.lang.String tableName, java.lang.String columnName, boolean onlyUnique)
java.sql.ResultSet	getIndexResultSet(java.sql.Connection connection, java.lang.String tableName)
int	getMajorVersion()
int	getMinorVersion()
java.lang.String[]	getPrimaryKeyColumnNames(java.sql.Connection connection, java.lang.String tableName)
java.lang.Integer	getSQLType(java.lang.String templateType)
protected abstract int[]	getSQLTypes()
java.lang.Integer	getSQLVarcharSize(java.lang.String templateType)
protected int[]	getSQLVarcharSizes()
protected abstract java.lang.String[]	getTemplate()
java.lang.String	getTemplateBlob()
java.lang.String	getTemplateFalse()
java.lang.String	getTemplateTrue()
java.lang.String	getVersionString()
boolean	isSupportsAlterColumnName()
boolean	isSupportsAlterColumnType()
boolean	isSupportsInlineDistinct()
boolean	isSupportsQueryingAfterException()
boolean	isSupportsScrollableResults()
boolean	isSupportsStringCaseSensitiveQuery()
boolean	isSupportsUpdateWithInnerJoin()
protected java.lang.String	limitColumnLength(java.lang.String column, int length)
void	process(com.liferay.petra.function.UnsafeConsumer<java.lang.Long,java.lang.Exception> unsafeConsumer)
void	removePrimaryKey(java.sql.Connection connection, java.lang.String tableName)
protected java.lang.String	replaceTemplate(java.lang.String template)
protected abstract java.lang.String	reword(java.lang.String data)
void	runSQL(java.sql.Connection connection, java.lang.String sql)
void	runSQL(java.sql.Connection connection, java.lang.String[] sqls)
void	runSQL(java.lang.String sql)
void	runSQL(java.lang.String[] sqls)
void	runSQLTemplateString(java.sql.Connection connection, java.lang.String template, boolean failOnError)
void	runSQLTemplateString(java.lang.String template, boolean failOnError)
void	setSupportsStringCaseSensitiveQuery(boolean supportsStringCaseSensitiveQuery)
void	updateIndexes(java.sql.Connection connection, java.lang.String tablesSQL, java.lang.String indexesSQL, boolean dropIndexes)

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.DB

getNewUuidFunctionName, getPopulateSQL, getRecreateSQL, isSupportsNewUuidFunction, runSQL, runSQL

Field Detail

ALTER_COLUMN_NAME

protected static final java.lang.String ALTER_COLUMN_NAME

See Also:

Constant Field Values

ALTER_COLUMN_TYPE

protected static final java.lang.String ALTER_COLUMN_TYPE

See Also:

Constant Field Values

ALTER_TABLE_NAME

protected static final java.lang.String ALTER_TABLE_NAME

See Also:

Constant Field Values

CREATE_TABLE

protected static final java.lang.String CREATE_TABLE

See Also:

Constant Field Values

DROP_INDEX

protected static final java.lang.String DROP_INDEX

See Also:

Constant Field Values

DROP_PRIMARY_KEY

protected static final java.lang.String DROP_PRIMARY_KEY

See Also:

Constant Field Values

RENAME_TABLE_TEMPLATE

protected static final java.lang.String[] RENAME_TABLE_TEMPLATE

REWORD_TEMPLATE

protected static final java.lang.String[] REWORD_TEMPLATE

SQL_VARCHAR_TYPES

protected static final int[] SQL_VARCHAR_TYPES

TEMPLATE

protected static final java.lang.String[] TEMPLATE

columnTypePattern

protected static final java.util.regex.Pattern columnTypePattern

Constructor Detail

BaseDB

protected BaseDB(com.liferay.portal.kernel.dao.db.DBType dbType,
                 int majorVersion,
                 int minorVersion)

Method Detail

addIndexes

public void addIndexes(java.sql.Connection connection,
                       java.util.List<com.liferay.portal.kernel.dao.db.IndexMetadata> indexMetadatas)
                throws java.io.IOException,
                       java.sql.SQLException

Specified by:

addIndexes in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.io.IOException

java.sql.SQLException

alterColumnName

public void alterColumnName(java.sql.Connection connection,
                            java.lang.String tableName,
                            java.lang.String oldColumnName,
                            java.lang.String newColumnDefinition)
                     throws java.lang.Exception

Specified by:

alterColumnName in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.lang.Exception

alterColumnType

public void alterColumnType(java.sql.Connection connection,
                            java.lang.String tableName,
                            java.lang.String columnName,
                            java.lang.String newColumnType)
                     throws java.lang.Exception

Specified by:

alterColumnType in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.lang.Exception

alterTableAddColumn

public void alterTableAddColumn(java.sql.Connection connection,
                                java.lang.String tableName,
                                java.lang.String columnName,
                                java.lang.String columnType)
                         throws java.lang.Exception

Specified by:

alterTableAddColumn in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.lang.Exception

alterTableDropColumn

public void alterTableDropColumn(java.sql.Connection connection,
                                 java.lang.String tableName,
                                 java.lang.String columnName)
                          throws java.lang.Exception

Specified by:

alterTableDropColumn in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.lang.Exception

buildSQL

public abstract java.lang.String buildSQL(java.lang.String template)
                                   throws java.io.IOException,
                                          java.sql.SQLException

Specified by:

buildSQL in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.io.IOException

java.sql.SQLException

dropIndexes

public java.util.List<com.liferay.portal.kernel.dao.db.IndexMetadata> dropIndexes(java.sql.Connection connection,
                                                                                  java.lang.String tableName,
                                                                                  java.lang.String columnName)
                                                                           throws java.io.IOException,
                                                                                  java.sql.SQLException

Specified by:

dropIndexes in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.io.IOException

java.sql.SQLException

getDBType

public com.liferay.portal.kernel.dao.db.DBType getDBType()

Specified by:

getDBType in interface com.liferay.portal.kernel.dao.db.DB

getIndexes

public java.util.List<com.liferay.portal.kernel.dao.db.Index> getIndexes(java.sql.Connection connection)
                                                                  throws java.sql.SQLException

Specified by:

getIndexes in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.sql.SQLException

getIndexResultSet

public java.sql.ResultSet getIndexResultSet(java.sql.Connection connection,
                                            java.lang.String tableName)
                                     throws java.sql.SQLException

Specified by:

getIndexResultSet in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.sql.SQLException

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in interface com.liferay.portal.kernel.dao.db.DB

getMinorVersion

public int getMinorVersion()

Specified by:

getMinorVersion in interface com.liferay.portal.kernel.dao.db.DB

getPrimaryKeyColumnNames

public java.lang.String[] getPrimaryKeyColumnNames(java.sql.Connection connection,
                                                   java.lang.String tableName)
                                            throws java.sql.SQLException

Specified by:

getPrimaryKeyColumnNames in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.sql.SQLException

getSQLType

public java.lang.Integer getSQLType(java.lang.String templateType)

Specified by:

getSQLType in interface com.liferay.portal.kernel.dao.db.DB

getSQLVarcharSize

public java.lang.Integer getSQLVarcharSize(java.lang.String templateType)

Specified by:

getSQLVarcharSize in interface com.liferay.portal.kernel.dao.db.DB

getTemplateBlob

public java.lang.String getTemplateBlob()

Specified by:

getTemplateBlob in interface com.liferay.portal.kernel.dao.db.DB

getTemplateFalse

public java.lang.String getTemplateFalse()

Specified by:

getTemplateFalse in interface com.liferay.portal.kernel.dao.db.DB

getTemplateTrue

public java.lang.String getTemplateTrue()

Specified by:

getTemplateTrue in interface com.liferay.portal.kernel.dao.db.DB

getVersionString

public java.lang.String getVersionString()

Specified by:

getVersionString in interface com.liferay.portal.kernel.dao.db.DB

isSupportsAlterColumnName

public boolean isSupportsAlterColumnName()

Specified by:

isSupportsAlterColumnName in interface com.liferay.portal.kernel.dao.db.DB

isSupportsAlterColumnType

public boolean isSupportsAlterColumnType()

Specified by:

isSupportsAlterColumnType in interface com.liferay.portal.kernel.dao.db.DB

isSupportsInlineDistinct

public boolean isSupportsInlineDistinct()

Specified by:

isSupportsInlineDistinct in interface com.liferay.portal.kernel.dao.db.DB

isSupportsQueryingAfterException

public boolean isSupportsQueryingAfterException()

Specified by:

isSupportsQueryingAfterException in interface com.liferay.portal.kernel.dao.db.DB

isSupportsScrollableResults

public boolean isSupportsScrollableResults()

Specified by:

isSupportsScrollableResults in interface com.liferay.portal.kernel.dao.db.DB

isSupportsStringCaseSensitiveQuery

public boolean isSupportsStringCaseSensitiveQuery()

Specified by:

isSupportsStringCaseSensitiveQuery in interface com.liferay.portal.kernel.dao.db.DB

isSupportsUpdateWithInnerJoin

public boolean isSupportsUpdateWithInnerJoin()

Specified by:

isSupportsUpdateWithInnerJoin in interface com.liferay.portal.kernel.dao.db.DB

process

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

Specified by:

process in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.lang.Exception

removePrimaryKey

public void removePrimaryKey(java.sql.Connection connection,
                             java.lang.String tableName)
                      throws java.lang.Exception

Specified by:

removePrimaryKey in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.lang.Exception

runSQL

public void runSQL(java.sql.Connection connection,
                   java.lang.String sql)
            throws java.io.IOException,
                   java.sql.SQLException

Specified by:

runSQL in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.io.IOException

java.sql.SQLException

runSQL

public void runSQL(java.sql.Connection connection,
                   java.lang.String[] sqls)
            throws java.io.IOException,
                   java.sql.SQLException

Specified by:

runSQL in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.io.IOException

java.sql.SQLException

runSQL

public void runSQL(java.lang.String sql)
            throws java.io.IOException,
                   java.sql.SQLException

Specified by:

runSQL in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.io.IOException

java.sql.SQLException

runSQL

public void runSQL(java.lang.String[] sqls)
            throws java.io.IOException,
                   java.sql.SQLException

Specified by:

runSQL in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.io.IOException

java.sql.SQLException

runSQLTemplateString

public void runSQLTemplateString(java.sql.Connection connection,
                                 java.lang.String template,
                                 boolean failOnError)
                          throws java.io.IOException,
                                 javax.naming.NamingException,
                                 java.sql.SQLException

Specified by:

runSQLTemplateString in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.io.IOException

javax.naming.NamingException

java.sql.SQLException

runSQLTemplateString

public void runSQLTemplateString(java.lang.String template,
                                 boolean failOnError)
                          throws java.io.IOException,
                                 javax.naming.NamingException,
                                 java.sql.SQLException

Specified by:

runSQLTemplateString in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.io.IOException

javax.naming.NamingException

java.sql.SQLException

setSupportsStringCaseSensitiveQuery

public void setSupportsStringCaseSensitiveQuery(boolean supportsStringCaseSensitiveQuery)

Specified by:

setSupportsStringCaseSensitiveQuery in interface com.liferay.portal.kernel.dao.db.DB

updateIndexes

public void updateIndexes(java.sql.Connection connection,
                          java.lang.String tablesSQL,
                          java.lang.String indexesSQL,
                          boolean dropIndexes)
                   throws java.lang.Exception

Specified by:

updateIndexes in interface com.liferay.portal.kernel.dao.db.DB

Throws:

java.lang.Exception

addPrimaryKey

protected void addPrimaryKey(java.sql.Connection connection,
                             java.lang.String tableName,
                             java.lang.String[] columnNames)
                      throws java.io.IOException,
                             java.sql.SQLException

Throws:

java.io.IOException

java.sql.SQLException

buildColumnNameTokens

protected java.lang.String[] buildColumnNameTokens(java.lang.String line)

buildColumnTypeTokens

protected java.lang.String[] buildColumnTypeTokens(java.lang.String line)

buildTableNameTokens

protected java.lang.String[] buildTableNameTokens(java.lang.String line)

dropIndexes

protected java.util.Set<java.lang.String> dropIndexes(java.sql.Connection connection,
                                                      java.lang.String tablesSQL,
                                                      java.lang.String indexesSQL,
                                                      java.util.List<com.liferay.portal.kernel.dao.db.Index> indexes)
                                               throws java.io.IOException,
                                                      java.sql.SQLException

Throws:

java.io.IOException

java.sql.SQLException

getIndexes

protected java.util.List<com.liferay.portal.kernel.dao.db.IndexMetadata> getIndexes(java.sql.Connection connection,
                                                                                    java.lang.String tableName,
                                                                                    java.lang.String columnName,
                                                                                    boolean onlyUnique)
                                                                             throws java.sql.SQLException

Throws:

java.sql.SQLException

getSQLTypes

protected abstract int[] getSQLTypes()

getSQLVarcharSizes

protected int[] getSQLVarcharSizes()

getTemplate

protected abstract java.lang.String[] getTemplate()

limitColumnLength

protected java.lang.String limitColumnLength(java.lang.String column,
                                             int length)

replaceTemplate

protected java.lang.String replaceTemplate(java.lang.String template)

reword

protected abstract java.lang.String reword(java.lang.String data)
                                    throws java.io.IOException,
                                           java.sql.SQLException

Throws:

java.io.IOException

java.sql.SQLException