Installing a Plug-in

Scenarios

You can install kernel plugin-ins for your GaussDB instances to enhance kernel functions. Only the PostGIS plug-in provided by Yukon is supported.

Prerequisites

The plug-in package has been uploaded to the OBS of the end tenant. For details about how to upload a plug-in package, see Uploading an Object.

Precautions

• During the installation, the instance will be rebooted, which will temporarily interrupt database services.
• Contact the third-party vendor to obtain the download URL, SHA-256 hash, and license information of the plug-in package.
• The plug-in installation requests can be submitted repeatedly. If a plug-in is installed for the first time, the license must be configured.
• After the enable_default_ustore_table parameter is set to off, the storage mode of new tables changes to Astore, but the storage mode of existing tables remains unchanged.

Constraints

• This function is available only for instances of version V2.0-8.100.0 or later.
• If the instance or node status is abnormal, the plug-in cannot be installed.
• The plug-in cannot be uninstalled after being installed.
• During plug-in installation, operations such as node repair and replacement, capacity expansion, and hot patch installation are not supported.
• Extensions can be enabled or disabled for a maximum of 200 databases in an instance and for a maximum of 10 databases at a time.
• Before using the PostGIS plug-in, check the value of the behavior_compat_options system. If the value contains allow_procedure_compile_check, proc_implicit_for_loop_variable, or proc_outparam_override, the plug-in may fail to be used. You can modify the parameter on the console. For details, see Modifying GaussDB Instance Parameters.
• Before using the PostGIS plug-in, check whether the values of enable_default_ustore_table and forbid_public_funcname_same_with_sysfunc are off. If their values are on, the plug-in cannot be used. You can change the parameter value to off on the console. For details, see Modifying GaussDB Instance Parameters.
• Currently, plug-ins cannot be installed for instances running Huawei Cloud EulerOS.
• Plug-ins cannot be installed for distributed instances.
• The PostGIS plug-in cannot be installed on primary and standby instances involved in a DR relationship.

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. On the Instances page, click the name of the target instance to go to the Basic Information page.
5. In the Configuration area, click Install Plug-in.
   Figure 1 Installing a plug-in
   

6. Select the plug-in name, enter the correct license, download URL, and SHA-256 hash, and click OK.
   Figure 2 Installing a plug-in
   

   Table 1 Parameter description

   Parameter	Description
   License	Provide the ESN for the third-party vendor to obtain the license file. The ESN is the ID of the instance where the plug-in is to be installed.
   Plug-in	Select the name of the plug-in to be installed. The default plug-in name is postgis.
   Download URL	Enter the shared object URL of the plug-in package provided in OBS. For details, see Accessing an Object Using Its URL.
   SHA-256 Hash	Enter the SHA-256 hash provided by the third-party vendor.

7. Check the installation result.

   During plug-in installation, the instance status is Installing plug-in. After the plug-in is installed, the instance status becomes Available. After the plug-in is installed, if the plug-in name is displayed in the Plugin field in the Configuration area, the plug-in is successfully installed.

   Figure 3 Checking the installation result