modifyDataModel 功能描述中写了支持修改模型，但具体action仅支持新增，不支持更新？ · Issue #928

参数
参数名类型必填说明
mermaidDiagram string 是 Mermaid classDiagram代码，描述数据模型结构。
action string 操作类型：create=创建新模型可填写的值: "create"；默认值: "create"
publish boolean 是否立即发布模型默认值: false
dbInstanceType string 数据库实例类型默认值: "MYSQL"
示例
classDiagram
class Student {
name: string <<姓名>>
age: number = 18 <<年龄>>
gender: x-enum = "男" <<性别>>
classId: string <<班级ID>>
identityId: string <<身份ID>>
course: Course[] <<课程>>
required() ["name"]
unique() ["name"]
enum_gender() ["男", "女"]
display_field() "name"
}
class Class {
className: string <<班级名称>>
display_field() "className"
}
class Course {
name: string <<课程名称>>
students: Student[] <<学生>>
display_field() "name"
}
class Identity {
number: string <<证件号码>>
display_field() "number"
}

%% 关联关系
Student "1" --> "1" Identity : studentId
Student "n" --> "1" Class : student2class
Student "n" --> "m" Course : course
Student "n" <-- "m" Course : students
%% 类的命名
note for Student "学生模型"
note for Class "班级模型"
note for Course "课程模型"
note for Identity "身份模型"

截图或补充信息

Cloud Native Build

NPC

@tencent/cloud/cloudbase/community(小T) 来看下问题

小T

NPC

Booker Zhao(赵兵）

Owner

感谢反馈，文档这里我们更新下

小T

NPC

@cnb.cUF1dEVLwEA(张兴禹) 感谢反馈！你观察得很仔细 👍

问题确认

你说得对，文档描述与参数定义确实存在不一致：

文档描述："基于Mermaid classDiagram创建或更新数据模型。支持创建新模型和更新现有模型结构"
实际参数：action 参数仅支持 "create" 一个值

这确实是文档的表述不够准确。

可能的情况

文档描述超前：未来可能会支持 update 功能，但当前版本尚未实现
实现方式不同：可能通过 create 操作覆盖现有模型来实现"更新"（但这需要进一步确认）
文档笔误：描述写错了，应该只说"创建"

建议后续操作

我已经记录了这个问题，会推动文档团队进行以下处理：

核实实际功能：确认 modifyDataModel 是否真的支持更新现有模型
修正文档：如果只支持 create，则修改描述；如果支持 update，则补充对应参数

你可以先通过 manageDataModel 工具（action: "list" / "get"）查看和管理已创建的模型。

如有其他疑问，随时可以继续提问！

胡明

added labels

类型：官方文档

小T

NPC

referenced ISSUE

#913 测试一下 npc 自动回复

Resolved

张兴禹

Creator

通过@cloudbase/cli 命令行可以实现对模型的修改，我创建了一个补丁skill，仅供其他开发者参考。

xingyuzhang@macbook lottery-stack-cloudrun % ls skills/cloudbase-model-patch
SKILL.md

---
name: cloudbase-model-patch
description: 通过 pull-modify-push 工作流更新 CloudBase 数据模型。当需要修改已存在的数据模型（添加/删除/修改字段）时使用此 skill 作为 modifyDataModel 的补充。
description_zh: 通过 pull-modify-push 工作流更新 CloudBase 数据模型，支持添加、删除、修改字段
version: 1.0.0
---

# CloudBase 数据模型补丁更新指南

## 何时使用此 Skill

当用户需要**修改已存在的数据模型**时，使用此 skill：
- 添加新字段
- 删除字段
- 修改字段类型或属性
- 重命名字段

## 前置要求

- 已安装 CloudBase CLI 3.0.3+
- 已登录 CloudBase CLI (`tcb login`)
- 项目根目录有 `cloudbaserc.json` 配置文件

## 工作流程

### 1. 拉取现有模型 (Pull)

```bash
# 拉取指定模型
tcb db model pull -n <模型名称>

# 示例：拉取 Animal 模型
tcb db model pull -n Animal

生成的文件：

database-schemas/<模型名>.json - 模型 Schema 定义
cloud-models.d.ts - TypeScript 类型定义

2. 本地修改 (Modify)

编辑 database-schemas/<模型名>.json 文件：

添加字段示例：

{
  "properties": {
    "existingField": {
      "type": "string",
      "title": "已有字段"
    },
    "newField": {
      "description": "新字段描述",
      "type": "number",
      "title": "新字段"
    }
  }
}

支持的字段类型：

类型	说明
`string`	字符串
`number`	数字
`boolean`	布尔值
`datetime`	日期时间
`date`	日期
`time`	时间
`x-enum`	枚举
`x-file`	文件
`x-image`	图片
`x-rtf`	富文本

3. 更新类型定义

同步更新 cloud-models.d.ts 文件：

interface IModal_<模型名> {
  existingField?: string
  newField?: number
}

4. 推送更新 (Push)

# 推送指定模型
tcb db model push -n <模型名称>

# 示例：推送 Animal 模型
tcb db model push -n Animal

交互式确认：

Data model <模型名> already exists, update it? → 输入 Yes
Data models have been imported successfully, publish them? → 输入 Yes

完整示例

场景：为 Animal 模型添加 lifespan 字段

# Step 1: 拉取模型
tcb db model pull -n Animal

# Step 2: 修改 database-schemas/Animal.json
# 在 properties 中添加：
# "lifespan": {
#     "description": "寿命",
#     "type": "number",
#     "title": "寿命"
# }

# Step 3: 修改 cloud-models.d.ts
# 在 IModal_Animal 接口中添加：
# lifespan?: number

# Step 4: 推送更新
tcb db model push -n Animal

命令参考

命令	说明
`tcb db model list`	列出所有数据模型
`tcb db model pull -n <name>`	拉取指定模型
`tcb db model push -n <name>`	推送指定模型
`tcb db model pull`	拉取所有模型
`tcb db model push`	推送所有本地模型