Use Web ODC

This topic describes some basic operations for using Client ODC.

Create a user

Example: Create a user named ODCUSER1 in OceanBase Developer Center (ODC) as the administrator and grant the permissions of the system_admin role to the user.

1. Log on to Web ODC. In the left-side navigation pane of the project collaboration window, choose User Permissions > Users. On the Users tab, click Create User.

   

2. On the Create User page, complete the user and role settings.

   

   The role settings are optional. You can assign multiple roles to a user. Click the textbox. All roles created in the organization are displayed in the drop-down list. Select the roles that you want to assign to the created user. If no role is available, go to the Create Role page to create one.

3. Click Create to submit the information.

Create a data source

Create an OceanBase data source

Example: Create an OceanBase data source in MySQL mode in 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 of the project collaboration window, choose Data Sources > Create Data Source > OceanBase MySQL.

   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	By default, the selected data source type is displayed.
   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 Address/Domain 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 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.

   

Create a MySQL data source

Example: Create a MySQL data source in ODC.

1. Log on to Web ODC. In the left-side navigation pane of the project collaboration window, choose Data Sources > Create Data Source > MySQL.

   

2. 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	By default, the selected data source type is displayed.
   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.
   Database Account	Database User Name: the username of an account created in the MySQL database. Database Password: the password of the account created in the MySQL database. 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. 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.

3. After you specify the preceding information, click OK in the lower-right corner of the panel.

4. In the dialog box that appears, enter the data source name and click OK. The data source is then saved to the data source list of ODC.

   

Create a project

1. Grant the project creation permission to the user as the system administrator of ODC.

   

2. Choose Projects > All Projects and click Create Project.

   

3. On the Create Project tab, configure the following parameters.

   

   Parameter	Description
   Project Name	The name of the project to be created.
   Administrator	The administrator that can manage all databases and members of the project.
   DBA	The administrator that can manage all databases in the project.
   Member (optional)	A member allowed to access all databases in the project.
   Description (optional)	The description of the project.

4. Click OK.

Add a database to the project

Example: Add the odc_test database to the odc_4.2.0 project.

1. Choose Projects > All Projects. On the tab that appears, click the project name odc_4.2.0.

   

2. On the Databases tab, click Add Database.

   

3. In the Add Database dialog box, select the created data source mysql410 and database odc_test, and then click OK.

   

4. In the database list, view the added database odc_test.

   

5. Click the database name odc_test in the database list, click Log on to Database in the upper-right corner of the Databases tab, or click Log on to Database in the Actions column of the database to log on to the database.

   

6. Go to the SQL window.

   

Edit and execute SQL statements

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

1. In the odc_4.2.0 project, click Log on to Database to go to the SQL window.

   

2. In the SQL window, edit SQL statements 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;
   

   In the SQL window shown in the preceding figure, click to switch to another database.

3. After you complete editing 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.

   

4. On the result tab, you can view the execution records and logs.

   

Create a database change task

Example: Change the value of name in the employee table in the odc_test database from xiaoguo to xiaofeng.

1. Choose Projects > All Projects. On the tab that appears, click the project name odc_4.2.0.

   

2. On the Ticket tab, choose Database Change > Create Database Change Task.

   

3. In the Create Database Change Task panel, configure the following parameters.

   

4. Click Create.

   The database change task is created.

5. On the Ticket tab, you can view the approval status and basic information of the task in the database change task list.

References

• Manage user permissions

• Manage data sources

• Project collaboration management

• SQL development