psdi.configure

Class ConfigDB

java.lang.Object

psdi.configure.CommonShell

psdi.configure.ConfigDB

All Implemented Interfaces:

UpgConstants

public class ConfigDB
extends CommonShell
implements UpgConstants

Database Configuration utility. Uses configuration metadata to modify the database and/or write statements to a logfile. This performs tasks such as: changing a column's datatype or length, adding user-defined columns to a table, creating new user-defined tables, defining new indexes, and defining other Maximo-specific attributes for a table or column, such as domainid and customclassname.

The -l parameter can be used for previewing the configuration process or verbose logging.

This runs independently of MXServer. MXServer should NOT be running at the same time as this program, otherwise the database may be changing at the same time that this program is trying to determine what to output.

This program is also run as part of the upgrade process, when called by Upgrade.

For tables that require being dumped to a temp table and recreated, this program does NOT reload the new base table with the original data. This is done via a separate program, RestoreFromBackup.

The commandline parameters for ConfigDB are as follows, in addition to those in the superclass CommonShell.

Parameter ID	Parameter Value	Description
-g	(none)	This is optional. It indicates that this class has been instanciated by the Upgrade.
-r	(none)	This is optional. It indicates that RestoreFromBackup will be launched immediately following ConfigDB, assuming there were no errors. Care should be taken when using this param, as there are occasions when the data in the temp tables (XX+tablename) must be modified before attempting the Restore. (The -r param will NOT launch DropBackup.)
-z	(none)	The -z parameter is used ONLY for DB2. When the -z parameter is used and this is DB2, then the logic that enables text search for all tables is not performed from ConfigDB. Instead, ConfigDB will output a script containing all the relevant commands. The script name is db2text_configdb.bat, and it is output to the same directory as the logfile. A second script, db2text_configdb.sh, is output for Unix shell script. The reason this parameter is provided is because in DB2, text search procedures cannot be initiated from a remote machine. If Maxinst is run on a different machine than the machine where the database is located, it cannot run the text search commands. They will have to be run manually by a user on the database's machine by using the script output by ConfigDB.

See Also:

CommonShell

Field Summary

Fields inherited from class psdi.configure.CommonShell

listStream

Fields inherited from interface psdi.configure.UpgConstants

DB2, doNotUpdateACTION, doNotUpdateALNDOMAIN, doNotUpdateAPPLICATIONAUTH, doNotUpdateAUTOKEY, doNotUpdateCONDITION, doNotUpdateCONTRACTPROPERTY, doNotUpdateCONTRACTTYPE, doNotUpdateCROSSOVERDOMAIN, doNotUpdateDOCTYPES, doNotUpdateLANGUAGE, doNotUpdateMAXAPPS, doNotUpdateMAXCONDDETAIL, doNotUpdateMAXCONTROLVALUE, doNotUpdateMAXDOMAIN, doNotUpdateMAXLOGAPPENDER, doNotUpdateMAXLOGGER, doNotUpdateMAXMENU, doNotUpdateMAXMESSAGES, doNotUpdateMAXMODULES, doNotUpdateMAXPROP, doNotUpdateMAXPROPVALUE, doNotUpdateMAXROLE, doNotUpdateMAXSEQUENCE, doNotUpdateMAXSERSECURITY, doNotUpdateMAXSERVICE, doNotUpdateMAXTABLEDOMAIN, doNotUpdateMAXVARS, doNotUpdateMAXVARTYPE, doNotUpdateMXCOLLAB, doNotUpdateMXCOLLABREF, doNotUpdateNUMERICDOMAIN, doNotUpdateNUMRANGEDOMAIN, doNotUpdatePORTLET, doNotUpdatePRICALC, doNotUpdateSECURITYRESTRICT, doNotUpdateSIGOPTION, doNotUpdateSYNONYMDOMAIN, doNotUpdateTAXTYPE, doNotUpdateWORKPRIORITY, doNotUpdateWORKTYPE, doNotUpdateWPEDITSETTING, messageCache, NEWONLY, OLDANDNEW, OLDONLY, ORACLE, SQLINET, SQLMICROSOFT, SQLSERVER, SYSDATATABLES, SYSTEMTABLES, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
ConfigDB() This constructor does nothing.
ConfigDB(MXServer server) This constructor accepts parameter for MXServer and sets value for mxs.

Method Summary

