com.liferay.portal.kernel.upgrade

Class UpgradeProcess

java.lang.Object

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

com.liferay.portal.kernel.upgrade.UpgradeProcess

All Implemented Interfaces:

DBProcess, UpgradeStep

Direct Known Subclasses:

BaseAdminPortletsUpgradeProcess, BaseAttachmentsUpgradeProcess, BaseBadColumnNamesUpgradeProcess, BaseCompanyIdUpgradeProcess, BaseDBColumnSizeUpgradeProcess, BaseLastPublishDateUpgradeProcess, BaseLocalizedColumnUpgradeProcess, BasePortletIdUpgradeProcess, BasePortletPreferencesUpgradeProcess, BaseRepositoryUpgradeProcess, BaseSQLServerDatetimeUpgradeProcess, BaseStagingGroupTypeSettingsUpgradeProcess, BaseThemeIdUpgradeProcess, BaseUpgradeAdminPortlets, BaseUpgradeAttachments, BaseUpgradeBadColumnNames, BaseUpgradeCompanyId, BaseUpgradeDBColumnSize, BaseUpgradeLastPublishDate, BaseUpgradeLocalizedColumn, BaseUpgradePortletId, BaseUpgradePortletPreferences, BaseUpgradeRepository, BaseUpgradeSQLServerDatetime, BaseUpgradeStagingGroupTypeSettings, BaseUpgradeThemeId, CTModelUpgradeProcess, DummyUpgradeProcess, MVCCVersionUpgradeProcess, PortalPreferencesUpgradeProcess, RenameUpgradePortalPreferences, UpgradeCTModel, UpgradeMVCCVersion, UpgradeViewCount, ViewCountUpgradeProcess

public abstract class UpgradeProcess
extends BaseDBProcess
implements UpgradeStep

Author:

Brian Wing Shun Chan, Alexander Chow

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpgradeProcess.Alterable Deprecated. As of Cavanaugh (7.4.x), with no direct replacement
class	UpgradeProcess.AlterColumnName Deprecated. As of Cavanaugh (7.4.x), replaced by BaseDBProcess.alterColumnName(String, String, String)
class	UpgradeProcess.AlterColumnType Deprecated. As of Cavanaugh (7.4.x), replaced by BaseDBProcess.alterColumnType(String, String, String)
class	UpgradeProcess.AlterTableAddColumn Deprecated. As of Cavanaugh (7.4.x), replaced by BaseDBProcess.alterTableAddColumn(String, String, String)
class	UpgradeProcess.AlterTableDropColumn Deprecated. As of Cavanaugh (7.4.x), replaced by BaseDBProcess.alterTableDropColumn(String, String)

Field Summary

Fields inherited from class com.liferay.portal.kernel.dao.db.BaseDBProcess

connection

Constructor Summary

Constructors

Constructor and Description
UpgradeProcess()

Method Summary

Modifier and Type	Method and Description
protected com.liferay.petra.lang.SafeCloseable	addTempIndex(java.lang.String tableName, boolean unique, java.lang.String... columnNames)
protected void	alter(java.lang.Class<?> tableClass, UpgradeProcess.Alterable... alterables) Deprecated. As of Cavanaugh (7.4.x), replaced by alter* methods
void	clearIndexesCache()
protected abstract void	doUpgrade()
protected void	ensureTableExists(java.sql.DatabaseMetaData databaseMetaData, DBInspector dbInspector, java.lang.String tableName)
protected java.sql.Connection	getConnection()
protected java.util.List<ObjectValuePair<java.lang.String,IndexMetadata>>	getIndexesSQL(java.lang.ClassLoader classLoader, java.lang.String tableName) Deprecated. As of Athanasius (7.3.x), replaced by getIndexSQLs(Class, String)
protected java.util.List<java.lang.String>	getIndexSQLs(java.lang.Class<?> tableClass, java.lang.String tableName) Deprecated. As of Cavanaugh (7.4.x), with no direct replacement
protected java.util.Map<java.lang.String,java.lang.Integer>	getTableColumnsMap(java.lang.Class<?> tableClass) Deprecated. As of Cavanaugh (7.4.x), with no direct replacement
protected java.lang.String	getTableName(java.lang.Class<?> tableClass) Deprecated. As of Cavanaugh (7.4.x), with no direct replacement
int	getThreshold()
protected long	increment()
protected long	increment(java.lang.String name)
protected long	increment(java.lang.String name, int size)
protected boolean	isPortal62TableName(java.lang.String tableName)
protected boolean	isSkipUpgradeProcess()
protected boolean	isSupportsAlterColumnName() Deprecated. As of Cavanaugh (7.4.x), with no direct replacement
protected boolean	isSupportsAlterColumnType() Deprecated. As of Cavanaugh (7.4.x), with no direct replacement
protected boolean	isSupportsStringCaseSensitiveQuery() Deprecated. As of Cavanaugh (7.4.x), with no direct replacement
protected boolean	isSupportsUpdateWithInnerJoin() Deprecated. As of Cavanaugh (7.4.x), with no direct replacement
protected void	updateIndexes(java.lang.Class<?> tableClass) Deprecated. As of Cavanaugh (7.4.x), replaced by addTempIndex(String, boolean, String...) ()}
void	upgrade()
void	upgrade(DBProcessContext dbProcessContext)
void	upgrade(UpgradeProcess upgradeProcess)
protected void	upgradeTable(java.lang.String tableName, java.lang.Object[][] tableColumns) Deprecated. As of Cavanaugh (7.4.x), with no direct replacement
protected void	upgradeTable(java.lang.String tableName, java.lang.Object[][] tableColumns, java.lang.String createSQL, java.lang.String[] indexesSQL, UpgradeColumn... upgradeColumns) Deprecated. As of Cavanaugh (7.4.x), with no direct replacement

