Skip to content

script_module_searcher.md

Latest commit

 

History

History
250 lines (180 loc) · 8.4 KB

script_module_searcher.md

File metadata and controls

250 lines (180 loc) · 8.4 KB
Raw

ModuleSearcher / BatchSearcher

スクリプトから他モジュールのデータを検索するためのクラスです。

クラス 用途
ModuleSearcher<T> 1 モジュールを 1 回検索
ModuleSearcher ジェネリックなしの版（モジュール名を文字列で指定）
BatchSearcher 複数の ModuleSearcher を 1 回のリクエストで実行

1. 基本

作成と実行

var searcher = new ModuleSearcher<Customer>();
searcher.AddEquals(c => c.Email.Value, "user@example.com");
searcher.AddLike(c => c.Name.Value, "山田");
searcher.OrderBy(c => c.Id.Value);

var customers = await searcher.Execute();   // List<Module>
foreach (var c in customers)
{
    Logger.Log(c.Name.Value);
}

ラムダ式は c => c.<Field名>.Value の単項ラムダ形式に限ります。 ネストして c => c.Author.Name.Value のように書くこともできます。

Module ではなく ModuleData で取りたい

軽量な ModuleData（生のデータ）として取りたい場合は ExecuteRaw を使います。

var rawList = await searcher.ExecuteRaw();   // List<ModuleData>

2. 条件追加メソッド

Add* 系は AND で結ばれます。

メソッド 比較
AddEquals(lambda, value) 一致（=）
AddNotEqual(lambda, value) 不一致（<>、value が null なら IS NOT NULL）
AddLessThan(lambda, value) 未満（<）
AddLessThanOrEqual(lambda, value) 以下（<=）
AddGreaterThan(lambda, value) より大きい（>）
AddGreaterThanOrEqual(lambda, value) 以上（>=）
AddLike(lambda, value) あいまい一致（LIKE）
AddIn(lambda, params object[] values) リスト内に含まれる
AddIn(lambda, IEnumerable values) リスト内に含まれる
AddNotIn(lambda, params object[] values) リスト内に含まれない
AddNotIn(lambda, IEnumerable values) リスト内に含まれない 
searcher.AddEquals(c => c.Status.Value, "Active");
searcher.AddGreaterThan(c => c.Age.Value, 20);
searcher.AddIn(c => c.Region.Value, "東京", "大阪", "名古屋");

3. AND / OR の組み合わせ

AddConditions で別の ModuleSearcher の条件をまとめて取り込めます。 これを利用して AND と OR を組み合わせます。

プロパティ 型 説明
IsOrMatch bool 条件を OR で結ぶ（既定 false = AND）
IsNot bool 条件全体を NOT で囲う 
// (Region = "東京" OR Region = "大阪") AND Status = "Active"
var orCondition = new ModuleSearcher<Customer>();
orCondition.IsOrMatch = true;
orCondition.AddEquals(c => c.Region.Value, "東京");
orCondition.AddEquals(c => c.Region.Value, "大阪");

var searcher = new ModuleSearcher<Customer>();
searcher.AddEquals(c => c.Status.Value, "Active");
searcher.AddConditions(orCondition);

var list = await searcher.Execute();

4. ソート

searcher.OrderBy(c => c.Id.Value);              // 昇順
searcher.OrderByDescending(c => c.Date.Value);  // 降順
searcher.ThenBy(c => c.Name.Value);             // 第 2 ソートキー
searcher.ThenByDescending(c => c.Sub.Value);

5. 取得列の絞り込み

Select で取得する Field を絞ると通信量が減ります。

searcher.Select(c => c.Id.Value, c => c.Name.Value);

6. 件数上限とページング

Limit で取得件数の上限を設定します。指定しないと条件に一致する全件を取得するため、 データ量の多いモジュールを検索するときは必ず設定してください。

searcher.Limit(50);
var list = await searcher.Execute();   // 最大 50 件

