Use Client ODC

This topic describes some basic operations for using Client ODC.

Create a data source

Example: Create an OceanBase data source in MySQL mode in OceanBase Developer Center (ODC).

1. Obtain the connection information or connection string of the data source instance.

   The connection string is in the format of mysql -h host name -P port number -u database username@tenant name#cluster name -D default database -p ' database password'. Here is an example:

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

2. In the left-side navigation pane, click the plus sign (+) next to Data Sources and select Create Data Source.

   ODC supports the following database types:

   • OceanBase MySQL or OceanBase Oracle: a database instance that you build in your own environment.

   • OB Cloud MySQL or OB Cloud Oracle: a database instance on Alibaba Cloud.

   • MySQL: a database instance running on MySQL Database.

   

3. In the Create Data Source panel, specify the following information.

   Note

   If you have obtained the connection string of OceanBase Database, you can obtain the following information from the connection string or use the Intelligent Parsing tool provided on the tab to fill in the information.

   

   Parameter	Description
   Data Source Type	The default value is OceanBase.
   Intelligent Parsing	You can paste a connection string to the field. ODC automatically identifies the string and fills in the corresponding values.
   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 logical databases. Tenant: 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). The default port is 8989.
   Database Account	Database User Name: the username of an account created in the tenant. In MySQL mode, this account must have the permission 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, or network settings are invalid. You can only connect to a database in the current tenant. Otherwise, a test failure error will be returned. Before you save the configurations, you can click Test Connection to test the database connection. If the database username and password are correct, the system returns a message indicating that the connection succeeded. In ODC V4.0.0 and later, you can save the connection without setting the database account and password.
   Environment	You can select an environment type as needed. Valid values: dev, sit, and prod.

   Note

   For more information about data source configurations, see Manage data sources.

4. Click OK in the lower-right corner of the panel. In the dialog box that appears, enter the name of the data source.

   

Edit and execute SQL statements

Example: In the SQL window, create a table in the target database.

1. In the SQL window, click Select a database.

   

2. In the Switch Database dialog box, select the database of the project.

   

3. In the SQL window, write an SQL statement to create a table named employee.

   

   CREATE TABLE odc_test.employee (
   emp_no int(120) COMMENT 'Employee ID' NOT NULL,
   birthday date COMMENT 'Birthday' NULL,
   name varchar(120) COMMENT 'Name' NULL,
   CONSTRAINT cons_employee_empno PRIMARY KEY (emp_no)) DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_general_ci;
   

4. After you complete writing SQL statements, click Press F8 in the toolbar to run all SQL statements in the current SQL window.

   The following table describes the icons related to SQL statement execution.

   Icon	Description
   Press F8	Click this icon to run all SQL statements in the current SQL window.
   Run Current Statement (F9)	Click this icon to run all selected SQL statements or the statement in the line where the pointer hovers.
   Abort	Click this icon to abort the statements being executed.

   

5. On the Result tab, you can view the execution records and logs.

   

References

• Manage user permissions

• Manage data sources

• Project collaboration management

• SQL development