Methods inherited from class com.liferay.portal.kernel.dao.db.BaseDBProcess

addIndexes, alterColumnName, alterColumnType, alterTableAddColumn, alterTableDropColumn, doHasTable, dropIndexes, getPrimaryKeyColumnNames, hasColumn, hasColumnType, hasColumnType, hasIndex, hasRows, hasRows, hasTable, process, processConcurrently, processConcurrently, removePrimaryKey, runSQL, runSQL, runSQL, runSQL, runSQLTemplate, runSQLTemplate, runSQLTemplateString, runSQLTemplateString

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradeProcess

public UpgradeProcess()

Method Detail

clearIndexesCache

public void clearIndexesCache()

getThreshold

public int getThreshold()

upgrade

public void upgrade()
             throws UpgradeException

Throws:

UpgradeException

upgrade

public void upgrade(DBProcessContext dbProcessContext)
             throws UpgradeException

Specified by:

upgrade in interface UpgradeStep

Throws:

UpgradeException

upgrade

public void upgrade(UpgradeProcess upgradeProcess)
             throws UpgradeException

Throws:

UpgradeException

addTempIndex

protected com.liferay.petra.lang.SafeCloseable addTempIndex(java.lang.String tableName,
                                                            boolean unique,
                                                            java.lang.String... columnNames)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

alter

@Deprecated
protected void alter(java.lang.Class<?> tableClass,
                                 UpgradeProcess.Alterable... alterables)
                          throws java.lang.Exception

Deprecated. As of Cavanaugh (7.4.x), replaced by alter* methods

Throws:

java.lang.Exception

doUpgrade

protected abstract void doUpgrade()
                           throws java.lang.Exception

Throws:

java.lang.Exception

ensureTableExists

protected void ensureTableExists(java.sql.DatabaseMetaData databaseMetaData,
                                 DBInspector dbInspector,
                                 java.lang.String tableName)
                          throws java.sql.SQLException

Throws:

java.sql.SQLException

getConnection

protected java.sql.Connection getConnection()
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getIndexesSQL

@Deprecated
protected java.util.List<ObjectValuePair<java.lang.String,IndexMetadata>> getIndexesSQL(java.lang.ClassLoader classLoader,
                                                                                                    java.lang.String tableName)
                                                                                             throws java.io.IOException

Deprecated. As of Athanasius (7.3.x), replaced by getIndexSQLs(Class, String)

Throws:

java.io.IOException

getIndexSQLs

@Deprecated
protected java.util.List<java.lang.String> getIndexSQLs(java.lang.Class<?> tableClass,
                                                                    java.lang.String tableName)
                                                             throws java.lang.Exception

Deprecated. As of Cavanaugh (7.4.x), with no direct replacement

Throws:

java.lang.Exception

getTableColumnsMap

@Deprecated
protected java.util.Map<java.lang.String,java.lang.Integer> getTableColumnsMap(java.lang.Class<?> tableClass)
                                                                                    throws java.lang.Exception

Deprecated. As of Cavanaugh (7.4.x), with no direct replacement

Throws:

java.lang.Exception

getTableName

@Deprecated
protected java.lang.String getTableName(java.lang.Class<?> tableClass)
                                             throws java.lang.Exception

Deprecated. As of Cavanaugh (7.4.x), with no direct replacement

Throws:

java.lang.Exception

increment

protected long increment()

increment

protected long increment(java.lang.String name)

increment

protected long increment(java.lang.String name,
                         int size)

isPortal62TableName

protected boolean isPortal62TableName(java.lang.String tableName)

isSkipUpgradeProcess

protected boolean isSkipUpgradeProcess()
                                throws java.lang.Exception

Throws:

java.lang.Exception

isSupportsAlterColumnName

@Deprecated
protected boolean isSupportsAlterColumnName()

Deprecated. As of Cavanaugh (7.4.x), with no direct replacement

isSupportsAlterColumnType

@Deprecated
protected boolean isSupportsAlterColumnType()

Deprecated. As of Cavanaugh (7.4.x), with no direct replacement

isSupportsStringCaseSensitiveQuery

@Deprecated
protected boolean isSupportsStringCaseSensitiveQuery()

Deprecated. As of Cavanaugh (7.4.x), with no direct replacement

isSupportsUpdateWithInnerJoin

@Deprecated
protected boolean isSupportsUpdateWithInnerJoin()

Deprecated. As of Cavanaugh (7.4.x), with no direct replacement

updateIndexes

@Deprecated
protected void updateIndexes(java.lang.Class<?> tableClass)
                                  throws java.lang.Exception

Deprecated. As of Cavanaugh (7.4.x), replaced by addTempIndex(String, boolean, String...) ()}

Throws:

java.lang.Exception

upgradeTable

@Deprecated
protected void upgradeTable(java.lang.String tableName,
                                        java.lang.Object[][] tableColumns)
                                 throws java.lang.Exception

Deprecated. As of Cavanaugh (7.4.x), with no direct replacement

Throws:

java.lang.Exception

upgradeTable

@Deprecated
protected void upgradeTable(java.lang.String tableName,
                                        java.lang.Object[][] tableColumns,
                                        java.lang.String createSQL,
                                        java.lang.String[] indexesSQL,
                                        UpgradeColumn... upgradeColumns)
                                 throws java.lang.Exception

Deprecated. As of Cavanaugh (7.4.x), with no direct replacement

Throws:

java.lang.Exception