Project collaboration management

Background information

Web OceanBase Developer Center (ODC) V4.2.0 and later allow a user with the project creation permission to create a project and add members to the project. A project member can add and change databases in the project.

This topic describes how to implement database changes through project collaboration.

Technical mechanism

1. The ODC system administrator grants the project creation permission to a user. Then, the user can create a project and add members to the project.

2. The project administrator or database administrator (DBA) adds a database to the project.

3. A project member initiates a database change ticket.

4. ODC determines the risk level of this ticket based on the risk level identification rules and selects the corresponding approval process for this ticket.

5. After the ticket is approved, the database change is automatically executed by ODC or manually executed by the user.

6. The project administrator archives the project after all tickets in the project are executed and no active scheduled tasks exist. Databases and sensitive columns added to the project are released when it is archived. An archived project is unrecoverable and no longer supports any collaboration activities.

7. After the project is archived, the project administrator deletes the project. The project configuration data of a deleted project is unrecoverable.

Create a project

Method 1: Create a project as a user with the project creation permission

1. The system administrator grants the project creation permission to a user.

   

2. The project administrator creates a project and adds members to the project.

   

   Note

   An ODC user with the project creation permission can create projects. By default, the user who creates a project is granted the administrator role of this project. After the project administrator assigns ODC users as members of the project, the members can access this project after logging in to the ODC console with their own accounts, and work as a team in the project.

   Parameter	Description
   Project Name	The name of the project.
   Administrator	A user that has all permissions of the project.
   DBA	A user that has all permissions of the project, except for member management, message configuration, and project setting.
   Developer (Optional)	A user that can log in to all databases, execute SQL statements, and submit tickets, who is usually a developer.
   Security Administrator (Optional)	A user that has all participant permissions and can manage sensitive columns of the project.
   Participant (Optional)	A user that can view basic information of the project, request database permissions, and submit tickets.
   Description (Optional)	The description of the user.

Method 2: Join a project

An ODC user can apply for project permissions to join an existing project.

1. On the Projects or Tickets tab, click the corresponding button to apply for project permissions.

   a. Apply for permissions on the Projects tab.

   

   b. Apply for permissions on the Tickets tab.

   

2. Select a project, specify a role, enter the reason for application, and then click Apply.

   

3. View the approval status on the Tickets tab.

   

4. View the project that you joined in the project list.

   

Archive a project

After all tickets in a project are executed and no active scheduled tasks exist, and the project is no longer in use, the project administrator can archive the project.

1. In the project list, click the name of the project to be archived.

   

2. On the Settings tab of the project, click Archive Project.

   

3. In the dialog box that appears, click OK.

   

4. When the project is archived, you can view it on the Archived Projects tab.

   

Delete a project

The project administrator can delete an archived project.

1. On the Archived Projects tab, click the More icon in the row of the archived project and select Delete Project. To batch delete archived projects, select the archived projects and click Delete Project on top of the project list.

   

2. In the dialog box that appears, type delete and click Delete.

   

Manage databases

Method 1: Add a database as a user with database permissions

1. Click the name of a project to go to the project management page.

   

2. Add a database.

   

3. A member can export data, import data, perform database changes, and log in to databases. The project administrator or DBA can set a database administrator and change the project to which a member belongs.

   

   Note

   If a data source has been bound to a project, you cannot transfer the databases in the data source to other projects.

Method 2: Apply for database permissions

You can apply for the query, export, and change permissions on databases.

1. On the Projects or Tickets tab, click the corresponding button to apply for database permissions.

   a. Apply for permissions on the Projects tab.

   

   b. Apply for permissions on the Tickets tab.

   

2. Select the project, databases, permission types, and permission validity period, enter the reason for application, and then click Apply.

   

Manage logical databases

ODC V4.3.2 and later allow you to configure a logical database and a logical table for one or more physical databases, in order to query and manage huge database and table shards.

ODC V4.3.2 only supports the structural changes of logical databases and the configuration of risk level specifications in security specifications.

Relationship between physical and logical databases

1. You can configure a logical database for one or more physical databases with the same data source and in the same environment.

