PARAMETER

2023-08-01 06:02:28  Updated

Purpose

You can use this statement to modify parameters.

Note

The cluster-level parameters can be modified only in the sys tenant.

Syntax

ALTER SYSTEM [SET] parameter_name = expression [SCOPE = {MEMORY | SPFILE | BOTH}]
[COMMENT [=] 'text'][SERVER [=] 'ip:port' | ZONE [=] 'zone' | TENANT [=] 'tenant'];

Parameters

Parameter Description
parameter_name The name of the parameter to be modified.
expression The value of the parameter after modification.
COMMENT Adds a comment on the modification. This parameter is optional. We recommend that you specify this parameter.
SCOPE The effective scope of the parameter modification. Valid values:
  • MEMORY: specifies to modify only parameters in the memory, and the modification takes effect immediately. The modification becomes invalid after the server is restarted. However, no parameter supports this mode.
  • SPFILE: specifies to modify only parameters in the configuration table. The modification takes effect after the server is restarted.
  • BOTH: specifies to modify parameters in both the configuration table and the memory. The modification takes effect immediately and remains effective after the server is restarted.
The default value of SCOPE is BOTH. If SCOPE is set to BOTH or MEMORY for parameters of which the modifications do not take effect immediately, an error is returned.
SERVER Specifies to modify only a parameter of the specified server instance.
ZONE Specifies to modify the parameter for servers of the specified type in the specified cluster. If this parameter is not specified, the modification applies to servers of the specified type in all clusters.
TENANT The tenant for which you want to modify tenant-level parameters, which is the current tenant by default. This parameter is required when you modify tenant-level parameters of a specified tenant under the system tenant. For more information, see Tenant-level parameters.

Note

  • When you modify multiple parameters at a time, separate the parameters with commas (,).
  • You can use the following statement to view system parameters: SHOW PARAMETERS [LIKE 'pattern' | WHERE expr];.

Examples

  • Modify the enable_sql_audit parameter.

    obclient> SHOW PARAMETERS LIKE 'ENABLE_SQL_AUDIT';
    +------+----------+---------------+----------+------------------+-----------+-------+---------------------------------------------------------------------------------------------------------------+----------+---------+---------+-------------------+
    | zone | svr_type | svr_ip        | svr_port | name             | data_type | value | info                                                                                                          | section  | scope   | source  | edit_level        |
    +------+----------+---------------+----------+------------------+-----------+-------+---------------------------------------------------------------------------------------------------------------+----------+---------+---------+-------------------+
    | z1   | observer | xx.xx.xxx.xx1 |    xxxxx | enable_sql_audit | NULL      | True  | specifies whether SQL audit is turned on. The default value is TRUE. Value: TRUE: turned on FALSE: turned off | OBSERVER | CLUSTER | DEFAULT | DYNAMIC_EFFECTIVE |
    +------+----------+---------------+----------+------------------+-----------+-------+---------------------------------------------------------------------------------------------------------------+----------+---------+---------+-------------------+
    1 rows in set
    
    obclient> ALTER SYSTEM SET ENABLE_SQL_AUDIT = FALSE SCOPE = BOTH;
    Query OK, 0 rows affected
    
    obclient> SHOW PARAMETERS LIKE 'ENABLE_SQL_AUDIT';
    +------+----------+---------------+----------+------------------+-----------+-------+---------------------------------------------------------------------------------------------------------------+----------+---------+---------+-------------------+
    | zone | svr_type | svr_ip        | svr_port | name             | data_type | value | info                                                                                                          | section  | scope   | source  | edit_level        |
    +------+----------+---------------+----------+------------------+-----------+-------+---------------------------------------------------------------------------------------------------------------+----------+---------+---------+-------------------+
    | z1   | observer | xx.xx.xxx.xx1 |    xxxxx | enable_sql_audit | NULL      | False | specifies whether SQL audit is turned on. The default value is TRUE. Value: TRUE: turned on FALSE: turned off | OBSERVER | CLUSTER | DEFAULT | DYNAMIC_EFFECTIVE |
    +------+----------+---------------+----------+------------------+-----------+-------+---------------------------------------------------------------------------------------------------------------+----------+---------+---------+-------------------+
    1 rows in set
    
  • Modify the connection_control_max_connection_delay parameter of a specified tenant.

    obclient> SHOW PARAMETERS LIKE 'connection_control_max_connection_delay' TENANT = 'tenant';
    +-------+----------+----------------+----------+-----------------------------------------+-----------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+--------+---------+-------------------+
    | zone  | svr_type | svr_ip         | svr_port | name                                    | data_type | value      | info                                                                                                                                                         | section  | scope  | source  | edit_level        |
    +-------+----------+----------------+----------+-----------------------------------------+-----------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+--------+---------+-------------------+
    | zone1 | observer | xx.xx.xx.218   |     2882 | connection_control_max_connection_delay | NULL      | 2147483647 | The maximum delay in milliseconds for server response to failed connection attempts, if connection_control_failed_connections_threshold is greater than zero | OBSERVER | TENANT | DEFAULT | DYNAMIC_EFFECTIVE |
    +-------+----------+----------------+----------+-----------------------------------------+-----------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+--------+---------+-------------------+
    
    obclient> ALTER SYSTEM SET connection_control_max_connection_delay = 2147483646 TENANT = 'tenant';
    
    obclient> SHOW PARAMETERS LIKE 'connection_control_max_connection_delay' TENANT = 'tenant';
    +-------+----------+----------------+----------+-----------------------------------------+-----------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+--------+---------+-------------------+
    | zone  | svr_type | svr_ip         | svr_port | name                                    | data_type | value      | info                                                                                                                                                         | section  | scope  | source  | edit_level        |
    +-------+----------+----------------+----------+-----------------------------------------+-----------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+--------+---------+-------------------+
    | zone1 | observer | xx.xx.xx.218   |     2882 | connection_control_max_connection_delay | NULL      | 2147483646 | The maximum delay in milliseconds for server response to failed connection attempts, if connection_control_failed_connections_threshold is greater than zero | OBSERVER | TENANT | DEFAULT | DYNAMIC_EFFECTIVE |
    +-------+----------+----------------+----------+-----------------------------------------+-----------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+--------+---------+-------------------+
    

Contact Us