Help Center/ GaussDB/ User Guide/ Parameter Management/ Managing Parameter Templates for GaussDB Instances
Updated on 2024-11-11 GMT+08:00
View PDF
Share

Managing Parameter Templates for GaussDB Instances

You can perform the following operations to manage GaussDB parameter templates:

  • Applying a parameter template: Modifications to parameters in a parameter template take effect for instances only after you apply this parameter template to target instances. A parameter template can be applied only to instances of the same version.
  • Replicating a parameter template: You can replicate a custom parameter template that you have created. When you have already created a parameter template and want to include most of the custom parameters and values from that template in a new parameter template, you can replicate that parameter template. You can also replicate the parameter template used by an existing instance to generate a new one for future use.
  • Comparing instance parameters with a parameter template: You can compare instance parameters with a parameter template to see the differences of parameter settings.
  • Comparing parameter templates: You can compare two default GaussDB parameter templates to see the differences between them. You can also compare two custom parameter templates.
  • Resetting a parameter template: You can reset all parameters in a parameter template you have created to their default settings.
  • Modifying the description of a parameter template: You can edit the description of a parameter template you have created.
  • Deleting a parameter template: You can create up to 100 parameter templates and delete parameter templates that are no longer used.

Procedure

Applying a Parameter Template

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and project.
  3. Click in the upper left corner of the page and choose Databases > GaussDB.
  4. On the Parameter Templates page, perform the following operations based on the type of the parameter template to be applied:

    • If you intend to apply a default parameter template to instances, click the Default Templates tab and click Apply in the Operation column of the target parameter template.
    • If you intend to apply a custom parameter template to instances, click Custom Templates and choose More > Apply in the Operation column of the target parameter template.

    A parameter template can be applied to one or more instances.

  5. In the displayed dialog box, select one or more instances to which the parameter template will be applied and click OK.
  6. After the parameter template is applied, check its application records.

    • If you intend to check the application records of a default parameter template, click the Default Templates tab and click View Application Record in the Operation column of the target parameter template.
    • If you intend to check the application records of a custom parameter template, click Custom Templates and choose More > View Application Record in the Operation column of the target parameter template.

    If the application status of an instance is Applying, it will not be displayed in the instance list when you apply a parameter template again. If you want to apply the parameter template to the same instance again, ensure that the application status is Successful.

    After the parameter template is successfully applied, if you modify parameters in the parameter template and the instance status is Parameter change. Pending reboot, you must reboot the instance for the modifications to take effect. If no parameter that requires an instance reboot is modified, the instance status remains unchanged.

Replicating a Parameter Template

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and project.
  3. Click in the upper left corner of the page and choose Databases > GaussDB.
  4. On the Parameter Templates page, click the Custom Templates tab. Locate the parameter template to be replicated and click Replicate in the Operation column.

    Alternatively, on the Instances page, click the instance name to go to the Basic Information page. In the navigation pane, choose Parameters. On the displayed page, click Replicate to generate a new parameter template for future use.

  5. In the displayed dialog box, configure required details and click OK.

    • The template name is case-sensitive and can contain 1 to 64 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.
    • The template description can contain up to 256 characters, but cannot contain carriage returns and the following special characters: >!<"&'=

    After the parameter template is replicated, a new template is generated in the list on the Custom Templates tab of the Parameter Templates page.

    • The new parameter template may not be displayed immediately. You are advised to wait for at least 5 minutes before using the new template.
    • Default parameter templates cannot be replicated, but you can create parameter templates based on them.

Comparing Instance Parameters with a Parameter Template

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and project.
  3. Click in the upper left corner of the page and choose Databases > GaussDB.
  4. On the Instances page, click the instance name to go to the Basic Information page.
  5. In the navigation pane on the left, choose Parameters.
  6. On the displayed page, click Compare to compare the parameters of the current instance.
  7. In the displayed dialog box, select a parameter template that you want to compare with parameters of the current instance and click OK.

    • If their settings are different, the parameter names and values of both parameter templates are displayed.
    • If their settings are the same, no data is displayed.

    Parameters of read replicas can be compared only for centralized (1 primary + 2 standby) instances of version V2.0-2.7.1 or later.

Comparing Parameter Templates

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and project.
  3. Click in the upper left corner of the page and choose Databases > GaussDB.
  4. On the Parameter Templates page, click Default Templates or Custom Templates. Locate a parameter template and click Compare in the Operation column.

  5. In the displayed dialog box, select a parameter template that uses the same DB engine as the target template and click OK.

    • If their settings are different, the parameter names and values of both parameter templates are displayed.
    • If their settings are the same, no data is displayed.

Resetting a Parameter Template

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and project.
  3. Click in the upper left corner of the page and choose Databases > GaussDB.
  4. On the Parameter Templates page, click the Custom Templates tab. Locate the parameter template and choose More > Reset in the Operation column

  5. Click Yes to reset all parameters to their default values.

    After you reset a parameter template, you need to view the status of the instance to which the parameter template applies in the instance list. If its status is Parameter change. Pending reboot, you must reboot the instance for the reset to take effect.

Modifying the Description of a Parameter Template

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and project.
  3. Click in the upper left corner of the page and choose Databases > GaussDB.
  4. On the Parameter Templates page, click the Custom Templates tab. Locate the parameter template and click in the Description column.

  5. Enter a new description. You can click to submit or to cancel the modification.

    • After you submit the modification, you can view the new description in the Description column.
    • The description can contain up to 256 characters, but cannot contain the following special characters: >!<"&'=

    You cannot modify the description of any default parameter template.

Deleting a Parameter Template

  • Deleted parameter templates cannot be recovered. Exercise caution when performing this operation.
  • Default parameter templates cannot be deleted.
  1. Log in to the management console.
  2. Click in the upper left corner and select a region and project.
  3. Click in the upper left corner of the page and choose Databases > GaussDB.
  4. On the Parameter Templates page, click the Custom Templates tab. Locate the parameter template to be deleted and choose More > Delete in the Operation column.

  5. Click Yes to delete it.

Parent Topic: Parameter Management