All Products
Search
Document Center

ApsaraDB RDS:Manage extensions

Last Updated:Nov 12, 2024

This topic describes how to manage the extensions of an ApsaraDB RDS for PostgreSQL instance in the ApsaraDB RDS console. You can search for, install, uninstall, and update the extensions, and apply the extensions to other databases.

Prerequisites

  • The RDS instance runs PostgreSQL 10 or later.

  • The RDS instance runs a minor engine version of 20230330 or later. For more information about how to view and update the minor engine version of an RDS instance, see Update the minor engine version.

  • The RDS instance is a primary RDS instance that uses Enterprise SSDs (ESSDs) or general ESSDs.

  • At least one privileged account and a database are created for the RDS instance. For more information about how to create a privileged account and a database, see Create a database and an account on an ApsaraDB RDS for PostgreSQL instance.

Usage notes

  • If the extension that you want to install on the RDS instance requires the preloading of the shared_preload_libraries parameter and the name of the extension is not added to the value of the shared_preload_libraries parameter, installing the extension automatically restarts the RDS instance.

    Note

    You can go to the Parameters page of the RDS instance to view the configuration of the shared_preload_libraries parameter. You can check whether the extension that you want to install on the RDS instance requires the preloading of the shared_preload_libraries parameter and whether the name of the extension is added to the value of the shared_preload_libraries parameter.

  • The GanosBase extensions and PostGIS extensions cannot be installed in the same schema.

  • If you want to install the following extensions on a database, you must use the privileged account of the database. If the account that you use is not a privileged account, the installation fails.

    ganos_geometry_topology, ganos_tiger_geocoder, postgis_tiger_geocoder, and postgis_topology

  • Uninstalling an extension may cause data loss and service interruptions. Proceed with caution.

Procedure

  1. Go to the Instances page. In the top navigation bar, select the region in which the RDS instance resides. Then, find the RDS instance and click the ID of the instance.

  2. In the left-side navigation pane, click Plug-ins.

    • On the Extension Marketplace tab, view the popular extensions.

      Find the extension that you want to install and click Install in the Actions column to install the extension to the database.

    • On the Extension Management tab, specify the name of a database whose extensions you want to manage.

      • Search for extensions

        You can use Filter by extension to search for extensions that have different features. You can select multiple features in the search box.

      • Install an extension

        On the Uninstalled Extensions tab, find the extension that you want to install and click Install in the Actions column.

        You can select multiple extensions to install them at a time.

      • Uninstall an extension

        On the Installed Extensions tab, find the extension that you want to uninstall and click Uninstall in the Actions column.

        You can select multiple extensions to uninstall them at a time.

        Important

        Uninstalling an extension may cause data loss and service interruptions. Proceed with caution.

      • Update an extension

        On the Installed Extensions tab, find the extension that you want to update and click Upgrade Version in the Actions column.

        Note

        If Upgrade Version is not displayed in the Actions column, the extension runs the latest version.

      • Apply the extensions installed on the database to another database

        On the Installed Extensions tab, click Apply to Other Databases to install the extensions that are installed on the current database on another database.

Related operations

Operation

Description

CreatePostgresExtensions

Creates an extension for a database.

Note

If the extension is not created after you successfully call this operation, check whether the extension is supported by the major engine version of the RDS instance. For more information, see Extensions supported by ApsaraDB RDS for PostgreSQL.

DescribePostgresExtensions

Queries extensions that are installed on a database.

UpdatePostgresExtensions

Updates the version of an extension on a database.

DeletePostgresExtensions

Deletes an extension from a database.