SuperAPI AI 工具集

docyrus-data-source-design

数据与分析

查看项目

更新于 10-15 21:11

技能介绍

用途:该技能用于在 Docyrus 中设计数据源的 schema(字段集合),并在交付前完成校验与真实记录测试。它是记录查询(docyrus ds / dsql)的 schema 编写对应技能。

主要能力:通过 docyrus studio CLI 创建数据源、批量添加字段、为选择类字段添加枚举选项、配置关联关系,并读取 schema 进行校验。

使用方式(按阶段):

  1. 确认应用与登录:docyrus auth who --json、docyrus apps list --json;无会话时需用户执行 docyrus auth login。
  2. 建模实体:确定名称、slug、字段类型、选择字段枚举与关联关系。
  3. 创建数据源:docyrus studio create-data-source --appSlug crm --title "Contacts" --name "Contact" --slug "contacts" --icon "users" --json。先创建父/独立数据源,再创建带关联的数据源。
  4. 添加字段:单条用 create-field,批量用 create-fields-batch(推荐)。
  5. 为选择字段添加枚举:docyrus studio create-enums。
  6. 校验:get-data-source(仅按 --dataSourceId)、list-fields、list-enums、docyrus dsql schema data-source。
  7. 测试:用 docyrus ds create/list/delete 创建、查询(含 --expand relation)并删除临时记录。

限制与注意:studio 只创建 simple 数据源,省略 --type,传其他值会返回 HTTP 400。批量字段 JSON 用 snake_case 键(relation_data_source_id、default_value 等),camelCase 会被静默丢弃;单条 create-field 用 camelCase 标志;枚举批量项用 camelCase(sortOrder、isFinalOption)。get-data-source 只接受 --dataSourceId。simple 数据源写入时不校验记录值类型,枚举需写 UUID 而非标签。name、description 等为保留字段,不可重建。虚拟/计算类型(formula、list、button 等)不接受值和默认值。每次都应先校验再测试,并清理测试记录。

适用场景:需要为 Docyrus 应用建模数据源、字段、枚举与关联关系,并验证 schema 可用性的开发或配置工作。