项目协同管理

背景信息

Web 版 ODC V4.2.0 及之后的版本支持拥有创建项目权限的用户创建项目和添加项目成员,成员可以在项目中添加和变更数据库。

本篇文档旨在介绍如何通过项目协同实现数据库变更。

原理介绍

image.png

  1. ODC 系统管理员授予用户创建项目的角色后,该用户创建项目并添加项目成员。

  2. 项目管理员/ DBA 成员添加数据库。

  3. 项目普通成员发起工单,申请数据库变更。

  4. ODC 根据风险等级识别规则判断出该工单的风险等级,执行该风险等级对应的审批流程。

  5. 审批通过后,ODC 自动执行或者用户手动执行数据库变更。

  6. 项目中所有工单已执行完成并且无启用的周期任务后,项目管理员归档项目。项目归档后将不可恢复,且不再支持任何协同开发活动,并会释放项目中添加的数据库和敏感列。

  7. 项目归档后,项目管理员删除项目。项目删除后所有数据不可恢复。

创建项目

方法一:拥有创建项目角色的用户创建项目。

重要
  1. 系统管理员授予用户创建项目的权限。

    image

  2. 项目管理员创建项目并添加项目成员。

    说明

    拥有创建项目权限的 ODC 用户可以创建项目。默认情况下,项目创建者被授予该项目管理员角色。项目管理员通过在项目中配置 ODC 所属的用户为该项目的成员后,项目成员可以在使用自己的账号登录 ODC 时访问该项目,并在同一个项目中进行团队协作。

    image

    信息项

    说明

    项目名称

    指定项目名称

    管理员

    拥有项目内的所有权限

    DBA

    拥有项目内除成员管理、消息配置和项目设置外的所有权限

    开发者

    允许登录所有数据库、执行 SQL、提交工单,通常是开发人员。

    安全管理员(可选)

    在参与者的基础上,同时可以管理敏感列

    参与者(可选)

    允许查看项目基本信息,并自助申请库权限和提交工单

    描述(可选)

    非必填项。

方法二:加入项目

ODC 用户可以通过 申请项目权限 加入已创建的项目。

  1. 通过 项目/工单 加入项目

    a. 通过项目入口申请。

    image.png

    b. 通过工单入口申请。

    image.png

  2. 选择项目、项目角色并输入申请原因后,单击 新建,创建项目权限申请。

    image.png

  3. 在工单中查看审批状态。

    image.png

  4. 审批通过后,可以在项目列表中查看已加入的项目。

    image.png

归档项目

项目中所有工单已执行完成并且无启用的周期任务后,项目管理员可以将不再使用的项目进行归档。

重要
  • 项目归档后将不可恢复,且不再支持任何协同开发活动,释放项目中添加的数据库和敏感列。

  • 如果归档项目时分区计划任务未终止,项目归档后,该分区计划任务会被自动终止。

  1. 在项目列表中,选择需要归档的项目名称。

    image

  2. 在项目的设置页签中,单击 归档项目

    image

  3. 单击 确定,归档该项目。

    image

  4. 归档完成后,您可以在 归档项目 列表中查看已归档的项目。

    image

删除项目

项目归档完成后,项目管理员可以删除已归档的项目。

重要

项目删除后所有数据不可恢复。

  1. 在 归档项目 列表中,单击归档项目名称右侧的更多图标并选择 删除项目 删除单个项目,或者勾选归档项目名称并单击工具栏中的 删除项目 批量删除项目。

    image

  2. 在删除归档项目弹窗中,输入 delete 并单击 删除,删除归档项目。

    image

数据库管理

方法一:拥有数据库权限的用户添加数据库

  1. 单击项目名称,进入该项目管理页面。

    image

  2. 在数据库页面中添加数据库。

    image

  3. 项目成员可以导出/导入/变更/登录数据库,并支持将数据库转移到其它项目中。

    image

方法二:申请数据库权限

重要
  • 申请数据库权限,ODC 用户须确认已加入项目。

  • ODC 用户仅支持申请已加入项目中的数据库权限。

ODC 用户可以通过 申请库权限 以获取查询/导出/变更数据库权限。

  1. 项目/工单 中,单击 申请库权限

    1. 通过项目入口申请。

      image

    2. 通过工单入口申请。

      image

  2. 选择项目、数据库、数据库权限类型、权限有效期并输入申请原因后,单击 新建,创建库权限申请。

    image

添加对象存储

ODC V4.3.3 及之后的版本支持在项目中添加对象存储文件,对象存储类型包括:阿里云 OSS、腾讯云 COS、华为云 OBS 和 AWS S3。您可以将添加的对象存储文件数据归档至其它数据库中。

  1. 单击项目名称,进入该项目管理页面。

    image

  2. 在数据库页面中,单击 添加对象存储

    image

  3. 在 添加对象存储 页面,配置所属数据源和库管理员信息并单击 确定,添加对象存储文件。

    image

/视图管理

项目成员可以申请项目中任何数据库下的表/视图权限。

项目成员可以通过 申请表/视图权限 以获取查询/导出/变更表或者视图权限。

重要
  • ODC 用户仅支持申请已加入项目中的表权限。

  • 如果表或者数据库转移到其它数据库或者项目,原有的表权限将会失效。

  1. 项目/工单 中,单击 申请表权限

    a. 通过项目入口申请。

    image

    b. 通过工单入口申请。

    image

  2. 选择项目、表/视图、权限类型、权限有效期并输入申请原因后,单击 新建,创建表/视图权限申请。

    image

  3. 申请完成后,项目成员可以根据申请的权限类型对表/视图进行管理。

    • 拥有表的查询权限:可在 SQL 窗口中执行该表的查询语句。

    • 拥有表的变更权限:可在 SQL 窗口中执行该表的变更语句。

    • 拥有表的导出权限:可发起该表的导出工单。

    • 拥有视图的查询权限:可在 SQL 窗口中执行该视图的查询语句。

    • 拥有视图的导出权限:可发起该视图的导出工单。

    • 拥有数据库的查询权限:可在 SQL 窗口中执行该数据库下的查询语句。

    • 拥有数据库的变更权限:可在 SQL 窗口中执行该数据库下的变更语句、发起除导出和导出结果集之外的工单。

    • 拥有数据库的导出权限:可发起数据库导出工单。

    • 拥有数据库的查询和导出权限:可发起导出结果集工单。

    相关操作请参见 SQL 语句创建和管理表可视化方式创建和管理表数据库变更管理新建视图

工单管理

无数据库编辑权限的项目普通成员可以通过工单申请执行导出数据/导入数据/模拟数据/数据库变更/无锁结构变更/SQL 计划/数据归档任务。

image

成员管理

项目管理员可以在成员页面中,添加/编辑/移除成员,以及管理库/表权限。

image

消息通知

项目成员可以在消息通知页面中启用需要通知的工单事件类型和添加推送通道(钉钉/飞书/企业微信/自定义 webhook),当启用的工单事件发生变更时,ODC 会发送变更消息提示项目成员。配置方法请参见 消息通知管理

image

项目设置

项目管理员可以在设置页面中修改项目名称和归档项目。

image

相关文档