org.apache.ambari.server.upgrade

Interface UpgradeCatalog

All Known Implementing Classes:

AbstractFinalUpgradeCatalog, AbstractUpgradeCatalog, FinalUpgradeCatalog, UpdateAlertScriptPaths, UpgradeCatalog251, UpgradeCatalog252, UpgradeCatalog260, UpgradeCatalog261, UpgradeCatalog262, UpgradeCatalog270, UpgradeCatalog271, UpgradeCatalog272, UpgradeCatalog274, UpgradeCatalog275, UpgradeCatalog280

public interface UpgradeCatalog

Interface for upgrading Ambari DB

Method Summary

Modifier and Type	Method and Description
String	getSourceVersion() Return latest source version that can be upgraded from.
String	getTargetVersion() Return the version that will be upgraded to
Map<String,String>	getUpgradeJsonOutput()
boolean	isFinal() Defines if Upgrade Catalog should be executed last
void	onPostUpgrade() Called after upgradeSchema() and upgradeData(), this method is used to perform any operations after the catalog has finished.
void	preUpgradeData() perform data insertion before running normal upgrade of data, requires started persist service
void	setConfigUpdatesFileName(String ambariUpgradeConfigUpdatesFileName) Set the file name, to store all config changes during upgrade
void	updateDatabaseSchemaVersion() Update schema version in the database to the Target one
void	upgradeData() perform data updates as necessary, requires started persist service
void	upgradeSchema() Run the upgrade scripts for upgrading ambari server from current version to the new version.

Method Detail

upgradeSchema

void upgradeSchema()
            throws org.apache.ambari.server.AmbariException,
                   SQLException

Run the upgrade scripts for upgrading ambari server from current version to the new version.

Throws:

org.apache.ambari.server.AmbariException

SQLException

preUpgradeData

void preUpgradeData()
             throws org.apache.ambari.server.AmbariException,
                    SQLException

perform data insertion before running normal upgrade of data, requires started persist service

Throws:

org.apache.ambari.server.AmbariException

SQLException

upgradeData

void upgradeData()
          throws org.apache.ambari.server.AmbariException,
                 SQLException

perform data updates as necessary, requires started persist service

Throws:

org.apache.ambari.server.AmbariException

SQLException

setConfigUpdatesFileName

void setConfigUpdatesFileName(String ambariUpgradeConfigUpdatesFileName)

Set the file name, to store all config changes during upgrade

Parameters:

ambariUpgradeConfigUpdatesFileName -

isFinal

boolean isFinal()

Defines if Upgrade Catalog should be executed last

Returns:

onPostUpgrade

void onPostUpgrade()
            throws org.apache.ambari.server.AmbariException,
                   SQLException

Called after upgradeSchema() and upgradeData(), this method is used to perform any operations after the catalog has finished. Usually, this is cleanup work that does not directly affect the upgrade.

Throws:

org.apache.ambari.server.AmbariException

SQLException

getTargetVersion

String getTargetVersion()

Return the version that will be upgraded to

Returns:

getSourceVersion

String getSourceVersion()

Return latest source version that can be upgraded from. Return null since no UpgradeCatalogs exist before this one.

Returns:

null : default

updateDatabaseSchemaVersion

void updateDatabaseSchemaVersion()

Update schema version in the database to the Target one

getUpgradeJsonOutput

Map<String,String> getUpgradeJsonOutput()