Modifier and Type	Method and Description
void	addMTPermissions(java.lang.String tablename, java.lang.String uniqueColumnName, MTStorageType storageType) Add MT permissions and activate row access to table if MT Enabled.
java.lang.String	addQuotes(java.lang.String value) Use this when you have to construct a Sql update statement using values from one of our maps.
void	addRowstamp(java.lang.String tablename) Add rowstamp column to table.
void	addTenantid(java.lang.String tablename, java.lang.String uniqueColumnName, MTStorageType storageType) Add tenantid column to table if MT Enabled.
int	addUniqueColumnToImportedTable(java.lang.String tablename, java.lang.String uniqueColumnName, java.lang.String sequenceName, java.util.TreeMap attrs) Add uniquecolumnname column to imported table.
void	adjustMetadata() Perform any last updates to the metadata before we start processing.
void	alterTable(java.util.HashMap objInfo) Alter a table (maxobjectcfg.changed = "A").
void	callRestoreFromBackup() Call RestoreFromBackup.
void	changingVarcharMultiplier(boolean val) This should be invoked ONLY from the VarcharMultiplier utility.
boolean	checkForBackup() If any of the following is true, an error will be generated and this method will return False.
void	configureIndexes() Add, change or drop the indexes requiring such, then recreate the metadata in maxsysindexes and maxsyskeys.
void	configureTables() Perform all the required changes to the native tables, and update the column metadata.
void	configureViews() Perform all the required changes to the views.
void	createRowstampTrigger(java.lang.String tablename) Create the rowstamp trigger.
void	createTable(java.util.HashMap objInfo) Create a table (maxobjectcfg.changed = "I").
void	disableControlTS()
void	doCommit() Execute a "commit."
void	doLastUpdates() Some miscellaneous final database updates after the bulk of the work is done.
void	doSql(java.util.ArrayList list)
void	doSql(java.util.List list) Loops through an array and calls doSql for each element.
void	doSql(java.lang.String sql) Looks at params to determine whether the execute only, log only, or both execute and log.
void	doSqlCatchReorg(java.util.AbstractList list)
void	doSqlCatchReorg(java.lang.String sql) Try to execute Sql.
void	dropTable(java.lang.String tablename) Drop a table (maxobjectcfg.changed = "R").
void	endProcessInstance() At start of endProcess, call endProcess for restoreClass.
void	endSetupInstance(java.lang.String outdir, java.lang.String outfile, java.util.HashMap params) Process -g, -z parameters, set value for upgrade and db2TextScript.
void	getMetadata() Get the new metadata for all the objects being modified.
TextSearch	getTextSearchHelper() Return instance of TextSearch.
java.util.ArrayList	getUpgradeDefaultSql(java.lang.String tablename, java.lang.String columnname) When this is the upgrade and the table is being altered (not rebuilt) and the column does not allow nulls, this gets the sql needed to provide values for this column prior to altering it to "not null."
static void	main(java.lang.String[] argv) Main.
void	process() Main processing method for this program.
void	rebuildExtensionView(java.lang.String objectName, java.lang.String tableName, boolean isView) Drop a table (maxobjectcfg.changed = "R").
void	rebuildIndexes(java.util.TreeMap indexMeta) Loop through the index metadata we already retrieved, drop the indexes, and recreate the native indexes that are not being deleted.
void	rebuildTable(java.lang.String tempTbName, java.util.HashMap objInfo) Rebuild a table (maxobjectcfg.changed = "M").
void	refreshAttributes() Refresh all the attribute metadata for all objects.
void	refreshObjects() Refresh the table metadata for the tables being changed.
void	remindUserBadTriggers() If any triggers have become uncompileable, warn the user.
void	remindUserToCheckIndexes() If any new tables were added (and they are persistent and not audit tables), remind the user to doublecheck to make sure they have indexes.
void	remindUserToRestoreData() If any tables were rebuilt (and they are persistent and not audit tables), remind the user to restore data from backup tables.
int	renumberAttributeNumber(java.lang.String objectname, java.util.TreeMap attrs) Renumber attributeno on maxattributecfg, in case we deleted any attributes.
void	setBypassTextSearchForUpgrade(boolean value) This method is provided for the Upgrade.
void	setDoReorgCheck(boolean value) This method is provided for patch scripts that call ConfigDB from AutoUpgradeTemplate and which intend to handle the final DB2 Reorg themselves (rather than doing in ConfigDB alterTable).
void	setObjectNames(java.util.HashSet objects) Called from ConfigureService when doing a non-structural configuration.
void	setSRTableExists()
void	setThrowErrorFromPrechecks(boolean value) The prechecks by default do not throw an error.
void	setUpgradeCallout(java.lang.String val) This is called from Upgrade so that upgradeCallout can determine which subdirectory contains the class files that indicate special processing for this upgrade.
void	setUserIfno(UserInfo ui)
void	showLastMessages() Some final messages to display to the person running this program.
void	showMsg(java.lang.String str) Call super, then add message in ConfigureService, if appropriate.
boolean	spaceCheck() Check for sufficient tablespace for running ConfigDB.
void	syncEauditParams() Some final "just in case" updates to make sure there's no mismatch between the eaudit parameters and the existence (or not) of the audit table.
void	updateDelta(java.sql.Connection tenantCon, int tenanatId, java.util.TreeMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> cfgAttrs, java.util.Map<java.lang.String,java.lang.Integer> lastNumbers) Calls getRemoveChanges for each storage partition in the valuelist, and executes the statements returned, with the appropriate commit and rollback logic.
void	updateMaxvars() Update maxvars DBVERSION and NUMBEROFTAXCODES
void	updateStoragePartition() Update storagepartition on maxtable and maxtablecfg, using the native value.
void	updateTenantsDelta(java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String[]>>> changedObjects, java.util.TreeMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> cfgAttrs, java.util.Map<java.lang.String,java.lang.Integer> lastNumbers) Checks to see whether a tenant is using a given column on the extension table before allowing the DA to delete the attribute through the database configuration app.
void	upgradeCallout(java.lang.String methodName, java.lang.String methodPlace, java.lang.String objectname) If this is running in Upgrade mode (called from the Upgrade program), then various points in ConfigDB provide hooks for calling specialized methods to perform any complex upgrade processing that is not supported by the regular ConfigDB logic.

