This topic describes how to create an ApsaraDB RDS for PostgreSQL instance with Babelfish enabled.
Prerequisites
You can enable Babelfish for an ApsaraDB RDS for PostgreSQL instance only when you create the instance. The instance must meet the following requirements:
Major engine version: RDS PostgreSQL 15.
Product series: Basic Edition or High-availability Edition.
Product type: Standard Edition.
Usage notes
You cannot enable Babelfish for existing ApsaraDB RDS for PostgreSQL instances.
You cannot disable Babelfish after it is enabled.
After the RDS instance is created, the babelfish_db database is created. This database is critical for the Babelfish feature. Do not delete this database. Otherwise, the instance becomes unavailable.
Create an ApsaraDB RDS for PostgreSQL instance with Babelfish enabled
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 the RDS instance resides.
Click Create Instance to go to the ApsaraDB RDS buy page.
Follow the configuration wizard to create the instance.
This section describes the key parameters for enabling Babelfish when you create an ApsaraDB RDS for PostgreSQL instance. For more information about other parameters, see Create an ApsaraDB RDS for PostgreSQL instance.
The key parameters are described in the following table.
Parameter
Value
Engine
PostgreSQL 15
Then, select Enable Babelfish.
Instance Type
The instance types available in the console.
Babelfish Migration Mode
This parameter is available only after you select Enable Babelfish in the Basic Configurations step. It specifies the migration mode after Babelfish is enabled.
single-db: You can create only one SQL Server database in the Babelfish for ApsaraDB RDS for PostgreSQL instance. The database is created in the standard PostgreSQL schema.
multi-db: You can create multiple SQL Server databases. A different PostgreSQL schema is created for each database 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 management account used to manage Babelfish or PostgreSQL.
ImportantThis is a privileged account and cannot be deleted after it is created.
Configuration guidelines:
It must be 2 to 63 characters in length.
It can contain lowercase letters, digits, and underscores (_).
It must start with a letter and end with a letter or a digit.
It cannot start with pg.
It cannot be an SQL keyword. For more information, see SQL Keywords.
Password
The password of the management account.
NoteYou can change the password after the instance is created. For more information, see Reset a password.
Configuration guidelines:
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 supported special characters are
!@#$%^&*()_+-=
.
View the status of Babelfish
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.
In the navigation pane on the left, click Basic Information.
In the Configuration Information section, view the Minor Engine Version and Babelfish Status.
View the Babelfish management account
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.
In the navigation pane on the left, click Account Management.
On the User Accounts tab, view the Babelfish management account that was created when you created the instance.
View the endpoint and TDS port number
Prerequisites
You have configured a whitelist for the instance. For more information, see Configure a whitelist.
Procedure
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.
In the navigation pane on the left, click Database Connection.
You can view the internal and public endpoints and the Tabular Data Stream (TDS) port number on this page.
NoteTo use a public endpoint, click Apply for Public Endpoint. For more information, see Apply for or release a public endpoint.
To change the Babelfish TDS port number, click Modify Endpoint. For more information, see View or change the endpoints and port numbers of an ApsaraDB RDS for PostgreSQL instance.
Related APIs
API | Description |
Creates an RDS instance. | |
Queries the details of an instance. | |
Applies for a public endpoint. | |
Modifies an endpoint. | |
Queries endpoints. |