com.liferay.portal.kernel.dao.db

Interface DB

@ProviderType
public interface DB

Author:

Brian Wing Shun Chan

Field Summary

Fields

Modifier and Type	Field and Description
static int	SQL_SIZE_NONE
static int	SQL_VARCHAR_MAX_SIZE
static int	SQL_VARCHAR_MAX_SIZE_THRESHOLD

Method Summary

Modifier and Type	Method and Description
void	addIndexes(java.sql.Connection connection, java.util.List<IndexMetadata> indexMetadatas)
void	addIndexes(java.sql.Connection connection, java.lang.String indexesSQL, java.util.Set<java.lang.String> validIndexNames) Deprecated. As of Cavanaugh (7.4.x), replaced by addIndexes(Connection, List)
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)
java.lang.String	buildSQL(java.lang.String template)
java.util.List<IndexMetadata>	dropIndexes(java.sql.Connection connection, java.lang.String tableName, java.lang.String columnName)
DBType	getDBType()
java.util.List<Index>	getIndexes(java.sql.Connection connection)
java.sql.ResultSet	getIndexResultSet(java.sql.Connection connection, java.lang.String tableName)
int	getMajorVersion()
int	getMinorVersion()
default java.lang.String	getNewUuidFunctionName()
java.lang.String	getPopulateSQL(java.lang.String databaseName, java.lang.String sqlContent)
java.lang.String[]	getPrimaryKeyColumnNames(java.sql.Connection connection, java.lang.String tableName)
java.sql.ResultSet	getPrimaryKeysResultSet(java.sql.Connection connection, java.lang.String tableName) Deprecated. As of Cavanaugh (7.4.x), replaced by getPrimaryKeyColumnNames(Connection, String)
java.lang.String	getRecreateSQL(java.lang.String databaseName)
java.lang.Integer	getSQLType(java.lang.String templateType)
java.lang.Integer	getSQLVarcharSize(java.lang.String templateType)
java.lang.String	getTemplateBlob()
java.lang.String	getTemplateFalse()
java.lang.String	getTemplateTrue()
java.lang.String	getVersionString()
boolean	isSupportsAlterColumnName()
boolean	isSupportsAlterColumnType()
boolean	isSupportsInlineDistinct()
default boolean	isSupportsNewUuidFunction()
boolean	isSupportsQueryingAfterException()
boolean	isSupportsScrollableResults()
boolean	isSupportsStringCaseSensitiveQuery()
boolean	isSupportsUpdateWithInnerJoin()
void	process(com.liferay.petra.function.UnsafeConsumer<java.lang.Long,java.lang.Exception> unsafeConsumer)
void	removePrimaryKey(java.sql.Connection connection, java.lang.String tableName)
default void	runSQL(java.sql.Connection connection, DBTypeToSQLMap dbTypeToSQLMap)
void	runSQL(java.sql.Connection connection, java.lang.String sql)
void	runSQL(java.sql.Connection connection, java.lang.String[] sqls)
default void	runSQL(DBTypeToSQLMap dbTypeToSQLMap)
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 dropStaleIndexes)

Field Detail

SQL_SIZE_NONE

static final int SQL_SIZE_NONE

See Also:

Constant Field Values

SQL_VARCHAR_MAX_SIZE

static final int SQL_VARCHAR_MAX_SIZE

See Also:

Constant Field Values

SQL_VARCHAR_MAX_SIZE_THRESHOLD

static final int SQL_VARCHAR_MAX_SIZE_THRESHOLD

See Also:

Constant Field Values

Method Detail

addIndexes

void addIndexes(java.sql.Connection connection,
                java.util.List<IndexMetadata> indexMetadatas)
         throws java.io.IOException,
                java.sql.SQLException

Throws:

java.io.IOException

java.sql.SQLException

addIndexes

@Deprecated
void addIndexes(java.sql.Connection connection,
                            java.lang.String indexesSQL,
                            java.util.Set<java.lang.String> validIndexNames)
                     throws java.io.IOException

Deprecated. As of Cavanaugh (7.4.x), replaced by addIndexes(Connection, List)