Methods inherited from class psdi.configure.CommonShell

createOutfile, doCall, doDB2TextSearchCall, doSql, doSql, doWait, endProcess, endSetup, execRuntime, getDisplayMessage, getDisplayMessage, getOutfile, getOutstream, getProperty, getRootDirName, logSql, reformatForDB2, reformatForSqlsvr, setConnection, setDB2TextOutput, setup, setupFromPropfile, setupInstance, setupNested, setupNestedInstance, setUserLangCode, showMXException, showMXException

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigDB

public ConfigDB()

This constructor does nothing. Used when running from the DOS prompt.

ConfigDB

public ConfigDB(MXServer server)

This constructor accepts parameter for MXServer and sets value for mxs. Used when invoked from the Config application.

Method Detail

disableControlTS

public void disableControlTS()

setUpgradeCallout

public void setUpgradeCallout(java.lang.String val)

This is called from Upgrade so that upgradeCallout can determine which subdirectory contains the class files that indicate special processing for this upgrade. Sets value of calloutSubdir.

process

public void process()
             throws java.lang.Exception

Main processing method for this program. If checkForBackup returns False, then this method returns without configuring the database.

Specified by:

process in class CommonShell

Throws:

java.lang.Exception

See Also:

checkForBackup(), TextSearch.stopTextSearchJobs(boolean, boolean), Util.setConfigInProcess(boolean), adjustMetadata(), spaceCheck(), getMetadata(), configureTables(), configureViews(), refreshAttributes(), refreshObjects(), configureIndexes(), doLastUpdates(), TextSearch.restartTextJobs(), showLastMessages()

setObjectNames

public void setObjectNames(java.util.HashSet objects)

Called from ConfigureService when doing a non-structural configuration. The list of objects will be used when reloading metadata so we don't reload the entire data dictionary.

Parameters:

objects - Object names to be configured

See Also:

ConfigureService.ConfigDBThread.run()

setSRTableExists

public void setSRTableExists()
                      throws java.lang.Exception

Throws:

java.lang.Exception

checkForBackup

public boolean checkForBackup()
                       throws java.lang.Exception

If any of the following is true, an error will be generated and this method will return False.

1. There is nothing to configure (based on maxtablecfg changed).
2. Any tables have not had their data restored from a previous run of ConfigDB.
3. Any old backup tables still remain on the database.
4. The CONFIGURING maxvar is True (someone is using the Config UI).

Returns:

True if everything is OK and processing can proceed, False if ConfigDB should not continue.

Throws:

java.lang.Exception

See Also:

Util.getUnrestoredTables(java.lang.String), Util.getOldBackupTables(java.lang.String), Util.mxServerIsUp(java.lang.String)

adjustMetadata

public void adjustMetadata()
                    throws java.lang.Exception

Perform any last updates to the metadata before we start processing. This includes the following:

