Connect to OceanBase Cloud in DBeaver

DBeaver is a universal database client tool that supports common relational databases, non-relational databases, distributed databases, and more.

This topic will use the OceanBase Cloud MySQL-compatible tenant as an example to demonstrate how to connect to the OceanBase Cloud database using DBeaver.

Prerequisites

• You have downloaded and installed DBeaver.
• You have registered an OceanBase Cloud account, and have created a cluster instance and a MySQL-compatible tenant. For details, refer to Create a cluster instance and Create a tenant.

Procedure

Step 1: Obtain an OceanBase Cloud connection string

1. Log in to the OceanBase Cloud console. On the Instances page, expand the target instance and click Create under the target tenant.

   

2. In the pop-up window, click Connect with Public IP.

3. In the Connect with Public IP window, complete the following settings to generate the connection string:

   1. Under 1. Add an IP address to the allowlist, click Add to add your exit IP address(es) used for the connection to the allowlist.

   2. (Optional) Under 2. Download the CA certificate to connect securely to the tenant, download the CA certificate and complete the verification.

   3. Under 3. Connect to your instance, click the drop-down list for Database and Account to create a database and an account for the connection. Select MySQL CLI as the connection method.

      Notice

      Please keep your password in a secure place after creating your account.

      

Step 2: Connect to OceanBase Cloud in DBeaver

1. Open DBeaver, and click the icon to enter the Select your database window.

   

2. Select MySQL, and then click Next to enter the Connection Settings window.

3. In the Connection Settings window, under the Main tab, complete the configuration based on the connection string obtained in Step 1: Obtain an OceanBase Cloud connection string:

   Field	Description
   Connect by	Select Host.
   Server Host	Taken from the -h parameter in the connection string, which is the hostname of OceanBase Cloud database, for example, t5******.aws-ap-southeast-1.oceanbase.cloud.
   Port	Taken from the -P parameter in the connection string, which is the OceanBase Cloud database connection port.
   Database	Taken from the -D parameter in the connection string, which is the name of the database to be accessed.
   Username	Taken from the -u parameter in the connection string, which is the account name, for example, test.
   Password	Taken from the -p parameter in the connection string, which is the account password.

   

4. Click Test Connection. When the pop-up window displays Connected, it means that you have successfully connected to the OceanBase Cloud database.

   

   Note

   If you have not installed the MySQL driver before, a pop-up window will prompt you that the driver is missing. You can install the driver according to the prompts and then retest the connection.

5. Click OK to close the pop-up window, then click Finish.

6. In the Database Navigator panel, double-click the name of the database you just added. If it expands as shown below, it means you have successfully connected to the OceanBase Cloud database.

   

What's next

After successfully connecting to the database, you can start using DBeaver. For detailed instructions on using DBeaver, refer to the DBeaver Documentation.