Connect to an OceanBase Cloud database in TablePlus

TablePlus is a modern, native database management tool that provides a user-friendly graphical interface for managing various relational databases such as MySQL, PostgreSQL, SQLite, and more. This guide demonstrates how to connect to TablePlus using the MySQL-compatible tenant of an transactional instance in OceanBase Cloud.

Prerequisites

• You have downloaded and installed TablePlus. For more information, visit the TablePlus official website.

• You have registered for an OceanBase Cloud account and created a transactional instance with a MySQL-compatible tenant. For more information, refer to Create an instance and Create a tenant.

  Note

  We recommend selecting OceanBase Database version 4.2.1 or later when creating an OceanBase Cloud instance to ensure better integration.

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 select Connect > Get Connection String 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: Create an OceanBase Cloud data source in TablePlus

1. After launching TablePlus locally, right-click on the right side of the interface and select New > Connection.

2. In the pop-up window, select MySQL and click Create.

3. In the MySQL Connection dialog, configure the following settings using the connection string obtained in Step 1:

   Configuration	Description
   Name	A custom name for the connection.
   Host/IP	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.
   User	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.
   Database	Taken from the -D parameter in the connection string, which is the name of the database to be accessed.

4. Click Test to verify if the connection is successful. When the input fields turn green, it indicates a successful connection.

5. Once the connection test is successful, click Connect to complete the process.

What's next

After establishing the connection, you can start using TablePlus. For detailed instructions on how to use TablePlus, refer to the TablePlus official documentation.