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, BaseBadColumnNamesUpgradeProcess, BaseCompanyIdUpgradeProcess, BaseDBColumnSizeUpgradeProcess, BaseExternalReferenceCodeUpgradeProcess, BaseLastPublishDateUpgradeProcess, BaseLocalizedColumnUpgradeProcess, BasePortletIdUpgradeProcess, BasePortletPreferencesUpgradeProcess, BaseRepositoryUpgradeProcess, BaseSQLServerDatetimeUpgradeProcess, BaseStagingGroupTypeSettingsUpgradeProcess, BaseThemeIdUpgradeProcess, BaseUuidUpgradeProcess, CTModelUpgradeProcess, DummyUpgradeProcess, MVCCVersionUpgradeProcess, PortalPreferencesUpgradeProcess, UpgradeModules, 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()
UpgradeProcess(java.lang.String upgradeInfo)

Method Summary

Modifier and Type	Method and Description
protected com.liferay.petra.lang.SafeCloseable	addTemporaryIndex(java.lang.String tableName, boolean unique, java.lang.String... columnNames)
void	clearIndexesCache()
protected abstract void	doUpgrade()
protected void	ensureTableExists(java.sql.DatabaseMetaData databaseMetaData, DBInspector dbInspector, java.lang.String tableName)
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 UpgradeStep[]	getPostUpgradeSteps()
protected UpgradeStep[]	getPreUpgradeSteps()
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()
UpgradeStep[]	getUpgradeSteps()
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()
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, alterTableName, doHasTable, dropIndexes, dropTable, getConnection, getPrimaryKeyColumnNames, hasColumn, hasColumnType, hasIndex, hasRows, hasRows, hasTable, process, processConcurrently, processConcurrently, processConcurrently, removePrimaryKey, runSQL, runSQL, runSQL, runSQL, runSQLTemplate, runSQLTemplate, runSQLTemplateString

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradeProcess

public UpgradeProcess()

UpgradeProcess

public UpgradeProcess(java.lang.String upgradeInfo)

Method Detail

clearIndexesCache

public void clearIndexesCache()

getThreshold

public int getThreshold()

getUpgradeSteps

public final UpgradeStep[] getUpgradeSteps()

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

addTemporaryIndex

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

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

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

getPostUpgradeSteps

protected UpgradeStep[] getPostUpgradeSteps()

getPreUpgradeSteps

protected UpgradeStep[] getPreUpgradeSteps()

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