Manage public connections|V4.1.3|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

Create a single 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.

Import multiple public connections at a time

ODC V4.1.2 and later allows you to import multiple public connections at a time by uploading a configuration file. Perform the following steps:

Log on to ODC and click Batch Import on the Public Connection tab.

In the Batch Import panel, click Download Template, and specify the parameters of the public connections to be imported.

Parameter	Description
Connection Name	Required. The name of the connection. The name cannot contain spaces and must be unique.
Resource Group Name	Optional. The name of the resource group to be created in ODC. Separate multiple resource group names with commas (,).
Connection Status	Required. Valid values: true and false.
Connection Type	Required. Valid values: OB Oracle, OB MySQL, Cloud OB Oracle, Cloud OB MySQL, and ODP(Sharding) OB MySQL.
Host IP	Required. The IP address of the server where the target database is located. You can obtain the host IP address from the details page of the tenant in which the target database is located, such as a tenant created on Alibaba Cloud or in OCP.
Port	Required. The port number of the server where the target database is located. You can obtain the 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 OCP.
Cluster	Optional. The name of the cluster where the target database is located. This parameter is not required for logical databases.
Tenant	Required. The name of the tenant in which the target database is located. This parameter is not required for logical databases. The tenant name cannot contain spaces.
Username	Required. The database username of accounts that have the privileges to read and write the database. An ODC user with the read/write privileges can use this account to access OceanBase Database.
Save Password	Required. Valid values: true and false.
Password	The database password of accounts that have privileges to read and write the database. An ODC user with the read/write privileges can use this account to access OceanBase Database.
Read-only Account	Required. The database username of accounts that have the privilege to only read the database. An ODC user with the read-only privilege can use this account to access OceanBase Database.
Password of Read-only Account	Required. The database password of accounts that have the privilege to only read the database.
Default Database	Optional. 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 parameter when you connect to a database in an Oracle tenant. Note If you leave this parameter unspecified in MySQL mode, the information_schema database is connected by default. However, if the connection to the information_schema database fails, you need to specify a database that can be accessed by the current user.
Sys Tenant Account	Optional. The account that has the privilege to view the sys tenant views.
Sys Tenant Password	Optional. The password of the account.

Click the file pool in the Batch Import panel to open the file explorer and select the file to be imported. You can also directly drag the file to the file pool to upload it.
Click Import. After the connections are imported, you can view them in the list of public connections.