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.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 java.lang.String[]	TEMPLATE

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

BARE, DEFAULT

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 con, java.lang.String indexesSQL, java.util.Set<java.lang.String> validIndexNames)
protected java.lang.String[]	buildColumnNameTokens(java.lang.String line)
protected java.lang.String[]	buildColumnTypeTokens(java.lang.String line)
void	buildCreateFile(java.lang.String sqlDir, java.lang.String databaseName) Deprecated. As of Athanasius (7.3.x), with no direct replacement
void	buildCreateFile(java.lang.String sqlDir, java.lang.String databaseName, int population) Deprecated. As of Athanasius (7.3.x), with no direct replacement
abstract java.lang.String	buildSQL(java.lang.String template)
void	buildSQLFile(java.lang.String sqlDir, java.lang.String fileName) Deprecated. As of Athanasius (7.3.x), with no direct replacement
protected java.lang.String[]	buildTableNameTokens(java.lang.String line)
protected java.util.Set<java.lang.String>	dropIndexes(java.sql.Connection con, 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)
java.sql.ResultSet	getIndexResultSet(java.sql.Connection connection, java.lang.String tableName)
int	getMajorVersion()
int	getMinorVersion()
java.sql.ResultSet	getPrimaryKeysResultSet(java.sql.Connection connection, java.lang.String tableName)
java.lang.Integer	getSQLType(java.lang.String templateType)
protected abstract int[]	getSQLTypes()
protected abstract java.lang.String[]	getTemplate()
java.lang.String	getTemplateBlob()
java.lang.String	getTemplateFalse()
java.lang.String	getTemplateTrue()
java.lang.String	getVersionString()
long	increment() Deprecated. As of Athanasius (7.3.x), replaced by CounterLocalServiceUtil.increment()
long	increment(java.lang.String name) Deprecated. As of Athanasius (7.3.x), replaced by CounterLocalServiceUtil.increment(String)
long	increment(java.lang.String name, int size) Deprecated. As of Athanasius (7.3.x), replaced by CounterLocalServiceUtil.increment(String, int)
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)
protected java.lang.String	replaceTemplate(java.lang.String template)
protected abstract java.lang.String	reword(java.lang.String data)
void	runSQL(java.sql.Connection con, java.lang.String sql)
void	runSQL(java.sql.Connection con, java.lang.String[] sqls)
void	runSQL(java.lang.String sql)
void	runSQL(java.lang.String[] sqls)
void	runSQLTemplate(java.lang.String path) Deprecated. As of Athanasius (7.3.x), replaced by DBProcess#runSQLTemplate(String)
void	runSQLTemplate(java.lang.String path, boolean failOnError) Deprecated. As of Athanasius (7.3.x), replaced by DBProcess#runSQLTemplate(String, boolean)
void	runSQLTemplateString(java.sql.Connection connection, java.lang.String template, boolean failOnError)
void	runSQLTemplateString(java.sql.Connection connection, java.lang.String template, boolean evaluate, boolean failOnError) Deprecated. As of Athanasius (7.3.x), replaced by runSQLTemplateString(Connection, String, boolean)
void	runSQLTemplateString(java.lang.String template, boolean failOnError)
void	runSQLTemplateString(java.lang.String template, boolean evaluate, boolean failOnError) Deprecated. As of Athanasius (7.3.x), replaced by runSQLTemplateString(String, boolean)
void	setSupportsStringCaseSensitiveQuery(boolean supportsStringCaseSensitiveQuery)
void	updateIndexes(java.sql.Connection con, 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

TEMPLATE

protected static final java.lang.String[] TEMPLATE

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 con,
                       java.lang.String indexesSQL,
                       java.util.Set<java.lang.String> validIndexNames)
                throws java.io.IOException

Specified by:

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

Throws:

java.io.IOException

buildCreateFile

@Deprecated
public void buildCreateFile(java.lang.String sqlDir,
                                        java.lang.String databaseName)
                                 throws java.io.IOException

Deprecated. As of Athanasius (7.3.x), with no direct replacement

Specified by:

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

Throws:

java.io.IOException

buildCreateFile

@Deprecated
public void buildCreateFile(java.lang.String sqlDir,
                                        java.lang.String databaseName,
                                        int population)
                                 throws java.io.IOException

Deprecated. As of Athanasius (7.3.x), with no direct replacement

Specified by:

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

Throws:

java.io.IOException

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

buildSQLFile

@Deprecated
public void buildSQLFile(java.lang.String sqlDir,
                                     java.lang.String fileName)
                              throws java.io.IOException

Deprecated. As of Athanasius (7.3.x), with no direct replacement

Specified by:

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

Throws:

java.io.IOException

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

getPrimaryKeysResultSet

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

Specified by:

getPrimaryKeysResultSet 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

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

increment

@Deprecated
public long increment()

Deprecated. As of Athanasius (7.3.x), replaced by CounterLocalServiceUtil.increment()

Specified by:

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

increment

@Deprecated
public long increment(java.lang.String name)

Deprecated. As of Athanasius (7.3.x), replaced by CounterLocalServiceUtil.increment(String)

Specified by:

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

increment

@Deprecated
public long increment(java.lang.String name,
                                  int size)

Deprecated. As of Athanasius (7.3.x), replaced by CounterLocalServiceUtil.increment(String, int)

Specified by:

increment 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

runSQL

public void runSQL(java.sql.Connection con,
                   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 con,
                   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

runSQLTemplate

@Deprecated
public void runSQLTemplate(java.lang.String path)
                                throws java.io.IOException,
                                       javax.naming.NamingException,
                                       java.sql.SQLException

Deprecated. As of Athanasius (7.3.x), replaced by DBProcess#runSQLTemplate(String)

Specified by:

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

Throws:

java.io.IOException

javax.naming.NamingException

java.sql.SQLException

runSQLTemplate

@Deprecated
public void runSQLTemplate(java.lang.String path,
                                       boolean failOnError)
                                throws java.io.IOException,
                                       javax.naming.NamingException,
                                       java.sql.SQLException

Deprecated. As of Athanasius (7.3.x), replaced by DBProcess#runSQLTemplate(String, boolean)

Specified by:

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

Throws:

java.io.IOException

javax.naming.NamingException

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

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

Deprecated. As of Athanasius (7.3.x), replaced by runSQLTemplateString(Connection, String, boolean)

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

runSQLTemplateString

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

Deprecated. As of Athanasius (7.3.x), replaced by runSQLTemplateString(String, boolean)

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 con,
                          java.lang.String tablesSQL,
                          java.lang.String indexesSQL,
                          boolean dropIndexes)
                   throws java.io.IOException,
                          java.sql.SQLException

Specified by:

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

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 con,
                                                      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

getSQLTypes

protected abstract int[] getSQLTypes()

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