インターフェイス IQueryingClient
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
エンティティをクエリおよびスクロールする機能が含まれています。
名前空間: Stylelabs.M.Sdk.Clients
アセンブリ: Stylelabs.M.Sdk.dll
構文
メソッド
CreateEntityIdIterator(Query)
Query に一致するすべての ID を繰り返す IEntityIterator を作成します。
宣言
パラメーター
| 型 | 名前 | 説明 |
|---|---|---|
| Query | query |
繰り返すクエリ。 |
戻り値
| 型 | 説明 |
|---|---|
| IIdIterator |
イテレーター。 |
CreateEntityIdScroller(Query, Nullable<TimeSpan>)
Query に一致するエンティティのすべての ID をスクロールする IIdScroller を作成します。
宣言
パラメーター
| 型 | 名前 | 説明 |
|---|---|---|
| Query | query |
スクロールするクエリ。 |
| System.Nullable<TimeSpan> | scrollTime |
スクロールの持続時間。 指定されていない場合は、ScrollTime が使用されます。 スクロール時間は長すぎないようにする必要があります。結果の各バッチを処理するのに十分な長さにします。 |
戻り値
| 型 | 説明 |
|---|---|
| IIdScroller |
IIdScroller インスタンス。 |
備考
スクロールを適切に使用して、スクロールの持続時間について scrollTime を制限します。
スクロールを不適切に使用すると、パフォーマンスの問題が発生する可能性があります。
詳細については、https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html を参照してください。
CreateEntityIterator(Query, IEntityLoadConfiguration)
Query に一致するすべての結果を繰り返す IEntityIterator を作成します。
宣言
パラメーター
| 型 | 名前 | 説明 |
|---|---|---|
| Query | query |
繰り返すクエリ。 |
| IEntityLoadConfiguration | loadConfiguration |
読み込み設定。これが null の場合、Default が使用されます。 |
戻り値
| 型 | 説明 |
|---|---|
| IEntityIterator |
イテレーター。 |
備考
3.0 SDKとの互換性のために、読み込み設定は次のように解決されます。
- null でない場合、
loadConfigurationが使用されます。 - null ではなく、該当する場合は、
queryから IQueryLoadConfiguration が使用されます。 - それ以外の場合、既定では Default です。
CreateEntityScroller(Query, Nullable<TimeSpan>, IEntityLoadConfiguration)
Query に一致するすべてのエンティティをスクロールする IEntityScroller を作成します。
宣言
パラメーター
| 型 | 名前 | 説明 |
|---|---|---|
| Query | query |
スクロールするクエリ。 |
| System.Nullable<TimeSpan> | scrollTime |
スクロールの持続時間。 指定されていない場合は、ScrollTime が使用されます。 スクロール時間は長すぎないようにする必要があります。結果の各バッチを処理するのに十分な長さにします。 |
| IEntityLoadConfiguration | loadConfiguration |
読み込み設定。これが null の場合、Default が使用されます。 |
戻り値
| 型 | 説明 |
|---|---|
| IEntityScroller |
IEntityScroller インスタンス。 |
備考
スクロールを適切に使用して、スクロールの持続時間について scrollTime を制限します。
スクロールを不適切に使用すると、パフォーマンスの問題が発生する可能性があります。
詳細については、https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html を参照してください。
QueryAsync(Query, IEntityLoadConfiguration)
query に一致するエンティティを取得します。
宣言
パラメーター
| 型 | 名前 | 説明 |
|---|---|---|
| Query | query |
実行するクエリ。 |
| IEntityLoadConfiguration | loadConfiguration |
読み込み設定。これが null の場合、Default が使用されます。 |
戻り値
| 型 | 説明 |
|---|---|
| Task<IEntityQueryResult> |
クエリの結果を含む IEntityQueryResult。 |
備考
3.0 SDKとの互換性のために、読み込み設定は次のように解決されます。
- null でない場合、
loadConfigurationが使用されます。 - null ではなく、該当する場合は、
queryから IQueryLoadConfiguration が使用されます。 - それ以外の場合、既定では Default です。
QueryIdsAsync(Query)
query に一致するエンティティの ID を取得します。
宣言
パラメーター
| 型 | 名前 | 説明 |
|---|---|---|
| Query | query |
実行するクエリ。 |
戻り値
| 型 | 説明 |
|---|---|
| Task<IIdQueryResult> |
クエリの結果を含む IEntityQueryResult。 |
SingleAsync(Query, IEntityLoadConfiguration)
クエリに一致する単一のエンティティを取得します。
宣言
パラメーター
| 型 | 名前 | 説明 |
|---|---|---|
| Query | query |
実行するクエリ。 |
| IEntityLoadConfiguration | loadConfiguration |
読み込み設定。これが null の場合、Default が使用されます。 |
戻り値
| 型 | 説明 |
|---|---|
| Task<IEntity> |
クエリに一致するエンティティ。結果がない場合は null 。 |
備考
3.0 SDKとの互換性のために、読み込み設定は次のように解決されます。
- null でない場合、
loadConfigurationが使用されます。 - null ではなく、該当する場合は、
queryから IQueryLoadConfiguration が使用されます。 - それ以外の場合、既定では Default です。
SingleIdAsync(Query)
クエリに一致するエンティティの ID を取得します。
宣言
パラメーター
| 型 | 名前 | 説明 |
|---|---|---|
| Query | query |
実行するクエリ。 |
戻り値
| 型 | 説明 |
|---|---|
| Task<System.Nullable<System.Int64>> |
クエリに一致するエンティティの ID、または結果がない場合は null 。 |