kSQL は kintone アプリを SQL ライクな構文で操作するプラグインです。
関連記事
概要
kSQLプラグインは、kintoneデータを SQL ライクな書き方で操作でき、SELECT だけでなく 挿入（INSERT）・更新（UPDATE）・削除（DELETE） にも対応します。
APP100 のようにアプリをテーブル感覚で扱えるため、参照からメンテナンスまでを一貫したクエリで実行できます。
SQLに慣れた人ほど、kintone運用を直感的かつ効率的に進められるのが特長です。
Github に公開しました。
https://github.com/rex0220/kintone-sql-tools
プラグインとテンプレートファイル
https://github.com/rex0220/kintone-sql-tools/tree/main/release
- 一覧画面で kSQL 実行
- 編集画面で kSQL 実行
kSQL 専用アプリ
kSQL 専用テンプレートから作成します。
ゲストスペースアプリを参照する場合は、ゲストスペース内にアプリを作成してください。
kSQL プラグイン設定
設定項目はありません。
kintone 画面での kSQL 表示
- 一覧画面
- 一覧画面：オプション表示
- 追加・編集画面
- 詳細画面
オプション指定
タブで切り替えて、設定します。
表示オプション
ユーザー選択の名前表示、配列のカンマ区切り、テーブルを行数のみ表示、日時のローカル表示を指定でだいぶ見やすくなります。
表示された結果は、フィルター表示・列タイトルクリックでソートが出来ます。
取得オプション
何件までレコードを取得するかと、オーバー時にエラーまたは続行を指定します。
保存SQLオプション
レコードの内容を表示します。
SQLをリセットして元に戻すことが出来ます。
フィールドオプション
指定したアプリのフィールド一覧を表示します。
フィールドをクリックすると、SQLにフィールドコードを挿入します。
アプリ
アプリの一覧を表示します。
アプリをクリックすると、SQLにアプリ（APPxx）を挿入します。
テーブル表示
テーブルの行数表示指定時、行数をクリックするとテーブル行を表示します。
kSQL の使い方
まず最初に試す
プラグインを有効化したあと、対象環境でクエリ実行画面を開いて次を試します。
APP100 の 100 は、アプリID ですので、実際にあるアプリを指定してください。
SELECT *
FROM APP100
結果が返れば準備OKです。
基本の使い方
1. 必要な列だけ取得する
SELECT レコード番号, 顧客名, ステータス
FROM APP100
* ではなく列を指定すると、見たい情報に絞って確認できます。
2. 条件で絞り込む
SELECT レコード番号, 顧客名
FROM APP100
WHERE ステータス = "対応中"
WHERE を使うと、対象レコードだけ取得できます。
3. 更新日時で並び替える
SELECT レコード番号, 顧客名, 更新日時
FROM APP100
ORDER BY 更新日時 DESC
DESC は新しい順、ASC は古い順です。
4. 件数を絞って確認する
SELECT レコード番号, 顧客名
FROM APP100
ORDER BY レコード番号 DESC
LIMIT 20
検証時は LIMIT で少件数にすると確認しやすくなります。
コピペ用クエリ集
一覧の基本
SELECT レコード番号, 顧客名, ステータス, 更新日時
FROM APP100
ORDER BY 更新日時 DESC
対応中だけを見る
SELECT レコード番号, 顧客名, 担当者
FROM APP100
WHERE ステータス = "対応中"
ORDER BY 更新日時 DESC
特定の担当者で絞る
SELECT レコード番号, 顧客名, ステータス
FROM APP100
WHERE 担当者 = "山田 太郎"
ORDER BY レコード番号 DESC
よくあるエラーと対処
APPxxx が違う
- テーブル名は
APP100のようにアプリIDで指定します。 - 対象アプリIDが正しいか確認してください。
フィールド名の打ち間違い
- まず
SELECT * FROM APP100で項目を確認します。 - 使いたい列名をそのままコピーして試します。
いきなり大量件数で重い
- 最初は
LIMIT 20などで小さく試すのがおすすめです。
使い始めのコツ
- 最初は
SELECT *で全体を把握 - 次に列を絞る
- 最後に
WHEREとORDER BYを足す
この順番にすると、クエリのどこで意図とズレたか見つけやすくなります。
まとめ
kSQLプラグインを使うと、kintoneデータをSQL ライクな書き方で扱えるため、日々の確認や抽出がシンプルになります。
まずは SELECT / WHERE / ORDER BY の3つを中心に、手元のアプリで試してみてください。