Manage GUC Configurations

Grand Unified Configuration (GUC) parameters are server configuration parameters for a database, used to adjust database behavior, optimize performance, and manage resources. To simplify the management of GUC parameters, the DBaaS Admin Console provides a graphical interface where you can view and modify GUC parameters.

On this page, you can:

  • Filter GUC parameters by category and scope.

  • Modify GUC parameters in batches.

  • View detailed information for GUC parameters, including descriptions, default values, and value ranges.

  • Validate the legitimacy of parameter values during modification.

  • Reset parameters to their default values.

Configuration scopes

To meet configuration requirements at different levels, the platform divides GUC parameters into three scopes:

  • Account: Global configurations at the account level. These apply to the coordinator cluster and all warehouse clusters under that account. When you configure GUC parameters for an account, these settings become the default for all newly created clusters under that account.

  • Coordinator: Configurations at the coordinator cluster level. These apply only to the coordinator cluster of the specified account.

  • Warehouse: Configurations at the warehouse cluster level. These apply only to the specified warehouse cluster.

The final postgresql.conf file that takes effect is generated based on a combination of scope levels:

  • Coordinator configuration = Initial default configuration + Account-level configuration + Coordinator-level configuration.

  • Warehouse configuration = Initial default configuration + Account-level configuration + Warehouse-level configuration.

Manage GUC parameters: a general workflow

This section provides a step-by-step guide to managing GUC parameters.

Access the GUC page

  1. Log in to the DBaaS Admin Console.

  2. In the left navigation menu, click GUC.

View GUC parameters

On the GUC page, you can view parameters for different scopes by selecting the corresponding tabs.

  1. Select a scope tab: Account, Coordinator, or Warehouse.

  2. Use the dropdown menus to select the target Organization Name and Account Name. If you selected the Warehouse scope, you also need to select a Warehouse.

  3. (Optional) In the Configuration Item search box, enter keywords (supports fuzzy search) to filter the parameter list.

  4. Click Query to view the list of GUC parameters for the selected scope.

The parameter list displays detailed information for each GUC parameter, including its name, category, data type, description, and its current and default values. This allows you to quickly understand the purpose and status of each configuration item.

Modify GUC parameters

You can modify one or more GUC parameters at a time. The platform validates the new values to ensure they are within the allowed range.

  1. In the parameter list, select the checkboxes for the parameters you want to modify.

  2. Click Batch Update.

  3. In the Batch Update dialog, you can:

    • Enter a new value for each parameter in its corresponding text field. The allowed value range is displayed below the field for reference.

    • Select the Reset checkbox to revert the parameter to its system default value.

  4. Click Confirm. The changes are saved but will not take effect until you apply them.

Validation rules

When modifying GUC parameters, the platform enforces the following validation rules:

  • Value range: Each parameter has a defined minimum and maximum value. The platform rejects values outside this range.

  • statement_mem and max_statement_mem cross-validation: The value of statement_mem must not exceed max_statement_mem. If you modify both parameters in the same batch, the platform validates the pair together. If statement_mem is greater than max_statement_mem, the update is rejected with an error.

Apply parameter changes

Modified GUC parameters are staged and must be explicitly applied to the running database cluster. Applying the changes will trigger a restart of the relevant cluster components (pods).

  1. After modifying parameters, click Reload Configuration.

  2. A confirmation dialog appears, warning you that the operation will take a few moments.

  3. Click OK to proceed. The platform will apply the new GUC values to the corresponding cluster.