1. Clean out any native statistics that have the same name as an index defined in maxsysindexes via cleanStatisticNames.
2. For any user-defined objects being added that are not SYSTEM level, identify the key attribute and set maxattributecfg canautonum to True.

Throws:

java.lang.Exception

See Also:

Util.getKeyAttribute(java.lang.String, java.lang.String)

spaceCheck

public boolean spaceCheck()
                   throws java.lang.Exception

Check for sufficient tablespace for running ConfigDB.

Returns:

True if enough space, else False.

Throws:

java.lang.Exception

See Also:

Util.spaceCheckForDBConfig()

getMetadata

public void getMetadata()
                 throws java.lang.Exception

Get the new metadata for all the objects being modified. Updates global variables cfgObjects and cfgIndexes.

Throws:

java.lang.Exception

See Also:

Util.getObjectMeta(java.lang.String, boolean, boolean, boolean, boolean, boolean, boolean, boolean), Util.getIndexMeta(java.lang.String, boolean)

configureTables

public void configureTables()
                     throws java.lang.Exception

Perform all the required changes to the native tables, and update the column metadata. These changes are committed.

upgradeCallout is called in the following places:

• At the beginning of the method ("configureTables", "01", null)
• At the end, just before the commit ("configureTables", "02", null)

Throws:

java.lang.Exception

See Also:

dropTable(java.lang.String), createTable(java.util.HashMap), rebuildTable(java.lang.String, java.util.HashMap), alterTable(java.util.HashMap), TextSearch.adjustTextSearchOneTable(java.util.HashMap)

rebuildExtensionView

public void rebuildExtensionView(java.lang.String objectName,
                                 java.lang.String tableName,
                                 boolean isView)
                          throws java.lang.Exception

Drop a table (maxobjectcfg.changed = "R").

upgradeCallout is called in the following place:

• At the beginning of the method ("dropTable", null, tbname)

Parameters:

tablename - Table name

Throws:

java.lang.Exception

dropTable

public void dropTable(java.lang.String tablename)
               throws java.lang.Exception

Drop a table (maxobjectcfg.changed = "R").

upgradeCallout is called in the following place:

• At the beginning of the method ("dropTable", null, tbname)

Parameters:

tablename - Table name

Throws:

java.lang.Exception

createTable

public void createTable(java.util.HashMap objInfo)
                 throws java.lang.Exception

Create a table (maxobjectcfg.changed = "I").

upgradeCallout is called in the following places:

• At the beginning of the method ("createTable", "01", tbname)
• At the end of the method ("createTable", "02", tbname)

Parameters:

objInfo - Configuration parameters for the table and its columns.

Throws:

java.lang.Exception

See Also:

Util.buildCreateTableStatement(java.util.HashMap, boolean, boolean, java.lang.String, boolean), Util.getUniqueIndexSpace(java.lang.String, java.lang.String), createRowstampTrigger(java.lang.String), addRowstamp(java.lang.String), Util.indexMetaExistsForPrikeycolseq(java.lang.String, java.lang.String, boolean), Util.buildIndexStatement(String, TreeMap, String), updatePrimaryKeyNameForDB2(java.lang.String, java.lang.String, java.lang.String, com.ibm.tivoli.maximo.dbmanage.connection.MTStorageType)

addRowstamp

public void addRowstamp(java.lang.String tablename)
                 throws java.lang.Exception

Add rowstamp column to table. Do the following:

1. Add the rowstamp column to the table.
2. If this is Oracle, add the rowstamp trigger.
3. Force the rowstamp to be populated.
4. If this is Oracle, alter table so rowstamp column does not allow nulls.

Throws:

java.lang.Exception

See Also:

Util.getAddRowstampSql(java.lang.String), createRowstampTrigger(java.lang.String)

addTenantid

public void addTenantid(java.lang.String tablename,
                        java.lang.String uniqueColumnName,
                        MTStorageType storageType)
                 throws java.lang.Exception

Add tenantid column to table if MT Enabled. Do the following:

1. Add the tenantid column to the table if DB2.

Throws:

java.lang.Exception

See Also:

Util.enableForMultiTenancy(java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.ibm.tivoli.maximo.dbmanage.connection.MTStorageType), #enableForMultiTenancy, This is a similar method.

addUniqueColumnToImportedTable

public int addUniqueColumnToImportedTable(java.lang.String tablename,
                                          java.lang.String uniqueColumnName,
                                          java.lang.String sequenceName,
                                          java.util.TreeMap attrs)
                                   throws java.lang.Exception

