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.json の datasetsMapping に宣言する必要があります。

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

重要な注意点：

• マニフェストの解析エラーを避けるため、fields が存在している必要があります（[] でも構いません）。

ローカル開発

• ローカルでの API ルーティングには @domoinc/ryuu-proxy を使用してください。
• domo login で認証してください。

チェックリスト

• datasetsMapping のエイリアスが設定され、有効である
• クエリが Query を使用して実装されている（デフォルトで生の /data/v1 を使用していない）
• 集計で実際のデータセットのフィールド名を使用している
• .aggregate() を使用していない