Throws:

java.io.IOException

alterColumnName

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

Throws:

java.lang.Exception

alterColumnType

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

Throws:

java.lang.Exception

alterTableAddColumn

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

Throws:

java.lang.Exception

alterTableDropColumn

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

Throws:

java.lang.Exception

buildSQL

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

Throws:

java.io.IOException

java.sql.SQLException

dropIndexes

java.util.List<IndexMetadata> dropIndexes(java.sql.Connection connection,
                                          java.lang.String tableName,
                                          java.lang.String columnName)
                                   throws java.io.IOException,
                                          java.sql.SQLException

Throws:

java.io.IOException

java.sql.SQLException

getDBType

DBType getDBType()

getIndexes

java.util.List<Index> getIndexes(java.sql.Connection connection)
                          throws java.sql.SQLException

Throws:

java.sql.SQLException

getIndexResultSet

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

Throws:

java.sql.SQLException

getMajorVersion

int getMajorVersion()

getMinorVersion

int getMinorVersion()

getNewUuidFunctionName

default java.lang.String getNewUuidFunctionName()

getPopulateSQL

java.lang.String getPopulateSQL(java.lang.String databaseName,
                                java.lang.String sqlContent)

getPrimaryKeyColumnNames

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

Throws:

java.sql.SQLException

getPrimaryKeysResultSet

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

Deprecated. As of Cavanaugh (7.4.x), replaced by getPrimaryKeyColumnNames(Connection, String)

Throws:

java.sql.SQLException

getRecreateSQL

java.lang.String getRecreateSQL(java.lang.String databaseName)

getSQLType

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

getSQLVarcharSize

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

getTemplateBlob

java.lang.String getTemplateBlob()

getTemplateFalse

java.lang.String getTemplateFalse()

getTemplateTrue

java.lang.String getTemplateTrue()

getVersionString

java.lang.String getVersionString()

isSupportsAlterColumnName

boolean isSupportsAlterColumnName()

isSupportsAlterColumnType

boolean isSupportsAlterColumnType()

isSupportsInlineDistinct

boolean isSupportsInlineDistinct()

isSupportsNewUuidFunction

default boolean isSupportsNewUuidFunction()

isSupportsQueryingAfterException

boolean isSupportsQueryingAfterException()

isSupportsScrollableResults

boolean isSupportsScrollableResults()

isSupportsStringCaseSensitiveQuery

boolean isSupportsStringCaseSensitiveQuery()

isSupportsUpdateWithInnerJoin

boolean isSupportsUpdateWithInnerJoin()

process

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

Throws:

java.lang.Exception

removePrimaryKey

void removePrimaryKey(java.sql.Connection connection,
                      java.lang.String tableName)
               throws java.io.IOException,
                      java.sql.SQLException

Throws:

java.io.IOException

java.sql.SQLException

runSQL

default void runSQL(java.sql.Connection connection,
                    DBTypeToSQLMap dbTypeToSQLMap)
             throws java.io.IOException,
                    java.sql.SQLException

Throws:

java.io.IOException

java.sql.SQLException

runSQL

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

Throws:

java.io.IOException

java.sql.SQLException

runSQL

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

Throws:

java.io.IOException

java.sql.SQLException

runSQL

default void runSQL(DBTypeToSQLMap dbTypeToSQLMap)
             throws java.io.IOException,
                    java.sql.SQLException

Throws:

java.io.IOException

java.sql.SQLException

runSQL

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

Throws:

java.io.IOException

java.sql.SQLException

runSQL

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

Throws:

java.io.IOException

java.sql.SQLException

runSQLTemplateString

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

Throws:

java.io.IOException

javax.naming.NamingException

java.sql.SQLException

runSQLTemplateString

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

Throws:

java.io.IOException

javax.naming.NamingException

java.sql.SQLException

setSupportsStringCaseSensitiveQuery

void setSupportsStringCaseSensitiveQuery(boolean supportsStringCaseSensitiveQuery)

updateIndexes

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

Throws:

java.lang.Exception