SuperAPI AI 工具集

domo-appdb

编程与开发

查看项目

更新于 10-16 06:39

技能介绍

用途

domo-appdb 是一套针对 Domo App Platform 中 AppDB 的使用规则,采用 Toolkit 优先(toolkit-first)的方式。其核心目的是引导开发者通过 AppDBClient 操作 AppDB 文档,而不是直接使用原始的 domo.get/post/put/delete 端点。原有的端点优先指南已被归档到 archive/legacy-rules/domo-appdb.md。

主要能力

该规则覆盖 AppDB 文档的 CRUD、查询操作符以及集合接线(collection wiring)。具体包括:

  • 创建文档:通过 DocumentsClient 的 create 方法写入文档,并从返回结果的 body 中获取创建后的文档。
  • 读取与查询:使用 get 方法获取全部文档,或传入查询条件进行过滤;支持 $eq、$ne、$in、$and 等查询操作符组合条件。
  • 更新:支持整体更新(update,需提供 id 与 content)以及按条件部分更新(partialUpdate,配合 $set 等更新操作符)。
  • 删除:支持删除单个文档(传入 document-uuid)或批量删除(传入 uuid 数组)。

使用方式

规范客户端引入方式为:

yarn add @domoinc/toolkit

import { AppDBClient } from '@domoinc/toolkit';

随后定义文档类型并创建 DocumentsClient,例如:

const tasksClient = new AppDBClient.DocumentsClient('TasksCollection');

创建示例:

const created = await tasksClient.create({ title: 'New Task', status: 'active', priority: 'High' }); const task = created.body;

查询示例:

const all = await tasksClient.get(); const active = await tasksClient.get({ status: { $eq: 'active' } }); const highOpen = await tasksClient.get({ $and: [{ status: { $ne: 'completed' } }, { priority: { $in: ['High', 'Urgent'] } }] });

更新示例:

await tasksClient.update({ id: 'document-uuid', content: { title: 'Updated', status: 'completed', priority: 'Low' } });

await tasksClient.partialUpdate( { status: { $eq: 'active' } }, { $set: { status: 'archived' } } );

删除示例:

await tasksClient.delete('document-uuid'); await tasksClient.delete(['uuid-1', 'uuid-2']);

集合仍需在 manifest.json 的 collections 下声明,例如:

{ "collections": [ { "name": "TasksCollection", "schema": { "columns": [ { "name": "title", "type": "STRING" }, { "name": "status", "type": "STRING" } ] } } ] }

适用场景

适用于在 Domo App Platform 上开发应用、需要通过 AppDB 进行文档数据增删改查与条件查询的场景,尤其是希望统一使用 Toolkit 客户端、避免直接调用原始端点的项目。

限制与注意事项

  • 该规则为 Toolkit 优先,应使用 AppDBClient 而非原始 domo.get/post/put/delete 端点。
  • 集合必须先在 manifest.json 的 collections 中声明,否则无法正常使用。
  • 需正确使用查询与更新操作符($eq、$in、$set、$inc 等)。
  • UI 流程中应包含错误处理与加载状态。
  • 关于 AppDB 的注意事项与同步限制,可参考 .cursor/rules/09-gotchas.mdc;Toolkit AppDB 模式可参考 .cursor/rules/04-toolkit.mdc。
  • 资料未提供收费、价格、平台支持范围或效果方面的信息。