kintone（キントーン）のクエリ

こんにちは。kintone（キントーン）導入支援のギャンです。
今回は「kintone（キントーン）のクエリ」ということで、kintoneのAPIを活用する際のクエリについてまとめてみました。

kintoneのクエリとは

クエリ（query）とは、「問い合わせ（る）」、「訪ねる」などの意味を持つ英単語で、ITではソフトウェアに対するデータの問い合わせや要求などを一定の形式で文字に表現することです。 クエリを通じて、データの検索や更新、削除、抽出などの要求をデータベース（DBMS）に送信することができます。kintoneの標準機能だけを使っている場合、GUI操作だけでクエリを使用することはありません。kintoneのクエリは、API（kintone REST APIやkintone javaScript API）において、kintoneのデータの検索等を行う場合に使用します。

クエリの書き方

基本的なクエリの書き方は、「フィールドコード」「 演算子」「 値 または 関数」の形式になります。また「オプション」として、ソート順や取得するレコード数、スキップするレコード数の指定も可能です。具体的な例として、フィールドコードが「会社名」の場合、「会社名」が「株式会社ギャン」と完全一致するレコードを検索する場合、会社名 = "株式会社ギャン"　と書きます。「会社名」に「ギャン」を含むといった部分一致のレコードを検索する場合、会社名 like "ギャン" というように演算子にlikeを指定します。基本的には一般的なSQLのクエリと似ていますが、kintone特有のクエリの書き方もあります。それはフィールドがドロップダウン、チェックボックス、ラジオボタン、複数選択の場合で、例えばフィールドコードが「ステータス」の場合、ステータス in ("対応中"、"未対応")という形式になります。詳しくはcybozu developer networkの「クエリの書き方」を参照して下さい。

クエリを確認する

kintoneが実際にどのようにクエリを発行しているのかを知る方法として、クエリをコンソール画面に表示するjavascriptプログラムを仕込むという手段があります。

(function() {
  "use strict";
  kintone.events.on('app.record.index.show', function(event) {
    console.log(kintone.app.getQuery());
  });
})();

上記のコードを記載したJavaScriptプログラムをkintoneアプリに追加したうえで、kintone画面上でレコードの絞り込みを行い一覧を表示すると、コンソール画面に実行されたクエリが文字列として表示されます。ちなみにコンソールを表示する方法ですが、WebブラウザがChromeの場合、「Chromeコンソールを開いてみよう」を参考にしていただければと思います。また、絞り込みの条件を変更して試してみることで、条件によってどのようなクエリが発行されているのかを確認することができますので、APIでクエリを指定する際に参考にして下さい。

kintoneのクエリのまとめ

kintoneのクエリの書き方は、コツをつかめたら簡単に書くことができるかと思います。またクエリは、組み合わせることによってさまざまなデータを取得できます。クエリを活用して、これからもkintoneをより便利にカスタマイズしていただければと思います。