Updated on 2024-06-03 GMT+08:00

SPM

SPM_ENABLE_PLAN_CAPTURE

Parameter description: Specifies the SPM plan capture mode.

Parameter type: enumerated type

Unit: none

Value range: off, auto, manual, and store

  • off: indicates that the plan capture function is disabled.
  • auto: indicates that the automatic plan capture function is enabled. In this mode, the prerequisite for capturing an SQL plan is that the SQL plan is executed twice or more.
  • manual: indicates that the manual plan capture function is enabled. In this mode, the prerequisite for capturing an SQL plan does not need to meet the requirement that the SQL plan is executed twice or more.
  • store: The status of all plans is captured as UNACC based on the behavior of the auto option.

Default value: off

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

Setting suggestion: none

During the upgrade, the outline of the new plan is not captured regardless of whether this parameter is enabled. During the upgrade, the upgrade may be rolled back. If a new outline is stored, the outline version compatibility issue may occur after the upgrade rollback.

SPM_ENABLE_PLAN_SELECTION

Parameter description: Specifies whether to enable the SPM plan selection function.

Parameter type: Boolean.

Unit: none

Value range:

  • on: indicates that the plan selection function is enabled.
  • off: indicates that the plan selection function is disabled.

Default value: off

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

Setting suggestion: none

SPM_PLAN_CAPTURE_FILTER

Parameter description: Specifies the database and schema to be captured.

Parameter type: string

Unit: none

Value range: A maximum of 10,000 schemas can be captured, including duplicate schemas.

The parameter format is "$db1_oid:$schema1_oid, $db2_oid:$schema2_oid..", for example, "33245:56432,44321:12332,55432:65432", in which:

  • 33245:56432 indicates that the SQL plan whose DB OID is 33245 and schema OID is 56432 is to be captured.
  • 44321:12332 indicates that the SQL plan whose DB OID is 44321 and schema OID is 12332 is to be captured.
  • 55432:65432 indicates that the SQL plan whose DB OID is 55432 and schema OID is 65432 is to be captured.

Default value: an empty string, indicating that all schemas are captured during SPM plan capture and plan selection.

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

Setting suggestion: none

SPM_PLAN_GLOBAL_CACHED_SIZE

Parameter description: Specifies the size of the SPM global plan cache.

Parameter type: integer

Unit: KB

Value range: 10240 to 20971520

Default value: 1048576

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

Setting suggestion: You are advised to set this parameter for database nodes in heavy-load scenarios.

SPM_PLAN_SESSION_CACHED_SIZE

Parameter description: Specifies the size of the SPM session plan cache.

Parameter type: integer

Unit: KB

Value range: 1 to 1048576

Default value: 1024

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

Setting suggestion: You are advised to set this parameter for database nodes in heavy-load scenarios.

SPM_PLAN_CAPTURE_MAX_PLANNUM

Parameter description: Specifies the maximum number of flush plans for a single database.

Parameter type: integer

Unit: none

Value range: 1 to 1000000

Default value: 10000

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

Setting suggestion: none

SPM_PLAN_RETENTION_DAYS

Parameter description: Specifies the retention period of unused plans on disks.

Parameter type: integer.

Unit: day

Value range: 1 to 1095

Default value: 365

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

Setting suggestion: none

SPM_ENABLE_LOG_DETAIL

Parameter description: Specifies whether to enable the notice SPM key execution process when the SPM is used. This parameter is usually used together with the following two parameters to view the SPM execution process in gsql: client_min_messages=notice;logging_module='on(SPM_KEY_FLOW)'.

Parameter type: Boolean.

Unit: none

Value range:

  • on: enabled.
  • off: disabled.

Default value: off

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

Setting suggestion: none

SPM_ENABLE_BASELINE_CLEANUP

Parameter description: Specifies whether to clear baseline data periodically.

Parameter type: Boolean.

Unit: none

Value range:

  • on: The periodic baseline clearance function is enabled.
  • off: The periodic baseline clearance function is disabled.

Default value: on

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

Setting suggestion: none