Add uniquecolumnname column to imported table.

Parameters:

tablename -

uniqueColumnName -

sequenceName -

attrs -

Returns:

The last sequence number assigned to this column. If there was any kind of problem, this will return a value less than zero.

Throws:

java.lang.Exception

createRowstampTrigger

public void createRowstampTrigger(java.lang.String tablename)
                           throws java.lang.Exception

Create the rowstamp trigger. (If this is SqlServer, this returns without doing anything.)

Throws:

java.lang.Exception

See Also:

Util.getRowstampTriggerSql(java.lang.String, boolean)

rebuildTable

public void rebuildTable(java.lang.String tempTbName,
                         java.util.HashMap objInfo)
                  throws java.lang.Exception

Rebuild a table (maxobjectcfg.changed = "M"). Do the following:

1. Save all the grant info for use later in this method.
2. Drop the temp table if it already exists.
3. Disable all triggers on the base table.
4. Dump the table out to a temp table. The values on the temp table may be updated if a) they are null and are being changed to "not null" and have a defaultvalue, or b) they are strings that are being shortened.
5. Drop and recreate the base table using new configuration parameters.
6. Reapply grants.
7. Rebuild native indexes and reload index metadata for this table.
8. Update "restoredata" to Yes.

The new Maximo table is NOT loaded with data in this program. The data loading is done via the program RestoreFromBackup.

upgradeCallout is called in the following places:

• At the beginning of the method ("rebuildTable", "01", tbname)
• After renaming the table to "XX" + tbname, before doing updates for non-nullable and shortened fields ("rebuildTable", "02", tbname)
• After doing updates for non-nullable and shortened fields, before grants, etc. on the new empty table ("rebuildTable", "03", tbname)

Parameters:

tempTbName - The name of the temporary table that will store the data from the base table during the rebuild process. This should equals "XX" + the base table name. This temp table is dropped, created and loaded via this method, but is not dropped afterward.

objInfo - Configuration parameters for the table and its columns.

Throws:

java.lang.Exception

See Also:

Util.getDropStatisticsStatementsForConfig(java.lang.String), Util.getStorageClause(java.lang.String, boolean), Util.buildGrants(java.lang.String, boolean, boolean), Util.getColumnNames(java.util.TreeMap, boolean, boolean), Util.nativeTableExists(java.lang.String), Util.getDisableTriggerStatement(java.lang.String, java.lang.String), Util.getRenameTableStatement(java.lang.String, java.lang.String), Util.buildDefaultDataStatement(java.lang.String, java.util.TreeMap, java.lang.String, java.util.TreeMap<java.lang.String, java.util.HashMap<java.lang.String, java.lang.String>>), Util.buildShortenStringStatement(java.lang.String, java.util.TreeMap, java.util.TreeMap), Util.buildChangeCaseStatement(String, TreeMap, TreeMap), Util.buildCreateTableStatement(java.util.HashMap, boolean, boolean, java.lang.String, boolean), Util.getUniqueIndexSpace(java.lang.String, java.lang.String), Util.getIndexMeta(java.lang.String, boolean), createRowstampTrigger(java.lang.String), updatePrimaryKeyNameForDB2(java.lang.String, java.lang.String, java.lang.String, com.ibm.tivoli.maximo.dbmanage.connection.MTStorageType), rebuildIndexes(java.util.TreeMap), Util.getSysIndexRefresh(java.lang.String, java.lang.String)

changingVarcharMultiplier

public void changingVarcharMultiplier(boolean val)

This should be invoked ONLY from the VarcharMultiplier utility.

Parameters:

val -

alterTable

public void alterTable(java.util.HashMap objInfo)
                throws java.lang.Exception

Alter a table (maxobjectcfg.changed = "A"). This includes updating the column where a default value exists and the current value is null, and then performing an "alter table" for the column. For a column to be processed in this method, the column must be persistent and have changed = "A","I", or "R". This method processes changed="Y" only in the case maxtype changing to lower or upper case.

upgradeCallout is called in the following place:

• At the beginning of the method ("alterTable", "01", tbname).
• When adding a column or changing a column to "not null", then before calling buildDefaultDataStatement, this method calls (in the calloutSubdir) UpgradeDefaults + tbname, which (if it exists) must be an extension of UpgDefaultsTemplate.
• After calling buildDefaultDataStatement ("alterTable", "02", tbname).

Parameters:

objInfo - Configuration parameters for the table and its columns.

Throws:

