com.liferay.portal.kernel.upgrade

Class UpgradeProcess

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, BaseUpgradePortletId, BaseUpgradePortletPreferences, BaseUpgradeSQLServerDatetime, CTModelUpgradeProcess, DummyUpgradeProcess, MVCCVersionUpgradeProcess, PortalPreferencesUpgradeProcess, UpgradeCTModel, UpgradeMVCCVersion, 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

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(String tableName, boolean unique, String... columnNames)
void	clearIndexesCache()
protected abstract void	doUpgrade()
protected void	ensureTableExists(DatabaseMetaData databaseMetaData, DBInspector dbInspector, String tableName)
protected List<ObjectValuePair<String,IndexMetadata>>	getIndexesSQL(ClassLoader classLoader, String tableName) Deprecated. As of Athanasius (7.3.x), replaced by #getIndexSQLs(Class, String)
protected Map<String,Integer>	getTableColumnsMap(Class<?> tableClass) Deprecated. As of Cavanaugh (7.4.x), with no direct replacement
protected String	getTableName(Class<?> tableClass) Deprecated. As of Cavanaugh (7.4.x), with no direct replacement
int	getThreshold()
protected long	increment()
protected long	increment(String name)
protected long	increment(String name, int size)
protected boolean	isPortal62TableName(String tableName)
protected boolean	isSkipUpgradeProcess()
void	upgrade()
void	upgrade(DBProcessContext dbProcessContext)
void	upgrade(UpgradeProcess upgradeProcess)

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

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

Methods inherited from class 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(String tableName,
                                                            boolean unique,
                                                            String... columnNames)
                                                     throws Exception

Throws:

Exception

doUpgrade

protected abstract void doUpgrade()
                           throws Exception

Throws:

Exception

ensureTableExists

protected void ensureTableExists(DatabaseMetaData databaseMetaData,
                                 DBInspector dbInspector,
                                 String tableName)
                          throws SQLException

Throws:

SQLException

getIndexesSQL

@Deprecated
protected List<ObjectValuePair<String,IndexMetadata>> getIndexesSQL(ClassLoader classLoader,
                                                                                String tableName)
                                                                         throws IOException

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

Throws:

IOException

getTableColumnsMap

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

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

Throws:

Exception

getTableName

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

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

Throws:

Exception

increment

protected long increment()

increment

protected long increment(String name)

increment

protected long increment(String name,
                         int size)

isPortal62TableName

protected boolean isPortal62TableName(String tableName)

isSkipUpgradeProcess

protected boolean isSkipUpgradeProcess()
                                throws Exception

Throws:

Exception