2. After a logical database is configured, ODC automatically parses the database, retrieves physical tables with similar names and same structure from the database, stores these tables into a logical table, and generates an expression for this logical table.

   Note

   • No logical table will be generated if a physical table structure is unique in the logical database.
   • The default name of the generated logical table consists of the non-number strings shared by the retrieved physical tables. For example, if the names of the retrieved physical tables are db.test_0, db.test_1, db.test_2, and db.test_3, the generated logical table is named test, and its expression is db.test_[0-3]. For more information, see the description of logical table expression rules.

Configure logical databases

1. Click the name of a project to go to the project management page.

   

2. On the Database tab, click Add Database and select Configure Logical Database from the drop-down list.

   

3. In the panel that appears, specify the following parameters.

   

   Parameter	Description
   Base Database	Select a database as the benchmark. The database must be included in the logical database to specify the database environment and type. ODC can filter databases based on the benchmark database information, such as the name, environment, and type.
   Logical Database Name	The name of the logical database, that is, the prefix shared among the names of the selected physical databases. For example, the name of the logical database configured for physical databases foo00 to foo99 is foo.
   Logical Database Alias	The alias is used to distinguish logical databases with the same name. By default, the alias is the same as the actual logical database name. The value must be unique and cannot be modified.
   Database	Select a database.

4. Click Submit.

List of logical databases

You can find the list of configured logical databases on the Database tab.

You can click the corresponding button in the Actions column to perform the following operations.

• Manage a logical table: ODC supports automatic data extraction and manual creation of a logical table.

  

• Create a logical database change task. For more information, see Logical change management.

• Manage databases in the SQL development window after login.

• Remove a logical database.

Add an object storage service

ODC V4.3.3 and later allow you to add files of the following object storage services to a project: Alibaba Cloud Object Storage Service (OSS), Tencent Cloud Object Storage (COS), Huawei Object Storage Service (OBS), and Amazon Simple Storage Service (S3). You can archive added object store files to other databases.

1. Click the name of a project to go to the project management page.

   

2. On the Database tab, click Add Database and select Add Object Storage from the drop-down list.

   

3. In the Add Object Storage dialog box, specify the data source and DBA information and click OK.

   

Manage tables and views

A project member can apply for permissions on tables and views in any database in the project.

A project member can click Table Permission Application to apply for the query, export, and change permissions on tables and views.

1. On the Projects or Tickets tab, click Table Permission Application to apply for table permissions.

   a. Apply for permissions on the Projects tab.

   

   b. Apply for permissions on the Tickets tab.

   

2. Select the project, tables, views, permission types, and permission validity period, enter the reason for application, and then click Apply.

   

3. After the application, you can manage tables and views based on the permission types.

   • If you have the query permission on a table, you can execute query statements on the table in the SQL window.
   • If you have the change permission on a table, you can execute change statements on the table in the SQL window.
   • If you have the export permission on a table, you can initiate a ticket to export the table.
   • If you have the query permission on a view, you can execute query statements on the view in the SQL window.
   • If you have the export permission on a view, you can initiate a ticket to export the view.
   • If you have the query permission on a database, you can execute query statements on the database in the SQL window.
   • If you have the change permission on a database, you can execute change statements on the database in the SQL window and initiate tickets for the database except regular export tickets and result set export tickets.
   • If you have the export permission on a database, you can initiate export tickets for the database.
   • If you have the query and export permissions on a database, you can initiate a result set export ticket for the database.

   For more information, see Create and manage tables in SQL, Visually create and manage tables, Database change management, and Create a view.

Manage tickets

A project member without the database editing permission can submit a ticket to execute a data export, data import, data mocking, database change, online schema change, SQL plan, or data archiving task.

Manage members

The project administrator can add, edit, or remove members as well as manage database and table permissions on the Members tab.

Configure message notifications

A project member can specify the ticket events for which notifications are sent and add notification channels such as DingTalk, Lark, WeCom, and custom webhooks on the Notification tab. When a specified ticket event occurs, ODC sends a change message to notify the project member. For more information about notification management, see Overview.

Configure project settings

The project administrator can rename the project and archive the project on the project settings page.

References

• Risk level, risk identification rule, and approval process management

• SQL check specifications

• SQL window specifications

• Create a data source

• Database change management

• Import schemas and data

• Export schemas and data

• Users and roles