ページングは Limit と ExecutePage(pageIndex) を併用します（pageIndex は 0 始まり、1 ページの件数は Limit の値）。 当該ページの一覧と総件数を 1 回のクエリで取得でき、戻り値 ModulePageResult の Items / TotalCount で受け取ります。

var searcher = new ModuleSearcher<Customer>();
searcher.OrderBy(c => c.Id.Value);
searcher.Limit(50);

var result = await searcher.ExecutePage(0);   // 1 ページ目
var rows = result.Items;                       // 当該ページ（最大 50 件）
var total = result.TotalCount;                 // 条件に一致する全件数（ページャー表示用）

Module 実体が不要な軽量処理では、生データ版の ExecuteRawPage(pageIndex)（戻り値 ModuleDataPageResult）を使います。

var result = await searcher.ExecuteRawPage(0);
var rows = result.Items;          // List<ModuleData>
var total = result.TotalCount;

TotalCount は Limit 設定時のみ COUNT(*) で算出されます。Limit 未設定（全件取得）のときは取得した件数がそのまま総件数になります。

実行メソッドまとめ

メソッド 戻り値 説明
Execute() List<Module> 条件に一致するモジュール一覧（ページングしない）
ExecutePage(pageIndex) ModulePageResult 指定ページの Items と総件数 TotalCount
ExecuteRaw() List<ModuleData> 生データ一覧（Module 実体を作らない軽量版）
ExecuteRawPage(pageIndex) ModuleDataPageResult 生データの指定ページ Items と総件数 TotalCount
ExecuteFirstOrDefault() Module? 先頭 1 件。該当なしは null

7. ジェネリックなしの ModuleSearcher

モジュール名が動的に決まる場合は文字列で指定します。

var searcher = new ModuleSearcher("Customer");
// 条件式は型補完が効かないので注意

8. BatchSearcher — 複数検索を一括

複数の ModuleSearcher を 1 回のリクエストにまとめます。サーバーラウンドトリップが減ります。

var s1 = new ModuleSearcher<Customer>();
s1.AddEquals(c => c.Status.Value, "Active");

var s2 = new ModuleSearcher<Order>();
s2.AddGreaterThan(o => o.CreatedAt.Value, DateTime.Today.AddDays(-7));

var response = await BatchSearcher.Execute(s1, s2);

var customers = response.GetAt(0);   // s1 の結果
var orders = response.GetAt(1);      // s2 の結果
メソッド 説明
GetAt(index) 渡した順番（0 始まり）で結果を取得
GetBy(searcher) 渡した ModuleSearcher を指定して結果を取得（インデックス管理が不要）

GetBy は Execute に渡した ModuleSearcher そのものを指定して結果を引きます。GetAt のように インデックスを覚えておく必要がありません。バッチに渡していない ModuleSearcher を指定すると例外になります。

var customers = response.GetBy(s1);   // s1 の結果
var orders = response.GetBy(s2);      // s2 の結果

9. パターン集

1 件だけ取りたい（マスタ参照）

ExecuteFirstOrDefault は先頭 1 件を返し、該当が無ければ null を返します。

var searcher = new ModuleSearcher<Customer>();
searcher.AddEquals(c => c.Email.Value, EmailField.Value);
var customer = await searcher.ExecuteFirstOrDefault();
if (customer == null) return;
// customer.Name.Value ...

件数だけ知りたい

総件数だけが必要なときは、Limit を小さく設定して ExecuteRawPage の TotalCount を使うと 全件分の Module を生成せずに済みます。

var searcher = new ModuleSearcher<Customer>();
searcher.AddEquals(c => c.Status.Value, "Active");
searcher.Limit(1);
var page = await searcher.ExecuteRawPage(0);
var count = page.TotalCount;

List コンポーネントの絞り込みに使う

var searcher = new ModuleSearcher<Order>();
searcher.AddEquals(o => o.CustomerId.Value, this.Id.Value);

OrderListField.SetAdditionalCondition(searcher);
OrderListField.Reload();

関連項目