Creating a Custom Parameter Template for GaussDB Instances

Scenarios

Parameter templates store engine configurations that can be applied to one or more DB instances. In GaussDB, there are two types: default and custom parameter templates.

If you do not specify a custom parameter template when creating an instance or restoring data to a new instance, the system defaults to applying the default parameter template.

Note that its parameters are immutable. For tailored needs, you can create a custom parameter template and select it during instance creation. You can also apply a custom parameter template to existing instances. For details, see Applying a Parameter Template.

If you have already created a parameter template and want to provide most of its custom parameters and values in a new parameter template, you can replicate the template you created following the instructions provided in Replicating a Parameter Template.

Precautions

• Not all of the DB engine parameters in a custom parameter template can be changed. The parameters related to compute specifications (that is, the parameters whose default values are default) in the parameter template cannot be modified.
• A maximum of 100 GaussDB database parameter templates can be created for each project. All GaussDB engines share the parameter template quota.
• Certain parameter changes require a manual restart of the instance to take effect.
• Improper parameter settings may have unintended consequences, including reduced performance and system instability. Exercise caution when changing database parameters; always back up your data beforehand. Do not perform boundary tests within the parameter template to prevent system instability. Before applying parameter template changes to a production DB instance, you should try out these changes on a test DB instance.

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: >!<"&'=