java.lang.Exception

See Also:

getUpgradeDefaultSql(java.lang.String, java.lang.String), Util.buildDefaultDataStatement(String, HashMap, HashMap), Util.buildChangeCaseStatement(String, String, String, String), Util.buildColumnLine(HashMap, boolean, boolean, boolean)

addMTPermissions

public void addMTPermissions(java.lang.String tablename,
                             java.lang.String uniqueColumnName,
                             MTStorageType storageType)
                      throws java.lang.Exception

Add MT permissions and activate row access to table if MT Enabled. Do the following:

1. Create permission rules and Activate row access to a table

Throws:

java.lang.Exception

See Also:

Util.createPermission(java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.ibm.tivoli.maximo.dbmanage.connection.MTStorageType)

getUpgradeDefaultSql

public java.util.ArrayList getUpgradeDefaultSql(java.lang.String tablename,
                                                java.lang.String columnname)
                                         throws java.lang.Exception

When this is the upgrade and the table is being altered (not rebuilt) and the column does not allow nulls, this gets the sql needed to provide values for this column prior to altering it to "not null."

This is determined by the presence of an extension of UpgDefaultsTemplate in the calloutSubdir, which returns Sql via getDefaultSql.

This is called from alterTable.

Parameters:

tablename - Table name

columnname - Column

Returns:

Sql statement(s). If this is not the upgrade, it returns an empty list.

Throws:

java.lang.Exception

refreshAttributes

public void refreshAttributes()
                       throws java.lang.Exception

Refresh all the attribute metadata for all objects.

1. Delete from maxattributecfg for the attributes that are being deleted.
2. Renumber colno on maxattributecfg where needed.
3. Delete all the current metadata in maxattribute.
4. Insert new data in maxattribute, using the values from maxattributecfg.
5. Update maxattributecfg to set changed = "N".

upgradeCallout is called in the following place:

• At the beginning of the method ("refreshAttributes", null, null)

Throws:

java.lang.Exception

See Also:

renumberAttributeNumber(java.lang.String, java.util.TreeMap), Util.getAttributeRefresh(), Util.getViewColumnRefresh()

updateTenantsDelta

public void updateTenantsDelta(java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String[]>>> changedObjects,
                               java.util.TreeMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> cfgAttrs,
                               java.util.Map<java.lang.String,java.lang.Integer> lastNumbers)
                        throws java.lang.Exception

Checks to see whether a tenant is using a given column on the extension table before allowing the DA to delete the attribute through the database configuration app.

Parameters:

attributeName -

objectName -

Throws:

MXException

java.rmi.RemoteException

java.lang.Exception

updateDelta

public void updateDelta(java.sql.Connection tenantCon,
                        int tenanatId,
                        java.util.TreeMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> cfgAttrs,
                        java.util.Map<java.lang.String,java.lang.Integer> lastNumbers)
                 throws MXException,
                        java.rmi.RemoteException

Calls getRemoveChanges for each storage partition in the valuelist, and executes the statements returned, with the appropriate commit and rollback logic.

Throws:

"configure" - "RemoveChangesFailure"

MXException

java.rmi.RemoteException

See Also:

Util.getRemoveChanges(), Util.rebuildMetadataSequences()

renumberAttributeNumber

public int renumberAttributeNumber(java.lang.String objectname,
                                   java.util.TreeMap attrs)
                            throws java.lang.Exception

Renumber attributeno on maxattributecfg, in case we deleted any attributes. This assumes that you have already deleted from maxattributecfg for the attributes being deleted.

Parameters:

objectname - Object name

attrs - Attributes, key = attributeno.

Throws:

java.lang.Exception

configureViews

public void configureViews()
                    throws java.lang.Exception

Perform all the required changes to the views.

upgradeCallout is called in the following place:

• At the beginning of the method ("configureViews", null, null)

Throws:

java.lang.Exception

See Also:

Util.buildCreateViewStatement(java.util.HashMap, boolean, boolean)

refreshObjects

public void refreshObjects()
                    throws java.lang.Exception

Refresh the table metadata for the tables being changed.

1. Delete all rows from maxtable.
2. Delete from maxtablecfg where changed = "R".
3. Set maxtablecfg changed = "N".
4. Reload maxtable, using the values specified on maxtablecfg, and changed = "N".
5. Additional updates when dropping a table (changed = "R"): Delete from various tables that reference the table being dropped (maxsysindexes, maxsyskeys, etc.).

upgradeCallout is called in the following place:

• At the beginning of the method ("refreshObjects", null, null)

