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

Creating a Parameter Template for GaussDB Instances

You can use parameters in a parameter template to manage DB engine configurations. A parameter template can be applied to one or more instances.

If you create a DB instance without specifying a custom parameter template, a default parameter template is used. This default template contains DB engine defaults and system defaults based on the engine, compute specifications, and allocated storage of the instance. Default parameter templates cannot be modified, but you can create your own parameter template to change parameter settings.

Not all DB engine parameters can be changed in a custom parameter template.

If you want to use your custom parameter template, create a parameter template and select it when you create a DB instance or apply it to an existing DB instance by following the instructions provided in Applying a Parameter Template.

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 following the instructions provided in Replicating a Parameter Template.

The following are the key points you should know when using parameters in a parameter template:

  • In the Parameters page, when you change a parameter value in a parameter template and save the change, the change applies only to current instance and does not affect the other instances.
  • Some modifications take effect only after you manually reboot the DB instance.
  • Improperly setting parameters in a parameter template may have unintended adverse effects, including degraded performance and system instability. Exercise caution when changing database parameters and you need to back up data before changing parameters in a parameter template. Do not perform the boundary testing in the parameter template, or the instance will be abnormal. Before applying parameter template changes to a production DB instance, you should try out these changes on a test DB instance.

GaussDB parameter template quotas are not shared by DDS.

A maximum of 100 GaussDB database parameter templates can be created for each project. All GaussDB engines share the parameter template quota.

Procedure

  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. In the navigation pane on the left, choose Parameter Templates.
  5. On the Parameter Templates page, click Create Parameter Template.
  6. In the displayed dialog box, configure required information and click OK.

    • Select a DB engine for the parameter template.
    • The template name is case-sensitive and can contain 1 to 64 characters. Only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.
    • The template description can contain a maximum of 256 characters and cannot include carriage return characters and the following special characters: >!<"&'=

Parent Topic: Parameter Management