Background information
In ODC for Web V4.2.0 and later, users with project creation permissions can create projects and add project members. Members can add and change databases in a project.
This topic describes how to make database changes using project collaboration.
How it works
An ODC system administrator grants a user the project creation role. The user can then create a project and add members.
A project administrator or DBA member adds a database.
A regular project member submits a ticket to request a database change.
ODC identifies the risk level of the ticket based on its rules and starts the corresponding approval flow.
After approval, ODC automatically executes the database change, or a user executes it manually.
When all tickets in the project are complete and no auto triggered tasks are enabled, the project administrator can archive the project. An archived project cannot be recovered and no longer supports collaborative development. The databases and sensitive columns in the project are also released.
After archiving the project, the project administrator can delete it. All data is permanently lost when a project is deleted.
Create a project
Method 1: Create a project as a user with the project creation role
When a new user with AdministratorAccess or AliyunOceanBaseFullAccess permissions logs on to ODC for the first time, the user is automatically granted the system_admin role.
Users who log on to ODC again are not automatically granted the system_admin role. You must grant the system_admin role to these users within ODC.
By default, the system_admin role is granted to the Alibaba Cloud account.
When logging on with a Normandy account, only administrators can log on to ODC and use the personal space.
A system administrator grants a user the permission to create projects.
The project administrator creates a project and adds members.
NoteODC users with project creation permissions can create projects. By default, the project creator is granted the project administrator role. The project administrator can configure ODC users as project members. These members can then access the project and collaborate with the team by logging on to ODC with their own accounts.
Item
Description
Project name
Specify the project name.
Administrator
Has all permissions within the project.
DBA
Has all permissions within the project except for member management, message configuration, and project settings.
Developer
Can log on to all databases, execute SQL, and submit tickets. This role is usually for developers.
Security administrator (Optional)
In addition to the permissions of a participant, can also manage sensitive columns.
Participant (Optional)
Can view basic project information, and request database permissions and submit tickets.
Description (Optional)
This item is not required.
Method 2: Join a project
ODC users can join an existing project by requesting project permissions.
Join a project from the Project or Ticket page.
a. Request from the project entry point.
b. Request from the ticket entry point.
Select a project and a project role. Enter a reason for the request. Click Create to submit the project permission request.
Check the approval status in your tickets.
After your request is approved, you can view the project you joined in the project list.
Archiving projects
When all tickets in a project are complete and no auto triggered tasks are enabled, a project administrator can archive the project if it is no longer in use.
An archived project cannot be recovered. It no longer supports collaborative development. The databases and sensitive columns added to the project are also released.
If a scheduled partitioning task is not stopped when the project is archived, the task is automatically stopped after the project is archived.
In the project list, select the name of the project to archive.
On the Settings tab of the project, click Archive Project.
Click OK to archive the project.
After the project is archived, you can view it in the Archived Projects list.
Delete a project
After a project is archived, the project administrator can delete it.
All data is permanently lost after a project is deleted.
In the Archived Projects list, click the More icon next to the project name and select Delete Project to delete a single project. To delete multiple projects in a batch, select the checkboxes next to the project names and click Delete Project in the toolbar.
In the confirmation dialog box, enter
deleteand click Delete to delete the archived project.
Database management
Method 1: Add a database as a user with database permissions
Click the project name to go to the project management page.
On the Databases page, add a database.
Project members can export, import, change, and log on to the database. They can also transfer the database to other projects.
Method 2: Request database permissions
To request database permissions, an ODC user must have already joined a project.
ODC users can only request permissions for databases in projects they have joined.
ODC users can request permissions to query, export, or change a database by clicking Request DB Permissions.
On the Project or Ticket page, click Request DB Permissions.
Request from the project entry point.
Request from the ticket entry point.
Select the project, database, permission type, and validity period. Enter a reason for the request. Click Create to submit the database permission request.
Add Object Storage Service
ODC V4.3.3 and later lets you add object storage files to a project. Supported object storage types include Alibaba Cloud OSS, Tencent Cloud COS, Huawei Cloud OBS, and AWS S3. You can then archive the data from these object storage files to other databases.
Click the project name to go to the project management page.
On the Databases page, click Add Object Storage.
On the Add Object Storage page, configure the data source and database administrator information. Click OK to add the object storage file.
Table/View management
Project members can request permissions for tables or views in any database within the project.
Project members can request permissions to query, export, or change a table or view by clicking Request Table/View Permissions.
ODC users can only request permissions for tables in projects they have joined.
If a table or database is transferred to another database or project, the original table permissions become invalid.
On the Project or Ticket page, click Request Table Permissions.
a. Request from the project entry point.
b. Request from the ticket entry point.
Select the project, table/view, permission type, and validity period. Enter a reason for the request. Click Create to submit the table/view permission request.
After the request is approved, project members can manage the table or view according to the granted permission type.
Query permission for a table: Allows you to execute query statements on the table in the SQL window.
Change permission for a table: Allows you to execute change statements on the table in the SQL window.
Export permission for a table: Allows you to submit a ticket to export the table.
Query permission for a view: Allows you to execute query statements on the view in the SQL window.
Export permission for a view: Allows you to submit a ticket to export the view.
Query permission for a database: Allows you to execute query statements on the database in the SQL window.
Change permission for a database: Allows you to execute change statements on the database in the SQL window and submit tickets for tasks other than exporting data and exporting result sets.
Export permission for a database: Allows you to submit a database export ticket.
Query and export permissions for a database: Allows you to submit a ticket to export a result set.
For more information, see Create and manage tables using SQL statements, Create and manage tables using the visualization feature, Database change management, and Create a view.
Ticket management
Regular project members who do not have database editing permissions can submit tickets to request tasks such as data export, data import, mock data, database changes, lock-free schema changes, SQL plans, and data archiving.
Member management
On the Members page, project administrators can add, edit, or remove members, and manage database and table permissions.
Message notifications
On the Message Notifications page, project members can enable notifications for specific ticket event types and add push channels, such as DingTalk, Lark, WeCom, or custom webhooks. When a change occurs for an enabled event type, ODC sends a notification to project members. For more information about how to configure notifications, see Manage message notifications.
Project settings
On the Settings page, project administrators can change the project name and archive the project.
