Files
community/docs/cad-database.md
T

5.0 KiB

CAD 工作空间建表 SQL

在启用 CAD 接口前,由运维在现有 vibemake 数据库手工执行以下 SQL(MySQL 8.0.13+)。应用不自动建表,不修改现有项目表。所有业务时间按上海时间写入。

id 和归属外键仅供服务内部使用,对外使用 cad_project_code 和 upload_code。两张表与 Git 项目无关联。上线顺序:执行 SQL → 部署后端 → 验证共用 OSS 配置及文件读取 → 开放前端入口。回滚代码时保留两张表和 OSS 对象。

CREATE TABLE cad_project (
    id BIGINT NOT NULL AUTO_INCREMENT COMMENT '内部主键,不对外返回',
    cad_project_code VARCHAR(32) CHARACTER SET ascii COLLATE ascii_bin NOT NULL COMMENT 'CAD项目唯一业务编码',
    owner_user_id BIGINT NOT NULL COMMENT '所属用户内部主键,关联sys_user.id',
    name VARCHAR(100) NOT NULL COMMENT 'CAD项目名称',
    description VARCHAR(2000) NOT NULL DEFAULT '' COMMENT 'CAD项目描述',
    cover_url VARCHAR(2048) NULL COMMENT 'CAD项目封面,平台OSS资源存无环境前缀的相对路径',
    document_object_key VARCHAR(512) CHARACTER SET ascii COLLATE ascii_bin NOT NULL DEFAULT '' COMMENT '当前设计文件环境相对路径,以斜杠开头,不含域名和环境根目录',
    file_name VARCHAR(255) NOT NULL DEFAULT '' COMMENT '当前原生设计文件名称',
    size_bytes BIGINT NOT NULL DEFAULT 0 COMMENT '当前设计文件大小,单位字节',
    version BIGINT NOT NULL DEFAULT 0 COMMENT '当前保存版本,空项目为0,每次成功保存递增',
    saved_at DATETIME(3) NULL COMMENT '最近成功保存设计文件的上海时间',
    deleted TINYINT NOT NULL DEFAULT 0 COMMENT '逻辑删除标记,0未删除,1已删除',
    created_at DATETIME(3) NOT NULL COMMENT '项目创建上海时间',
    updated_at DATETIME(3) NOT NULL COMMENT '项目信息最近更新上海时间',
    PRIMARY KEY (id),
    UNIQUE KEY uk_cad_project_code (cad_project_code),
    KEY idx_cad_project_owner_list (owner_user_id, deleted, updated_at, id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='CAD个人工作空间项目';

CREATE TABLE cad_project_upload (
    id BIGINT NOT NULL AUTO_INCREMENT COMMENT '内部主键,不对外返回',
    upload_code VARCHAR(32) CHARACTER SET ascii COLLATE ascii_bin NOT NULL COMMENT '上传批次唯一业务编码',
    cad_project_id BIGINT NOT NULL COMMENT '所属CAD项目内部主键,关联cad_project.id',
    expected_version BIGINT NOT NULL COMMENT '签发上传时的项目基础版本,用于并发保存校验',
    object_key VARCHAR(512) CHARACTER SET ascii COLLATE ascii_bin NOT NULL COMMENT '本批次设计文件环境相对路径,以斜杠开头,不含域名和环境根目录',
    file_name VARCHAR(255) NOT NULL COMMENT '本批次原生设计文件名称',
    size_bytes BIGINT NOT NULL COMMENT '本批次声明的文件大小,单位字节',
    expires_at DATETIME(3) NOT NULL COMMENT '未确认批次的截止上海时间,与上传签名一致',
    saved_version BIGINT NULL COMMENT '确认成功的版本号,空值表示尚未确认',
    saved_at DATETIME(3) NULL COMMENT '首次确认成功上海时间,重复确认返回原值',
    created_at DATETIME(3) NOT NULL COMMENT '批次创建上海时间',
    updated_at DATETIME(3) NOT NULL COMMENT '批次最近更新上海时间',
    PRIMARY KEY (id),
    UNIQUE KEY uk_cad_upload_code (upload_code),
    KEY idx_cad_upload_project (cad_project_id, created_at)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='CAD设计文件上传与保存确认批次';

保存事务锁定当前用户的未删除项目和对应批次,按 expected_version 条件更新当前对象键和版本,同时写入批次回执。失败整体回滚。重放已确认批次只返回首次确认的版本和时间,不重新绑定旧对象;项目删除后仍拒绝重放。首期不清理上传批次或旧 OSS 对象,不提供历史恢复接口。

document_object_key 和 object_key 均保存 /cad-projects/{项目编码}/{批次编码}/design.sc,不保存 vibemake_dev/ 或 vibemake/。真实上传和读取在运行时补当前环境根目录。已有数据格式转换 SQL 见 数据库 OSS 引用统一规范,无需改字段结构。

已有数据库增加 CAD 项目封面

已有 cad_project 表在部署新版前手工执行一次下列 SQL;新建数据库已包含此列,不重复执行。应用不会自动修改实际数据库,现有项目封面默认为 NULL。

ALTER TABLE cad_project
    ADD COLUMN cover_url VARCHAR(2048) NULL
    COMMENT 'CAD项目封面,平台OSS资源存无环境前缀的相对路径'
    AFTER description;

平台托管封面保存 /project-covers/... 等未编码路径,不含域名及环境根目录;接口返回时补齐当前 OSS/CDN 基础地址和环境前缀。上传复用现有封面签名,不占用设计文件上传批次,也不改变文档版本。