本記事は、複数のレコードを取得するAPI実行時の注意点について紹介するシリーズの第二弾です。
第一弾の「totalCountパラメーター」の記事に続き、第二弾は「OR条件」の記事となります。
第一弾： 複数のレコードを取得するAPI実行時の注意点 (totalCountパラメーターについて)

この記事では、queryパラメーターに複数のOR条件を指定した際、条件の設定の方法によって、複数のレコードを取得するAPIの実行時の処理速度がどのように変わるかを検証しています。
検証結果から、複数のレコードを取得するAPIを快適に実行してもらうために、queryパラメーターを指定する際の注意点を紹介します。

警告

ご利用の環境内のデータ量等の要因により処理速度は変わります。

• 同様のリクエストパラメーターで複数のレコードを取得するAPIを実行した場合に同じ結果を保証するものではありません。
• 将来にわたっても同様の結果になることを保証するものではありません。

queryパラメーターとは、複数のレコードを取得するAPIのリクエストパラメーターの1つです。
取得するレコードの絞り込み条件を記述できます。
たとえば、次のようにorなどの絞り込み条件や、order byといったソート条件を指定できます。

1
2
3
4
5

const body = {
  app: kintone.app.getId(),
  query: '作成日時 > "2012-02-03T09:00:00+0900" or 更新日時 < "2012-02-03T10:00:00+0900" order by レコード番号 asc limit 10 offset 1',
  fields: ['レコード番号', '作成日時', 'ドロップダウン']
};

複数のレコードを取得する

queryパラメーターに複数のOR条件をAND条件で接続した条件を指定した場合、リクエストが大幅に遅延するなど、kintoneを快適に使えなくなる場合があります。

複数のレコードを取得するAPIを実行する時にqueryパラメーターを指定し、その処理速度を比較します。
次の検証A、検証Bの条件で確認します。

• 検証A：queryパラメーターに単に複数のOR条件を設定した場合
• 検証B：queryパラメーターに複数のOR条件をAND条件で接続した条件を設定した場合

• 使用した検証環境：kintone 2024年11月版
• ブラウザー：Google Chrome

上記を確認するためのアプリ構成として、1つのアプリに次の画像の25個の数値フィールドを用意します。

アプリには100,000件のレコードを登録します。
各レコード内の25個の数値フィールドの値は、次の「検証時に実行したリクエストパラメーター」の各queryを指定してAPIを実行した際に、すべて10,000件ヒットするように1〜10までの値を割り振りました。

6行目のqueryの値を都度変更して実行します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

kintone.events.on('app.record.index.show', async (event) => {
  const record = event.record;
  const body = {
    app: kintone.app.getId(),
    query: '(数値1=1 or 数値6=1 or 数値11=1 or 数値16=1 or 数値21=1) limit 500'
  };

  await kintone.api(
    kintone.api.url('/k/v1/records.json', true),
    'GET',
    body,
    (resp) => {
      console.log(resp);
    },
    (error) => {
      console.log(error);
    }
  );
});

具体的な値は次のようになります。

検証A：queryパラメーターに単に複数のOR条件を設定した場合

検証B：queryパラメーターに複数のOR条件をAND条件で接続した条件を設定した場合

queryパラメーターに複数のOR条件をAND条件で接続した条件を設定したときの処理速度が、単に複数のOR条件を設定した場合より遅くなることを確認しました。
検証Aで、queryパラメーターに単に複数のOR条件を設定したときの処理速度は次のようになりました。
単位は「ミリ秒」です。

検証Bで、queryパラメーターに複数のOR条件をAND条件で接続した条件を設定した時の処理速度は次のようになりました。
単位は「ミリ秒」です。

• queryパラメーターに複数のOR条件をAND条件で接続した条件を設定した時の処理速度が、単に複数のOR条件を設定した場合よりも遅くなりました。
• queryパラメーターに単に複数のOR条件を設定した場合、条件数を増やしてもそこまで処理速度に差が生じませんでした。
• queryパラメーターに複数のOR条件をAND条件で接続した条件を設定した場合、条件数を増やすと、処理速度が大きく遅延しました。

• 複数のOR条件をAND条件でつないだ状態での運用をしない。
• どうしてもその状態での運用が必要な場合、可能な限りOR条件の数を増やさない条件を検討する。
• 条件設定時には、APIの処理が遅くならないかを確認しながらパラメーターを調整する。

「検証Aと検証Bの比較」 で記載したように、queryパラメーターに複数のOR条件をAND条件で接続した条件を設定した場合、リクエストが大幅に遅延するなど、kintoneを快適に使えなくなる場合があります。
「複数のOR条件を設定する場合の注意点」 を参考に、queryパラメーターにおけるOR条件の性質を理解し、使い所を見極めて、複数のレコードを取得しましょう。

このTipsは、2024年11月版kintoneで動作を確認しています。