Throws:

java.lang.Exception

See Also:

Util.getObjectRefresh(), Util.getTableRefresh(), Util.getViewRefresh()

configureIndexes

public void configureIndexes()
                      throws java.lang.Exception

Add, change or drop the indexes requiring such, then recreate the metadata in maxsysindexes and maxsyskeys. These changes are committed.

This affects only those indexes that were marked for changes via the metadata. It does not completely reload all the metadata, as Centura used to.

upgradeCallout is called in the following places:

• At the beginning of the method ("configureIndexes", "01", null)
• After calling rebuildIndexes, before rebuilding the metadata ("configureIndexes", "02", null)

Throws:

java.lang.Exception

See Also:

rebuildIndexes(java.util.TreeMap), Util.getSysIndexRefresh(java.lang.String, java.lang.String)

rebuildIndexes

public void rebuildIndexes(java.util.TreeMap indexMeta)
                    throws java.lang.Exception

Loop through the index metadata we already retrieved, drop the indexes, and recreate the native indexes that are not being deleted. Adjust primarykeycolseq in the column metadata where needed.

Parameters:

indexMeta - Index metadata, from getIndexMeta.

Throws:

java.lang.Exception

See Also:

Util.rebuildIndexes(java.util.TreeMap, boolean, boolean, boolean, boolean), Util.adjustPrimaryKeyColSeq(java.util.TreeMap)

doLastUpdates

public void doLastUpdates()
                   throws java.lang.Exception

Some miscellaneous final database updates after the bulk of the work is done.

upgradeCallout is called in the following place:

• At the beginning of the method ("doLastUpdates", null, null)

Throws:

java.lang.Exception

See Also:

updateStoragePartition(), Util.getDisallowPageLocks(), Util.rebuildMetadataSequences(), syncEauditParams(), updateMaxvars()

updateStoragePartition

public void updateStoragePartition()
                            throws java.lang.Exception

Update storagepartition on maxtable and maxtablecfg, using the native value.

Throws:

java.lang.Exception

See Also:

Util.getPartitionRefresh()

syncEauditParams

public void syncEauditParams()
                      throws java.lang.Exception

Some final "just in case" updates to make sure there's no mismatch between the eaudit parameters and the existence (or not) of the audit table.

Throws:

java.lang.Exception

updateMaxvars

public void updateMaxvars()
                   throws java.lang.Exception

Update maxvars DBVERSION and NUMBEROFTAXCODES

Throws:

java.lang.Exception

showLastMessages

public void showLastMessages()
                      throws java.lang.Exception

Some final messages to display to the person running this program.

Throws:

java.lang.Exception

See Also:

remindUserToCheckIndexes(), remindUserBadTriggers(), remindUserToRestoreData()

remindUserToCheckIndexes

public void remindUserToCheckIndexes()
                              throws java.lang.Exception

If any new tables were added (and they are persistent and not audit tables), remind the user to doublecheck to make sure they have indexes. We cannot be certain that they specified primarykeycolseq when they defined the table.

Throws:

java.lang.Exception

remindUserBadTriggers

public void remindUserBadTriggers()
                           throws java.lang.Exception

If any triggers have become uncompileable, warn the user.

Throws:

java.lang.Exception

See Also:

badTriggers

remindUserToRestoreData

public void remindUserToRestoreData()
                             throws java.lang.Exception

If any tables were rebuilt (and they are persistent and not audit tables), remind the user to restore data from backup tables.

Throws:

java.lang.Exception

callRestoreFromBackup

public void callRestoreFromBackup()
                           throws java.lang.Exception

Call RestoreFromBackup. This should be called only if the "launchRestore" parameter is True.

Throws:

java.lang.Exception

See Also:

RestoreFromBackup.process()

addQuotes

public java.lang.String addQuotes(java.lang.String value)

Use this when you have to construct a Sql update statement using values from one of our maps.

Parameters:

value - The value of a String attribute.

Returns:

The string to use in the Update statement. This will equal either the input string surrounded by single quotes, or the word "null" (without quotes).

See Also:

Util.singleToDoubleQuotes(java.lang.String)

doCommit

public void doCommit()
              throws java.lang.Exception

Execute a "commit."

Throws:

java.lang.Exception

doSql

public void doSql(java.util.ArrayList list)
           throws java.lang.Exception

Throws:

java.lang.Exception

doSql

public void doSql(java.util.List list)
           throws java.lang.Exception

Description copied from class: CommonShell

Loops through an array and calls doSql for each element.

