Connect to OceanBase Database by using ODC

You can connect to OceanBase Database by using OceanBase Developer Center (ODC).

Prerequisites

• You have installed ODC.

  To download the ODC installation package of a suitable version, visit Software Center. For more information about how to install ODC, see Install ODC.

• You have obtained the OceanBase Database connection string from the deployment engineers.

  Information in the connection string is required when you connect to the database by using ODC.

Usage notes

When you connect to OceanBase Database by using ODC, you can connect only to the database in the current tenant.

Procedure

Note

The graphic user interface (GUI) varies with the ODC version. This topic takes ODC V3.2.0 as an example. For other ODC versions, see the ODC User Guide of the corresponding version.

1. Log on to ODC.

   The ODC homepage appears, and the Private Connection tab is displayed on the ODC homepage.

2. In the upper-right corner of the Private Connection tab, click Create Connection.

   

   Note

   It takes some time to load the data when you run ODC the first time.

3. On the page that appears, specify the information about the database to be connected.

   

   You can specify basic configurations of a database connection in two ways:

   • Specify the information described in the following table based on the OceanBase Database connection string: mysql -h host name -P port number -u database username@tenant name#cluster name -D default database -p database password.

   • Copy the connection string to the Intelligent Parsing field. ODC automatically recognizes the connection string and populates the connection information.

   Item	Description
   Region	Select Public Cloud if your database instance is deployed on Alibaba Cloud, or select Independent Deployment/Apsara Stack if your database instance is deployed in your own environment.
   Connection Mode	Select MySQL.
   Connection Name	Specify the name of the connection.
   Set Tag	Add a description for the connection. Click the Set Tag button after Connection Name to set a tag for the current connection. You can set and manage tags in the drop-down list that appears. Tag setting: Select a tag from the drop-down list. Create tags first if the list is empty. Tag management: Click Create Tag at the bottom of the list or the settings icon above the list to pop up the Tags window. In the Tags window, you can edit or delete created tags. You can also click the Create Tag button to set a name or color for the new tag.
   Endpoint	Host Name: the IP address of the server where the target database is located. Port: the port number of the server where the target database is located. Cluster: the name of the cluster where the target database is located. Tenant: the name of the tenant in which the target database is located.
   Default Database	When you connect to a MySQL tenant of OceanBase Database, you must specify the default database for the connection.
   Database Username	An account in the tenant. In MySQL mode, this account must have the permission to access the default database.
   Database Password	The password of the account in the tenant. You can click the Test Connection button after the password box to test whether you can connect to the target database. An error is returned if the configuration information such as the username, password, or network configuration is invalid.
   Save Database Password	If you disable this option, the database password for the connection is not saved. Each time you use or test a connection, you must enter the database password in the password dialog box to use the connection. If you enable this option, the database password for the connection is saved. You do not need to enter the database password each time you use the connection.
   Intelligent Parsing	You can paste a connection string to the field. ODC automatically identifies the string and fills in the corresponding fields on the page.
   SQL Query Timeout Value	This option appears after you click Advanced Configuration. You can specify a timeout value for SQL queries. A query whose execution time exceeds the timeout value is automatically terminated. The default timeout value is 60 seconds.
   Query sys Tenant View	This option appears after you click Advanced Configuration. When Tenant under Endpoint is set to sys, this option is automatically populated. Account: an account having the privilege to check the views under the sys tenant. Password: the password of the account. After you specify the account and password, you can click Test Connection next to the password field to verify whether the account information is valid. Note In ODC V2.3.0 and later versions, to use the import and export features and check the partition information, you must configure the root@sys account in this field.

4. Click Save to save the current configuration in the ODC connection list.

5. In the connection list, click the name of the connection that you saved or click Open in the Actions column to log on to OceanBase Database.

   

   The preceding page provides the following features:

   • Object management: A GUI is provided for you to create database objects. This makes the operations easier. In addition, you can edit the online table data that you are currently viewing.
   • Console: You can save and edit the content in a SQL window and reuse the scripts that you have saved. You can also format SQL scripts and display structured SQL statements. The SQL editor supports auto-complete when you write SQL statements to save your effort. You can edit and export the result set returned from SQL execution.
   • Toolkit: includes session management, recycle bin management, and import and export tools. Session management: The session management tool enables you to edit database sessions and global properties and terminate specified database sessions. Recycle bin management: The recycle bin management tool allows you to empty and restore database objects in the recycle bin. Import and export: The import and export tools enable you to import or export data of various formats in one or more tables.
   • SQL diagnostics: This feature allows you to diagnose SQL execution plans and view resource consumption during SQL execution. It can help you locate problems in SQL scripts.

Related topics

For more information about how to connect to and use OceanBase Database by using ODC, see the ODC User Guide of the corresponding version.