Updated on 2024-10-14 GMT+08:00

Configuration Settings Functions

Configuration setting functions are used for querying and modifying configuration parameters during running.

  • current_setting(setting_name)

    Description: Specifies the current setting.

    Return type: text

    Note: current_setting obtains the current setting of setting_name by query. It is equivalent to the SHOW statement. For example:

    1
    2
    3
    4
    5
    6
    openGauss=# SELECT current_setting('datestyle');
    
     current_setting
    -----------------
     ISO, MDY
    (1 row)
    
  • set_working_grand_version_num_manually(tmp_version)

    Description: Upgrades new features of GaussDB by switching the authorization version.

    Return type: void

  • shell_in(type)

    Description: Inputs a route for the shell type that has not yet been filled.

    Return type: void

  • shell_out(type)

    Description: Outputs a route for the shell type that has not yet been filled.

    Return type: void

  • set_config(setting_name, new_value, is_local)

    Description: Sets the parameter and returns a new value.

    Return type: text

    Note: set_config sets the parameter setting_name to new_value. If is_local is true, the new value will only apply to the current transaction. If you want the new value to apply for the current session, use false instead. The function corresponds to the SET statement.

    Example:

    1
    2
    3
    4
    5
    6
    openGauss=# SELECT set_config('log_statement_stats', 'off', false);
    
     set_config
    ------------
     off
    (1 row)