跳到主要内容

Git 项目变更发布

NineData 支持在 SQL 窗口中管理 Git 项目文件,对文件版本进行比较并生成变更 SQL,然后将变更提交为 SQL 任务、结构设计与发布任务,或加入已有的结构设计与发布任务。

前提条件​

  • 已创建可通过 HTTPS 访问的 Git 项目,并准备具有项目访问权限的账号和密码或访问令牌。
  • 已在 NineData 中创建用于执行变更的数据源。
  • 本功能当前用于关系型数据库;NoSQL、Elasticsearch、向量数据库和 Milvus 不在本阶段范围内。

步骤一:配置 Git 项目​

  1. 登录 NineData 控制台,进入系统配置 > Git 配置。

  2. 单击新增 Git 配置,配置以下参数。

    参数说明
    协议类型选择 Https。
    项目名称输入项目名称。
    项目地址输入 Git 项目的 HTTPS Clone 地址。
    用户名输入具有项目访问权限的用户名。
    密码输入密码或访问令牌。
    邮箱输入用于 Git Commit 的邮箱。
  3. 在表单中完成连接测试。测试成功后,单击保存 Git 配置。保存配置时,NineData 会同步克隆 Git 项目;首次同步所需时间取决于项目大小。

警告

不要将密码或访问令牌写入 SQL 文件或提交到 Git 项目。建议使用权限范围最小且可以定期轮换的访问令牌。

步骤二:在 Git 工作区管理文件​

  1. 打开 SQL 窗口,切换到工作空间。

  2. 选择 Git 项目和目标分支,必要时单击 Pull 同步远程最新内容。

  3. 在文件目录树中打开或编辑目标文件。Git 工作区提供 Commit、Push 和 Pull 操作;完成本地修改后,先执行 Commit,再执行 Push。

    • 选择分支时,NineData 会切换本地已克隆的分支;远程分支会先拉取再切换。
    • 多个文件的编辑会更新本地缓存,并可合并为一次提交。文件失去焦点或超过一段时间没有输入时,页面会更新服务端缓存。
    • Git 冲突或 Push、Pull 错误不会在页面内自动处理,需根据当前控制台返回的错误信息处理。

步骤三:生成变更 SQL​

  1. 在 Git 工作区中选择需要发布的文件版本并执行版本比较。

  2. 查看生成的变更 SQL。表文件生成增量变更脚本,非表文件生成全量变更脚本。

步骤四:提交变更任务​

  1. 根据发布方式选择一种提交类型。

    提交类型说明
    新建 SQL 任务携带变更 SQL 和当前数据源信息,创建 SQL 任务。
    新建结构设计与发布任务携带变更 SQL 和当前数据源信息,创建结构设计与发布任务。
    加入已有任务将变更 SQL 加入已有的结构设计与发布任务。
  2. 选择加入已有任务时,请确认数据源、数据库和 Schema 与当前环境一致,且当前用户是该任务的相关人员;目标任务必须仍处于首个节点并且未结束、终止或成功。

  3. 确认变更 SQL 和目标信息,单击提交并跳转。新建任务会跳转到相应创建页,加入已有任务会跳转到该结构设计与发布任务详情页。

相关文档​