All Products
Search
Document Center

ApsaraDB RDS:Create an ApsaraDB RDS for PostgreSQL instance for which Babelfish is enabled

Last Updated:Feb 08, 2024

This topic describes how to create an ApsaraDB RDS for PostgreSQL instance for which Babelfish is enabled.

Usage notes

Important

The Babelfish feature for ApsaraDB RDS for PostgreSQL instances is available for only users in whitelists. If you want to use this feature, contact Alibaba Cloud.

  • You can enable Babelfish for an ApsaraDB RDS for PostgreSQL instance only when you create the RDS instance. The RDS instance must use the following parameter settings:

    • Database Engine: PostgreSQL 13, 14, or 15.

    • Product Type: Standard.

  • You cannot enable Babelfish for existing RDS instances.

  • You cannot disable Babelfish after it is enabled.

  • After the RDS instance is created, the babelfish_db database is created. The babelfish_db database is the key database of the RDS instance for which Babelfish is enabled. We recommend that you do not delete the database. If you delete the database, the RDS instance becomes unavailable.

Enable Babelfish for an RDS instance

  1. Log on to the ApsaraDB RDS console. In the left-side navigation pane, click Instances. In the top navigation bar, select the region in which your RDS instance resides.
  2. Click Create Instance to go to the ApsaraDB RDS buy page.

  3. Configure the parameters.

    This section describes the key parameters that are used to enable Babelfish for an RDS instance when you create the instance. You must configure the other parameters in the same manner as you configure the parameters for a regular RDS instance. For more information, see Create an ApsaraDB RDS for PostgreSQL instance.

    The following table describes the key parameters.

    Parameter

    Description

    Database Engine

    The database engine of the RDS instance. Set the value to PostgreSQL 13, PostgreSQL 14, or PostgreSQL 15.

    After you configure this parameter, select Enable Babelfish. 启用Babelfish

    Instance Type

    The instance type of the RDS instance. The ApsaraDB RDS console displays the available instance types.

    Babelfish Migration Mode

    The migration mode after you enable Babelfish. This parameter takes effect only when you select Enable Babelfish in the Basic Configurations step.

    • single-db: You can create only one SQL Server database on an RDS instance for which Babelfish is enabled and create a standard PostgreSQL schema for the database.

    • multi-db: You can create multiple SQL Server databases and create different PostgreSQL schemas for the databases. You must name the schemas in the <Database name>_<Schema name> format to prevent name conflicts.

    For more information about how to select a migration mode, see Migration modes.

    Initial Account

    The username of the management account that can be used to manage Babelfish or PostgreSQL.

    Important

    This account is a privileged account. You cannot delete the account after it is created.

    The username must meet the following requirements:

    • It must be 2 to 63 characters in length.

    • It can contain lowercase letters, digits, and underscores (_).

    • It must start with a lowercase letter and end with a lowercase letter or a digit.

    • It cannot start with pg.

    • It cannot contain SQL keywords. For more information, see SQL Keywords.

    Password

    The password of the management account.

    Note

    You can change the password after the RDS instance is created. For more information, see Reset the password of an account.

    The password must meet the following requirements:

    • It must be 8 to 32 characters in length.

    • It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.

    • The following special characters are supported: ! @ # $ % ^ & * ( ) _ + - =.

View the status of Babelfish

  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 of the page that appears, click Basic Information.

  3. In the Configuration Information section of the page that appears, view the values of Minor Engine Version and Babelfish Status. Babelfish状态

View the Babelfish management account

  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 of the page that appears, click Accounts.

  3. On the Accounts tab of the page that appears, view the Babelfish management account that is initialized when you created the RDS instance.Babelfish管理账号

View the endpoints and TDS port

Prerequisites

A whitelist is created for the RDS instance. For more information, see Control access to an ApsaraDB RDS for MySQL instance.

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 of the page that appears, click Database Connection.

    You can view the internal and public endpoints and Tabular Data Stream (TDS) port in the Database Connection section.连接地址和TDS端口号

    Note

Related operations

Operation

Description

CreateDBInstance

Creates an instance.

DescribeDBInstanceAttribute

Queries the details of an instance.

AllocateInstancePublicConnection

Applies for a public endpoint for an instance.

ModifyDBInstanceConnectionString

Changes the endpoint of an instance.

DescribeDBInstanceNetInfo

Queries the endpoints of an instance.