Create a data source

This topic introduces how to create a data source.

Background information

You can connect ODC to an OceanBase database. After the connection is successfully established, you can edit and manage the connected data sources, including the database objects and resources, in ODC. ODC can connect to OceanBase Database in MySQL and Oracle modes on Apsara Stack and Alibaba Cloud.

Prerequisites

• You have deployed web ODC.

• You have logged on to web ODC.

• You have obtained the connection information or connection string of the data source instance. A connection string is in the following format: mysql -h <host name> -P <port number> -u <database username>@<tenant name> # <cluster name> -D <default database> -p '<database password>'. Here is an example of a connection string:

  -hxxx.x.x.x -P8080 -uodc@mysql_tenant#odc_cluster -Dodc -p'******'
  

Procedure

Create a single data source

Assume that you want to create a data source in ODC for an OceanBase database in MySQL mode.

1. Log on to web ODC. In the left-side navigation pane, choose Data Sources > New Data Source.

   

2. In the New Data Source panel, specify the following information.

   Note

   If you already have the connection string of an OceanBase database, you can specify the following fields based on the connection string. You can also paste the connection string into the Intelligent Parsing field to populate the information in the corresponding fields.

   

   Parameter	Description
   Data Source Type	OceanBase is selected by default.
   Intelligent Parsing	You can paste a connection string into this field. ODC automatically identifies the string and fills in the corresponding fields.
   Connection Type	The type of the database to be connected. ODC supports the following database types: OceanBase MySQL/OceanBase Oracle: a database instance deployed in your own environment. OceanBase MySQL Cloud/OceanBase Oracle Cloud: a database instance deployed on Alibaba Cloud. OceanBase MySQL Sharding: a logical database, which supports 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: the name of the cluster where the target database is located. This parameter is not required for a logical database. Tenant: the name of the tenant in which the target database is located. This parameter is not required for a logical database. 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).
   Database Account	Account: the username of an account created in the tenant. In MySQL mode, this account must have the privilege to access the default database. Password: the password of the account created in the tenant. You can click Test Connection next to the password field to test whether you can connect to the target database. Note An error will be returned if the configurations such as the username, password, and network settings are invalid. You can connect to only a database in the current tenant. Otherwise, an error is returned, indicating that the connection test fails. Before you save the configuration, you can click Test Connection to test the database connection. If the username and password are correct, the message Connected is displayed. If you use ODC V4.0.0 and later, you can save the connection without setting the database account and password.
   Environment	The type of the environment. Valid values: dev, sit, prod, and default.
   Sys Tenant Account Settings	Choose whether to select Query Tenant Views with sys Tenant Account. If you select this option, specify Account and Password. When the database is a physical database, you can specify an account that has the privilege to query the sys tenant views and the password. This field is automatically filled in when sys is specified as the tenant in Endpoint. 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, 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, you need to configure the root@sys account in the Advanced Configuration section during connection creation. In ODC V2.4.1 and later versions, the dependency of the import and export features on the root@sys user is removed when you query views. If the root@sys account is not configured, some ODC objects such as stored procedures and functions do not support the export feature. If the root@sys account is configured, you can access the views under the sys tenant to obtain the optimal data routing strategy, which can increase the export speed. The account and password of the sys tenant are the account and password of a user in the cluster. Do not enter @sys#cluster in the Account field. For example, the account of the root@sys user is root.
   Enable SSL	Specifies whether to enable SSL link encryption to ensure secure data transmission between clients and servers. Note By default, the REQUIRE NONE option is specified when you create a user. The REQUIRE NONE option specifies that no encryption method is used. In this case, if you select Enable SSL, an SSL connection is created. Otherwise, a regular connection is created. If the REQUIRE SSL option is specified when you create the user, you must select Enable SSL to create an SSL connection. Otherwise, the connection fails. If the user is created by specifying the REQUIRE SSL option, you do not need to upload the certificates, but you must select Enable SSL. Otherwise, the connection fails. We recommend that you upload the following certificates for identity verification: CA certificate. The client will verify the identity of the server. Client key and client certificate. The server will verify the identity of the client. If the user is created by specifying the REQUIRE X509 option, you must select Enable SSL and upload the CA certificate, the client key, and the client certificate. The client and the server will verify the identity of each other. If you do not select Enable SSL or upload the certificate, you cannot create the connection. Before you select Enable SSL in ODC, make sure that SSL is enabled for the OBServer. If you connect to the OBServer node by using an ODP, make sure that SSL is enabled for the ODP. For more information about how to enable SSL for an OBServer, see Transmission encryption of OBServer nodes and SSL link encryption.

3. After you specify the preceding information, click Save in the lower-right corner.

4. In the dialog box that appears, enter a name for the data source and click OK. Then, the configuration information is saved in ODC.

   

   Note

   • In the lower-right corner of the New Data Source panel, click Copy Connection String to copy the current connection information as a connection string. This makes it easier to obtain the currently configured connection information.
   • If you do not want to save the current connection information, click Cancel. Then, a confirmation dialog box appears, asking whether you want to exit the connection creation window.

5. After the data source is created, you can check it in the data source list.

Import multiple private connections at a time

ODC V4.2.0 allows you to upload configuration files to import multiple data sources in batches. Perform the following steps:

1. On the Data Sources page, click Batch Import.

   

2. In the Batch Import panel, click Download Template. In the dialog box that appears, specify the information about the data sources that you want to import.

   

   Parameter	Description
   Connection Name	Required. The name of the connection. The name cannot contain spaces and must be unique.
   Connection Type	Required. Valid values: OB Oracle, OB MySQL, Cloud OB Oracle, Cloud OB MySQL, and ODP(Sharding) OB MySQL.
   Host IP Address	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 Name	Optional. The name of the cluster where the target database is located. This parameter is not required for logical databases.
   Tenant Name	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. An account created in the tenant. In MySQL mode, this account must have the privilege to access the default database.
   Password	The password of the account under the tenant. If the Password parameter is left unspecified, it indicates that the password is an empty string.
   Environment	The type of the environment. Valid values: dev, sit, prod, and default.
   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.

3. Click the file pool in the Batch Import panel to open the file explorer and select the files to be imported. You can also directly drag the files to the file pool to upload them.

4. Click Import to import data sources in batches. You can view the imported data sources in the data source list.