Overrides:

doSql in class CommonShell

Parameters:

list - Any instance or extension of AbstractList, including ArrayList, etc.

Throws:

java.lang.Exception

See Also:

CommonShell.doSql(String)

doSql

public void doSql(java.lang.String sql)
           throws java.lang.Exception

Description copied from class: CommonShell

Looks at params to determine whether the execute only, log only, or both execute and log.

Overrides:

doSql in class CommonShell

Parameters:

sql - The Sql statement

Throws:

java.lang.Exception

doSqlCatchReorg

public void doSqlCatchReorg(java.util.AbstractList list)
                     throws java.lang.Exception

Throws:

java.lang.Exception

See Also:

doSqlCatchReorg(String)

doSqlCatchReorg

public void doSqlCatchReorg(java.lang.String sql)
                     throws java.lang.Exception

Try to execute Sql. If error is returned and this is DB2, and if the error indicates that the table needs a Reorg, then execute a Reorg, then retry the original sql.

Throws:

java.lang.Exception

showMsg

public void showMsg(java.lang.String str)

Call super, then add message in ConfigureService, if appropriate.

Overrides:

showMsg in class CommonShell

Parameters:

str - The one-line message to be displayed.

See Also:

ConfigureService.addConfigMsg(java.lang.String)

setBypassTextSearchForUpgrade

public void setBypassTextSearchForUpgrade(boolean value)

This method is provided for the Upgrade. It should not be called from anywhere else.

Parameters:

value - True to bypass native text search commands, False to perform them normally.

See Also:

bypassTextSearchForUpgrade

setDoReorgCheck

public void setDoReorgCheck(boolean value)

This method is provided for patch scripts that call ConfigDB from AutoUpgradeTemplate and which intend to handle the final DB2 Reorg themselves (rather than doing in ConfigDB alterTable). If this flag is set to false then the calling routine has to execute the relevant processes: isReorgPending , reorgTable, revalidateTextSearchIndexes, adjustTextSearchOneTable. For reference, see end of the alterTable method.

getTextSearchHelper

public TextSearch getTextSearchHelper()

Return instance of TextSearch.

upgradeCallout

public void upgradeCallout(java.lang.String methodName,
                           java.lang.String methodPlace,
                           java.lang.String objectname)
                    throws java.lang.Exception

If this is running in Upgrade mode (called from the Upgrade program), then various points in ConfigDB provide hooks for calling specialized methods to perform any complex upgrade processing that is not supported by the regular ConfigDB logic. Each of these hooks is identified by the method it is called from and the table name currently being processed (if any).

The name of the class being called is "UpgCdb" + methodName + methodPlace + tbname. For example, if this is called from method rebuildTable, place 01, table Item, then the name of this class would be:
UpgCdbRebuildTable01ITEM

The subdirectory containing these classes is identified by calloutSubdir.

The class should be extended from UpgTemplate. If the class is not found, there is no error. If the class needs to exit the configuration process, it should throw an error.

Parameters:

methodName - The name of the method that is invoking this hook. Required.

methodPlace - If the method provides more than one hook, each hook needs an identifier. If the method provides only one hook, this will be null.

objectname - The object name currently being processed. If object name is not relevant to the calling method, this will be null.

Throws:

java.lang.Exception

See Also:

UpgTemplate

setThrowErrorFromPrechecks

public void setThrowErrorFromPrechecks(boolean value)
                                throws java.lang.Exception

The prechecks by default do not throw an error. However, if you need an error (for example, from UpdateDB / AutoUpgradeTemplate), use this method and set value to True.

Parameters:

value -

Throws:

java.lang.Exception

endSetupInstance

public void endSetupInstance(java.lang.String outdir,
                             java.lang.String outfile,
                             java.util.HashMap params)
                      throws java.lang.Exception

Process -g, -z parameters, set value for upgrade and db2TextScript.

Overrides:

endSetupInstance in class CommonShell

Parameters:

outdir - Not used.

outfile - Not used.

params - Parameters (see class javadocs).

Throws:

java.lang.Exception

endProcessInstance

public void endProcessInstance()
                        throws java.lang.Exception

At start of endProcess, call endProcess for restoreClass.

Overrides:

endProcessInstance in class CommonShell

Throws:

java.lang.Exception

setUserIfno

public void setUserIfno(UserInfo ui)

main

public static void main(java.lang.String[] argv)

Main.

See Also:

CommonShell.setup(java.util.HashMap), process(), CommonShell.endProcess(boolean)