Overview
OceanBase Developer Center (ODC) allows you to create private and public connections. A private connection is created in ODC by a user who obtains the database access information that is not shared with all users for the sake of security. The administrator can create public connections in ODC, and combine multiple public connections to create resource groups. In this way, users in a resource group can use the public connections in this group.
Log on to ODC as the administrator and go to the Public Resource Console page. In the left-side navigation pane, choose Resource Management > Public Connections to display the Public Connections page.
Create a public connection
Click Create Public Connection in the upper-right corner of the Public Connections page. The Create Public Connection panel appears.
Specify the following parameters in the Create Public Connection panel.
| Parameter | 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 or Oracle . |
| Connection Name | Specify the name of the connection. |
| Resource Group | Click the field, and select a created resource group from the drop-down list. For more information about the resource group, see Manage resource groups. |
| Connection Status | The default connection status is Enabled . You can manually change the status to Disabled . A disabled connection cannot be accessed. |
| 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 in which the target database is located. * Tenant : the name of the tenant in which the target database is located. Note You can obtain the host name and port number from the details page of the tenant in which the target database is located, such as a tenant created on Alibaba Cloud or OceanBase Cloud Platform (OCP). |
| Default Database | When you connect to a database in a MySQL tenant, you must specify the default database for the connection. You do not need to specify this field when you connect to a database in an Oracle tenant. |
| Read/Write Account | Specify the database username and password of the account that has the Read/Write permission on the database. An ODC user with the Read/Write permission can use this account to access OceanBase Database. |
| Read-only Account | Specify the database username and password of the account that has the Read-only permission on the database. An ODC user with the Read-only permission can use this account to access OceanBase Database. |
| SQL Query Timeout Value | 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 | You can specify an account that has the privilege to query the sys tenant view, and the password. This field is automatically populated when Tenant in Endpoint is set to sys. * Account : an account that has the privilege to check the views under the sys tenant. * Password : the password of the account. After you specify the account and password, click Test Connection next to the password field to verify whether the account information is valid. In ODC V2.3.0 and later, to use the import and export features and check the partition information, you need to configure the root@sys account in this field. |
After you specify all preceding information, click Create in the lower-right corner of the panel. Notice
After you click Create , a warning message will appear in the following cases:
The read/write account is disconnected.
The read/write account does not have the permission.
The read-only account is disconnected.
The read-only account does not have the permission.
Manage public connections
The information of public connections is displayed in a list on the Public Connections page. On this page, you can perform the following operations:
Click the refresh icon to manually refresh the list.
Search for connections by using the search box in the upper-right corner of the list.
Click All Modes to select the MySQL or Oracle mode.
List of public connections
The information of public connections is provided by columns, which are described in the following table. A filter is provided on top of columns for you to filter connections.
| Column | Description |
|---|---|
| Connection ID | The sequence number of the public connection. You can click Connection ID to sort the connection IDs in ascending or descending order. |
| Connection Name | The name of the connection and the host and port information. You can click the name of a connection to go to the corresponding connection management page. The icon before the connection name indicates the status of the connection. Blue indicates valid, red indicates invalid, and gray indicates that the database password is not saved. |
| Cluster | The cluster information. You can click the filter icon  to filter the cluster information. If you select Empty , you can filter connections that do not belong to any clusters. |
| Tenant | The tenant information. You can click the filter icon to filter the tenant information. If you select Empty , you can filter connections that do not belong to any tenants. |
| Resource Group | The name of the resource group to which the connection belongs. You can click the filter icon to filter the connections by the resource group. If you select Empty , you can filter connections that do not belong to any resource groups. |
| Status | The current connection status. Valid values: Enable and Disable . |
| Operation Time | The time when the connection was last edited, or the time when the connection was created if the connection has not been edited. |
| Actions | Indicates the actions you can take: View , Edit , Copy , and Disable / Enable . * View: view the configuration information of the connection. * Edit: modify the configuration of the connection. * Copy: quickly modify and create another connection based on the configuration of the connection. * Disable/Enable: directly change the connection status . |
View public connections
Click View in the Actions column, the Public Connection Information panel appears. You can see the Connection Details and Related Users tabs.
| Item | Description |
|---|---|
| Connection Details | * Connection information: displays the information you specified when you created the connection in fields such as Region , Connection Mode , Connection Name , Resource Group , Endpoint , Database Username , SQL Query Timeout Value , and Query sys Tenant Account . * Operation information: displays information in fields such as Created By , Created At , and Updated At . * Delete user: You can click Delete Public Connection on the tab to delete the current connection. After the connection is deleted, the user who was granted the access to the connection cannot use it. |
| Related Users | Displays the information about the users who can access the current public connection in fields such as Name , Role , and Permissions . |
| Edit | You can click Edit in the lower-right corner of the Public Connection Information panel to go to the Edit Public Connection panel. |
Edit a public connection
Click Edit in the Actions column of the public connection information list. The Edit Public Connection panel appears. In the Edit Public Connection panel, all the information you specified when you created it is displayed. Note that Region and Connection Mode cannot be changed once the connection is created. Database Password specified for Read/Write Account and Read-only Account is not displayed. Notice
After you edit the information, click Save . A warning message will appear in the following cases:
The read/write account is disconnected.
The read/write account does not have the permission.
The read-only account is disconnected.
The read-only account does not have the permission.