data-api

规则：Domo App Platform 数据访问（工具包优先）

此规则优先使用工具包/查询。在应用中使用 @domoinc/query 读取数据集。

标准查询方式

1) 使用 @domoinc/query 查询数据集

yarn add @domoinc/query

import Query from '@domoinc/query';

const salesByRegion = await new Query()
  .select(['region', 'Sales_Amount'])
  .groupBy('region', { Sales_Amount: 'sum' })
  .orderBy('Sales_Amount', 'descending')
  .fetch('sales');

2) SQL 仅作为例外

如果使用 SQL（SqlClient），请记住它不会自动遵循仪表盘中的页面筛选器。

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

const sqlClient = new SqlClient();
const result = await sqlClient.get(
  'sales',
  'SELECT region, SUM(Sales_Amount) AS total FROM sales GROUP BY region'
);
const rows = result.body.rows;

必需的 Manifest 配置

每个数据集仍必须在 manifest.json 中的 datasetsMapping 下声明。

{
  "datasetsMapping": [
    { "alias": "sales", "dataSetId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "fields": [] }
  ]
}

关键陷阱：

• fields 必须存在（可以为 []），以避免 manifest 解析错误。

本地开发

• 使用 @domoinc/ryuu-proxy 进行本地 API 路由。
• 使用 domo login 进行身份认证。

检查清单

• datasetsMapping 别名已配置且有效
• 查询使用 Query 实现（默认不使用原始 /data/v1）
• 聚合使用实际的数据集字段名
• 未使用 .aggregate()