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

Step 1: Obtain the database connection string

Contact the deployment personnel or administrator of OceanBase Database to obtain the connection string. The following is a connection string example:

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

where:

• $host specifies the IP address for connecting to OceanBase Database. It is the IP address of OceanBase Database Proxy (ODP) for connection through ODP, or the IP address of an OBServer node for direct connection.

• $port specifies the port for connecting to OceanBase Database. For connection through ODP, the default value is 2883, which can be customized when ODP is deployed. For direct connection, the default value is 2881, which can be customized when OceanBase Database is deployed.

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

  Notice

  The user for connecting to a tenant must have the CREATE, INSERT, DROP, and SELECT privileges on the database. For more information about user privileges, see Privilege types in MySQL mode.

• $user_name specifies the tenant account. Two formats are supported in the case of connection through ODP: username@tenant name#cluster name and cluster name:tenant name:username. In the case of direct connection, the format is username@tenant name.

• $password specifies the password of the account.

For more information about the connection string, see Connect to an OceanBase Database tenant by using OBClient.

Here is an example:

obclient -hxxx.xxx.xxx.xxx -P2881 -utest_user001@mysql001 -p****** -Dtest

Step 2: Connect to OceanBase Database from the DBeaver console

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 on the official website of MySQL, choose version 5.1.47, 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 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 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.

5. 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.