Manage public connections|V4.1.0|OceanBase Developer Center| docs|Distributed Database

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 Permissions > Public Connection 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.

Field	Description
Connection Name	Specify the name of the connection.
Resource Group	Click the field and select the resource group from the drop-down list. For more information about resource groups, see Manage resource groups.
Connection Status	By default, the connection status is Enabled . You can set it to Disabled . A disabled connection cannot be accessed.
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.
Connection Type	Select MySQL or Oracle . Logical databases support only the MySQL mode.
Endpoint	* Host IP : 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 name : the name of the cluster where the target database is located. This parameter is not required for logical databases. * Rent name : the name of the tenant in which the target database is located. This parameter is not required for logical databases. 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 in OceanBase Cloud Platform (OCP).
Read/Write Account	Specify the Database Username and Database Password for accounts that have permissions to read and write the database. An ODC user with the read/write permissions can use this account to access OceanBase Database. You can click Test Connection next to the password field to test the connection to the target database.
Read-only Account	Specify the Database Username and Database Password for accounts that have only permissions to read the database. An ODC user with the read-only permissions can use this account to access OceanBase Database. You can click Test Connection next to the password field to test the connection to the target database.
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.
Query Tenant Views with sys Tenant Account	When Database Type is set to Physical Database, you can specify an account that has the privilege to query the SYS tenant view, and the password. This field is automatically populated when SYS is specified as the tenant in Endpoint. * Account: an account having the permission 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 versions, to use the import and export features and check the partition information, you need to configure the root@sys account by using this option.
Enable SSL	Select whether to enable the SSL encrypted SSL link to ensure the safe transmission of data between the client and the server. Note Users created in non-encrypted mode (require none) (require none by default) can choose whether to enable SSL according to their needs. If Enable SSL is checked, an SSL connection will be created; if not checked, a normal connection will be created. For users created through the SSL connection method (require ssl), you can create an SSL connection after checking Enable SSL; if you don’t check it, the connection will fail. Users created through require ssl do not need to upload a certificate but must check Enable SSL, otherwise the connection will fail. It is recommended to upload a certificate to verify the identity of both communication parties (not required): Upload the CA certificate, and the client will verify the identity of the server; Upload the client key and client certificate, and the server will verify the identity of the client. Users created by x509 encryption (require x509) must enable SSL and upload the CA certificate, client key and client certificate, and the client and server will verify each other's identity; uncheck Enable SSL Neither uploading the certificate nor uploading the certificate will successfully create the connection. Before enabling SSL through ODC, you must confirm that SSL is enabled on the OBServer side; if you connect through OBProxy, you also need to ensure that OBProxy has enabled SSL. How to enable SSL on the server side, please refer to OBServer Transmission Encryption and ApsaraDB for OceanBase SSL Link Encryption.

After you specify the preceding information, click Create in the lower-right corner of the panel. The connection is created.

Notice
After you click Create , a warning message will appear in the following cases:

The read/write account is disconnected.

The read/write account has insufficient permissions.

The read-only account is disconnected.

The read-only account has insufficient permissions.

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:

Use the search icon above the list to find the target connection.
Use to filter connections by type, authority, and label. Button The refresh button can refresh the list information.
Use to filter connections by type, authority, and label. Button The refresh button can refresh the list information.
Refresh the list information through .
Adjust the column width of the connection list.

Public connection list

The information of public connections is provided by columns, which are described in the following table. A filter is provided on top of some columns for you to filter connections.

Field	Description
Connection ID	The sequence number of the 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. You can click Connection Name to sort the connection names in ascending or descending order.
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.
Tenants	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/Disable . You can click the filter icon to filter the connections by status.
Operation Time	The last time when the connection was edited, or the time when the connection was created if the connection has not been edited.
Actions	The actions you can take. Valid values: View , Edit , Copy , and Disable / Enable . View: View the configuration of the connection. Administrative authority: Add/remove users with Connection Access. 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 a public connection

Click View in the Actions column. The Public Connection Information panel appears. You can see the Connection Details and Related Users tabs.

Field	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 for Read/Write Account/Read-only Account, and Query sys Tenant Account . * Operation information: displays information in fields such as Created By , Created At , and Updated At . * User deletion: You can click Delete Public Connection on the tab to delete the current connection. After the connection is deleted, it is inaccessible to users who are granted the permissions to access 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	In the lower-right corner of the Public Connection Information panel, you can click Edit 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.
The Edit Public Connection panel displays all the parameters you specified when you created the connection. Database Type , Region , and Connection Mode cannot be modified after the connection is created.
After the editing is complete, click Save .