Connect to OceanBase Cloud in Navicat

Navicat 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 OceanBase Cloud databases using Navicat.

Prerequisites

• You have downloaded and installed Navicat Premium.

• You have registered an OceanBase Cloud account, and have created an instance and a tenant. For details, refer to Create an instance and Create a tenant. This topic uses a MySQL-compatible tenant as an example.

  Note

  The Navicat macOS client currently does not support connecting to Oracle-compatible tenants in OceanBase Cloud.

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 Navicat

1. Open Navicat Premium, and in the upper-left corner of the application, select Connection > OceanBase > OceanBase Enterprise Edition (MySQL Compatible Mode) to open the New Connection window.

   

2. In the New Connection window, complete the following configuration based on Step 1: Obtain an OceanBase Cloud connection string:

   Field	Description
   Connection Name	Enter a connection name of your choice.
   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.
   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.

   

3. Click Test Connection. When the pop-up window displays Connected, it means the connection is successful. Close the pop-up at this time.

4. Click Save to connect to the OceanBase Cloud database.

5. In the left sidebar of the window, double-click the database name. 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 Navicat. For detailed instructions on using Navicat, refer to the Navicat Documentation.