Updated on 2025-05-29 GMT+08:00

Upgrade Parameters

IsInplaceUpgrade

Parameter description: Specifies whether an upgrade is ongoing. This parameter is an upgrade parameter and cannot be modified. Only the SYSADMIN user can access the parameter.

Parameter type: Boolean.

Unit: none

Value range:

  • on: An upgrade is ongoing.
  • off: No upgrade is ongoing.

Default value: off

Setting method: This is a SUSET parameter. Set it based on instructions provided in Table 1.

Setting suggestion: This parameter can only be viewed.

Risks and impacts of improper settings: none

inplace_upgrade_next_system_object_oids

Parameter description: Specifies the OID of a new system object during the in-place upgrade. This parameter is used for upgrade and cannot be modified by users.

Parameter type: string.

Unit: none

Value range: a string

Default value: ""

Setting method: This is a SUSET parameter. Set it based on instructions provided in Table 1.

Setting suggestion: This parameter can only be viewed.

Risks and impacts of improper settings: none

om_operation_mode

Parameter description: Specifies whether the database instance is in the O&M or running state. This parameter is used for internal component interaction and cannot be used by users.

Parameter type: enumerated type.

Unit: none

Value range:

  • upgrade_system_object_mode indicates that the upgrade is in the system object update phase.
  • running_mode indicates the normal running phase of the upgrade.

Default value: running_mode

Setting method: This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Setting suggestion: Retain the default value.

Risks and impacts of improper settings: If this parameter is set to upgrade_system_object_mode, the database name cannot be renamed.

upgrade_mode

Parameter description: Specifies the upgrade mode.

Parameter type: integer.

Unit: none

Value range: 0 to 2147483647

  • 0: No upgrade is ongoing.
  • 1: A local upgrade is ongoing.
  • 2: A grayscale upgrade is ongoing.

Default value: 0

Setting method: This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Setting suggestion: This parameter is used for upgrade. You are advised not to modify it. You are advised to use the default value.

Risks and impacts of improper settings: Do not modify this parameter during the upgrade. Otherwise, the upgrade may fail and rollback cannot be performed. In non-upgrade scenarios, modifying this parameter may cause database usage errors or other unpredictable consequences.

Special case: When the gray upgrade is used, if the major version upgrade policy is selected, that is, the upgrade script needs to be executed and the binary package needs to be replaced, the value of upgrade_mode is set to 2; if the minor version upgrade policy is selected, that is, only the binary package needs to be replaced, the value of upgrade_mode is not set to 2.