SuperAPI AI 工具集

doctype-schema-expert

编程与开发

查看项目

更新于 10-15 23:44

技能介绍

用途:该技能为 Frappe 应用的 DocType 模式提供指导,涉及 JSON 结构、字段定义与最佳实践。DocType 是 Frappe 应用的基本构建块,每个 DocType 定义数据库表结构、UI 表单布局、业务逻辑与权限,并由 JSON 文件(如 doctype_name.json)描述完整模式。需注意通过 UI 创建的自定义 DocType 不在磁盘上生成 .json 文件,定义仅存于数据库;随应用发布的标准 DocType 才在代码库中带 JSON 文件。

主要能力:覆盖 DocType 核心属性(name、module、istable、issingle、is_submittable、is_tree、editable_grid、custom、fields、permissions 等);字段类型分类包括数据字段、布局字段与关系字段(Table、Table MultiSelect、Link、Dynamic Link);还涉及子表、单例 DocType、自动生成的标准字段(name、owner、creation、modified、docstatus、idx 等)。

使用方式:创建新 DocType 时,在 frappe/module_name/doctype/doctype_name/ 下新建 JSON 文件,定义结构与字段,加入权限,然后运行 bench migrate 建表。添加字段时在 fields 数组中写入含 fieldname、fieldtype、label、reqd、hidden、read_only 等属性的对象。资料还建议按任务查阅 references 目录下关于结构、字段类型、字段属性、命名规范、最佳实践与常见模式的参考文件。

适用场景:创建或修改 DocType、添加字段、设计子表与单例 DocType、遵循命名与结构规范、进行模式校验与迁移测试。

限制与注意:JSON 必须有效(双引号、无尾逗号);模式修改需运行 bench migrate;重命名字段或更改字段类型可能造成数据丢失;变更前应备份,开发环境测试后再上生产;有数据后字段名不可更改。文档未提供具体价格或收费、许可及详细安装步骤。