Manage OceanBase Database with DMS

Alibaba Cloud Data Management Service (DMS) is an enterprise-level, one-stop data management platform that provides comprehensive database development and operations capabilities throughout the entire lifecycle. These capabilities include data asset management, data governance, database design and development, data integration, data development, and data consumption. This topic describes how to connect to and manage OceanBase Database in DMS.

Prerequisites

• You have deployed OceanBase Database and created a user tenant.

• Your DMS account has the DBA or system administrator role. You can check the role of your account in the DMS console. Click your avatar in the upper-right corner of the page to view the role information.

Procedure

Step 1: Obtain the database connection information

Contact the deployment personnel or administrator of OceanBase Database to obtain the corresponding database connection string, for example:

obclient -h$host -P$port -u$user_name -p$password -D$database_name

Parameter description:

• $host: the IP address for connecting to OceanBase Database. For the connection through OceanBase Database Proxy (ODP), use the IP address of the ODP. For direct connection, use the IP address of the OBServer node.

• $port: the port for connecting to OceanBase Database. For the connection through ODP, the default port is 2883, which can be customized during ODP deployment. For direct connection, the default port is 2881, which can be customized during OceanBase Database deployment.

• $database_name: the name of the database to be accessed.

  Notice

  The user for connecting to the tenant must have the CREATE, INSERT, DROP, and SELECT privileges on the database.

• $user_name: the connection account of the tenant. For the connection through ODP, the common format is username@tenant name#cluster name or cluster name:tenant name:username. For direct connection, the format is username@tenant name.

• $password: the password of the account.

Step 2: Connect to OceanBase Database in the DMS console

1. Log in to the DMS console. Move your mouse to the icon in the upper-left corner of the page to expand the left navigation bar, and then select All Features > Instance Management.

2. Click + Add, and on the Add Instance page, select the Other Clouds / Self-Managed tab.

3. On the Other Clouds / Self-Managed tab, select OceanBase MySQL or OceanBase Oracle based on the tenant mode of your OceanBase database. Then, in the Basic Information section, fill in the following information:

   Parameter	Description
   Instance Source	Select Public Network.
   Instance Region	Select the region of your DMS instance, such as East China 1 (Hangzhou).
   Login Address	Enter the value of the -h parameter from the connection string obtained in Step 1.
   Port	Enter the value of the -P parameter from the connection string, which is the port number for connecting to the OceanBase database.
   Database Account	Enter the value of the -u parameter from the connection string, which is the account name.
   Database Password	Enter the value of the -p parameter from the connection string, which is the account password.

4. Click Test Connection. If the connection is successful, click OK.

5. Return to the DMS homepage, refresh the database instance list, and you will see the added instance information under the No-Login Instance section.