Files
community/docs/database.md
T

7.7 KiB

数据库初始化

业务数据库名为 community,只包含以下四张表。由人工执行;应用不运行迁移或自动建表。以下 SQL 面向 MySQL 8.0.13 及以上(URDF JSON 默认值使用表达式)。

CREATE DATABASE IF NOT EXISTS community CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
USE community;

CREATE TABLE sys_user (
  id BIGINT NOT NULL AUTO_INCREMENT COMMENT '内部用户主键',
  user_code CHAR(32) NOT NULL COMMENT '用户业务编码',
  email VARCHAR(254) NOT NULL COMMENT '规范化后的登录邮箱',
  nickname VARCHAR(100) NOT NULL COMMENT '用户昵称',
  status VARCHAR(16) NOT NULL DEFAULT 'ACTIVE' COMMENT '账号状态',
  created_at DATETIME(3) NOT NULL COMMENT '创建时间 UTC',
  updated_at DATETIME(3) NOT NULL COMMENT '更新时间 UTC',
  PRIMARY KEY (id),
  UNIQUE KEY uk_user_code (user_code),
  UNIQUE KEY uk_user_email (email)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='平台用户';

CREATE TABLE project (
  id BIGINT NOT NULL AUTO_INCREMENT COMMENT '内部项目主键',
  project_code CHAR(32) NOT NULL COMMENT '项目业务编码',
  owner_user_id BIGINT NOT NULL COMMENT '所属平台用户',
  name VARCHAR(100) NOT NULL COMMENT '项目名称',
  description TEXT NOT NULL COMMENT '项目描述',
  cover_url VARCHAR(2048) NULL COMMENT '封面图片 HTTPS 地址',
  urdf_main_object_key VARCHAR(512) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL DEFAULT '' COMMENT 'URDF主文件OSS对象键,不保存完整URL',
  urdf_files JSON NOT NULL DEFAULT (JSON_ARRAY()) COMMENT 'URDF文件清单数组,元素包含relativePath和sizeBytes,相对路径以urdf_prefix为基准',
  urdf_prefix VARCHAR(512) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL DEFAULT '' COMMENT 'URDF资源OSS目录前缀,包含环境根目录和上传批次,以斜杠结尾',
  project_type VARCHAR(64) NOT NULL COMMENT '配置中的项目类型编码',
  gitea_repo_id BIGINT NULL COMMENT 'Gitea 仓库标识',
  gitea_owner VARCHAR(100) NOT NULL COMMENT 'Gitea 仓库所属组织',
  gitea_repo_name VARCHAR(100) NOT NULL COMMENT 'Gitea 仓库名称',
  repo_status VARCHAR(16) NOT NULL DEFAULT 'CREATING' COMMENT '仓库状态 CREATING READY FAILED',
  publish_status VARCHAR(16) NOT NULL DEFAULT 'UNPUBLISHED' COMMENT '社区状态 UNPUBLISHED PUBLISHED',
  published_commit_sha VARCHAR(64) NULL COMMENT '社区已发布 Commit SHA',
  published_at DATETIME(3) NULL COMMENT '最近发布时间 UTC',
  source_project_id BIGINT NULL COMMENT 'Fork 来源项目',
  source_commit_sha VARCHAR(64) NULL COMMENT 'Fork 来源已发布 Commit SHA',
  deleted TINYINT(1) NOT NULL DEFAULT 0 COMMENT '逻辑删除标识',
  created_at DATETIME(3) NOT NULL COMMENT '创建时间 UTC',
  updated_at DATETIME(3) NOT NULL COMMENT '更新时间 UTC',
  PRIMARY KEY (id),
  UNIQUE KEY uk_project_code (project_code),
  UNIQUE KEY uk_project_repo (gitea_owner, gitea_repo_name),
  UNIQUE KEY uk_project_repo_id (gitea_repo_id),
  KEY idx_project_owner (owner_user_id, deleted, created_at),
  KEY idx_project_community (publish_status, deleted, published_at),
  KEY idx_project_type (publish_status, deleted, project_type, published_at),
  CONSTRAINT fk_project_owner FOREIGN KEY (owner_user_id) REFERENCES sys_user(id),
  CONSTRAINT fk_project_source FOREIGN KEY (source_project_id) REFERENCES project(id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='用户项目与社区发布';

CREATE TABLE project_comment (
  id BIGINT NOT NULL AUTO_INCREMENT COMMENT '内部评论主键',
  comment_code CHAR(32) NOT NULL COMMENT '评论业务编码',
  project_id BIGINT NOT NULL COMMENT '所属项目',
  user_id BIGINT NOT NULL COMMENT '评论用户',
  content TEXT NOT NULL COMMENT '纯文本评论内容',
  deleted TINYINT(1) NOT NULL DEFAULT 0 COMMENT '逻辑删除标识',
  created_at DATETIME(3) NOT NULL COMMENT '创建时间 UTC',
  updated_at DATETIME(3) NOT NULL COMMENT '更新时间 UTC',
  PRIMARY KEY (id),
  UNIQUE KEY uk_comment_code (comment_code),
  KEY idx_comment_project (project_id, deleted, created_at),
  CONSTRAINT fk_comment_project FOREIGN KEY (project_id) REFERENCES project(id),
  CONSTRAINT fk_comment_user FOREIGN KEY (user_id) REFERENCES sys_user(id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='项目评论';

CREATE TABLE project_like (
  id BIGINT NOT NULL AUTO_INCREMENT COMMENT '内部点赞主键',
  project_id BIGINT NOT NULL COMMENT '所属项目',
  user_id BIGINT NOT NULL COMMENT '点赞用户',
  created_at DATETIME(3) NOT NULL COMMENT '点赞时间 UTC',
  PRIMARY KEY (id),
  UNIQUE KEY uk_like_project_user (project_id, user_id),
  CONSTRAINT fk_like_project FOREIGN KEY (project_id) REFERENCES project(id),
  CONSTRAINT fk_like_user FOREIGN KEY (user_id) REFERENCES sys_user(id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='项目点赞';

内部 ID 仅用于数据库关联,对外使用业务编码。时间均由后端写入 UTC。CREATING 项目表示仓库初始化未完成,不代表编辑草稿。Gitea 数据库与业务库分离,不修改 Gitea 内部表。

新增项目和用户使用 12 位小写字母和数字编码,历史 32 位编码继续保留。现有 project_code CHAR(32) 和 user_code CHAR(32) 可容纳两者,不需要修改表结构或历史记录;仓库名称仍为 p_{projectCode}。用户编码由安全随机数生成,唯一索引兜底,冲突时最多尝试 5 次;同一邮箱并发注册复用已有用户。评论编码保持 32 位。GitHub 运维导入的来源和进度保存于批次状态目录,GitHub 来源不占用社区内部 Fork 来源字段。

已有数据库增加项目封面

已使用旧版结构的环境,先在对应业务库执行以下 SQL,再部署新版本应用;新建数据库已包含此字段,不重复执行。应用不会自动迁移数据库。

ALTER TABLE project
  ADD COLUMN cover_url VARCHAR(2048) NULL COMMENT '封面图片 HTTPS 地址' AFTER description;

历史项目的封面为 NULL。字段保存固定公开地址,可以来自 OSS、CDN 或外部 HTTPS 图片;不存储临时签名下载地址。替换、清除封面和删除项目不会自动删除 OSS 对象,Fork 可能共用同一地址。

已有数据库增加项目 URDF

先在对应业务库手动执行以下 SQL,再部署应用;新建数据库已包含三个字段,不重复执行。不要在应用启动时自动迁移。

ALTER TABLE project
  ADD COLUMN urdf_main_object_key VARCHAR(512)
    CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL DEFAULT ''
    COMMENT 'URDF主文件OSS对象键,不保存完整URL',
  ADD COLUMN urdf_files JSON NOT NULL DEFAULT (JSON_ARRAY())
    COMMENT 'URDF文件清单数组,元素包含relativePath和sizeBytes,相对路径以urdf_prefix为基准',
  ADD COLUMN urdf_prefix VARCHAR(512)
    CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL DEFAULT ''
    COMMENT 'URDF资源OSS目录前缀,包含环境根目录和上传批次,以斜杠结尾';

未上传或已清除时,两个字符串均为 '',文件清单为 []。每个项目只绑定一个当前资源包,包内必须恰好有一个 .urdf(忽略扩展名大小写)。清单包含全部文件,例如 [{"relativePath":"urdf/robot.urdf","sizeBytes":1234},{"relativePath":"meshes/base.stl","sizeBytes":5678}]。

前缀为 {环境根目录}/urdf/{projectCode}/{batchCode}/,主文件对象键为此前缀加主文件相对路径。数据库不保存完整 URL;接口根据 OSS/CDN 配置生成并编码 URL。替换、清除、删除项目不物理删除对象,公开旧链接仍可读取;Fork 复制到新项目的独立目录,不共用源前缀。URDF 不进入 Gitea、不生成 Commit,更新立即影响社区展示。