You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 

2.9 KiB

服务文档数据库设计增强

创建时间:2025-01-27
状态:进行中


目标

在每个服务文档中增加"数据库设计"章节,包含:

  1. 完整的表结构 SQL(CREATE TABLE 语句)
  2. 索引设计
  3. 约束和触发器
  4. 设计说明

已完成的服务文档

核心服务(已完成)

  1. attachment-service.md(附件管理服务)

    • attachments 表结构
    • 业务表关联字段(users.avatar_id, projects.cover_image_id, storyboards.thumbnail_id)
    • 索引和触发器
    • 设计说明
  2. file-storage-service.md(文件存储服务)

    • file_checksums 表结构
    • 去重流程说明
    • 索引设计
  3. project-resource-service.md(项目素材服务)

    • project_resources 表结构
    • storyboard_resources 关联表
    • 索引和触发器
    • 设计说明
  4. project-service.md(项目管理服务)

    • projects 表结构
    • project_members 表结构
    • project_versions 表结构
    • 索引和触发器
    • 设计说明
  5. user-service.md(用户管理服务)

    • users 表结构
    • user_sessions 表结构
    • 索引和触发器
    • 设计说明

待补充的服务文档

以下服务文档需要补充数据库设计章节:

  1. script-service.md(剧本管理服务)

    • scripts 表
    • script_versions 表
    • script_characters 表
    • script_scenes 表
  2. storyboard-service.md(分镜管理服务)

    • storyboards 表
    • storyboard_resources 表
  3. video-service.md(视频管理服务)

    • videos 表
  4. timeline-service.md(时间轴服务)

    • timeline_tracks 表
    • timeline_items 表
  5. comment-service.md(评论服务)

    • comments 表
  6. ai-service.md(AI 服务)

    • ai_jobs 表
  7. export-service.md(导出服务)

    • export_jobs 表
  8. folder-service.md(文件夹服务)

    • folders 表
    • folder_members 表
  9. resource-service.md(资源库服务,后期扩展)

    • resources 表

数据库设计章节模板

---

## 数据库设计

### [表名] 表结构

```sql
CREATE TABLE [table_name] (
    -- 字段定义
    ...
);

-- 索引
CREATE INDEX ...;

-- 触发器
CREATE TRIGGER ...;
```

设计说明

  1. 设计要点1:说明
  2. 设计要点2:说明 ...

数据模型

[Model] 模型

# 现有的 SQLAlchemy 模型代码

## 优势

✅ **开发便利**:开发者只需看一个文档就能了解完整的服务设计
✅ **上下文完整**:数据模型和业务逻辑在同一文档中
✅ **减少跳转**:不需要频繁在服务文档和数据库设计文档之间切换
✅ **独立性强**:每个服务文档都是自包含的
✅ **便于实施**:可以直接复制 SQL 创建表

## 下一步

继续补充剩余 9 个服务文档的数据库设计章节。

---

**文档版本**:v1.0
**最后更新**:2025-01-27