Connect to OceanBase Database by using DBeaver

DBeaver is a universal database client. It connects to a database through the Java Database Connectivity (JDBC) driver provided by this database. It supports normal relational databases, non-relational databases, and distributed databases.

You can connect to a MySQL tenant of OceanBase Database by using the OceanBase or MySQL driver that comes with DBeaver. This topic describes how to connect to a MySQL tenant of OceanBase Database by using the OceanBase driver of DBeaver.

Prerequisites

• You have downloaded and installed DBeaver. You can download the DBeaver installation package for your operating system from the DBeaver Community website.

• The IP address of the OBServer node to be connected has access to the server where DBeaver is installed.

• You have installed OceanBase Database and created a MySQL tenant.

Procedure

1. (Optional) Replace the driver file.

   The default driver file for the OceanBase driver of DBeaver is mysql-connector-java-5.1.44. This topic takes mysql-connector-java-5.1.47 as an example. You can replace the driver file based on the following steps.

   1. Go to the MySQL Product Archives page at the official website of MySQL, choose the 5.1.47 version, and download the corresponding driver file.

   2. Choose Database > Driver Manager, search for OceanBase, select the OceanBase driver, and then click Edit to go to the driver editing page.

   3. Click the Libraries tab, select the driver file of the OceanBase driver, and then click Delete.

   4. Click Add File to add the downloaded driver file to the library and then click OK.

2. Choose Database > New Database Connection to go to the Select your Database page. You can also click the icon under File to go to the Select your database page.

3. On the Select your database page, select OceanBase and click Next. On the Connection settings page, specify the information about the database to be connected and click Test Connection.

   Notice

   You can connect to OceanBase Database by using an IP address or an OceanBase Database Proxy (ODP). When you use an IP address, enter the port number specified by the mysql_port parameter. The default port number is 2881. When you use an ODP, enter the port number specified by the proxy_port parameter. The default port number is 2883.

4. If Connected is displayed in the Test Connection pop-up window, the database can be connected. Click OK and then click Finish.

1. Double-click the database name on the Database Navigator tab. If the database instances appear under the database, you have connected to OceanBase Database.

More information

For any problems encountered when you connect to OceanBase Database by using DBeaver, see related information in DBeaver Documentation.