クエリ クライアント

クエリの作成の詳細については、「LINQ セクションを使用したクエリの作成」を参照してください。

クエリの実行後、IQueryResult が返されます。この結果には、次のプロパティがあります。

• Items: クエリに一致したエンティティ/ID (合計結果全体のサブセットとなる場合があります)
• TotalNumberOfResults: Sitecore Content Hub のクエリに一致したアイテムの数 (Items に含まれていないアイテムも含みます)。
• Offset: スキップされたアイテムの数。

クエリが単一のエンティティのみに一致することが確実な場合は、SingleAsync メソッドの使用が便利です。

IEntity entity = await MClient.Querying.SingleAsync(query);

クエリが単一のエンティティのみに一致することが確実な場合は、SingleIdAsync メソッドの使用が便利です。

long? entityId = await MClient.Querying.SingleIdAsync(query);

1 つまたは複数のエンティティに対してクエリを実行するには、次のようにします。

IEntityQueryResult queryResult = await MClient.Querying.QueryAsync(query);

IEntityQueryResult.Items には、返されたエンティティが含まれています。

1 つまたは複数のエンティティ ID に対してクエリを実行するには、次のようにします。

IIdQueryResult queryResult = await MClient.Querying.QueryIdsAsync(query);

IIdQueryResult.Items には、返された ID (long 形式) が含まれています。

クエリが少数から中程度の数の結果を返す場合 (既定の設定では最大 10,000 件の結果)、イテレーターを使用してエンティティを簡単にバッチ処理できます。

次のスニペットは、イテレーターを作成しています。

IEntityIterator iterator = MClient.Querying.CreateEntityIterator(query);

次のスニペットでは、イテレーターを使用してエンティティをバッチ処理しています。

while (await iterator.MoveNextAsync())
{
var entities = iterator.Current.Items;
// Do something with the entities
}

イテレーターがエンティティのすべてのバッチの処理を終了すると、while ループは自動的に終了します。

クエリが小サイズから中程度のサイズの結果を返す場合 (既定の設定では最大10,000 件の結果)、イテレーターを使用してエンティティ ID を簡単にバッチ処理できます。

次のスニペットは、イテレーターを作成しています。

IIdIterator iterator = MClient.Querying.CreateIdIterator(query);

次のスニペットでは、イテレーターを使用してエンティティ ID をバッチ処理しています。

while (await iterator.MoveNextAsync())
{
var ids = iterator.Current.Items;
// Do something with the ids
}

イテレーターがエンティティのすべてのバッチの処理を終了すると、while ループは自動的に終了します。

Query クラスに、EntityLoadOptions プロパティと LoadConfiguration プロパティを設定することが可能です。1 つ目のプロパティは過去の WebApiClient SDK で使用されていましたが、3.0 では非推奨になりました。3.1 では、Query クラスと読み込み設定が分離されました。これらのプロパティの使用は控えることをお勧めしますが、必要に応じて、クエリ オブジェクトを渡すときの追加のパラメーターとして読み込み設定を渡せます。