1. QueryingClientBase

クラス QueryingClientBase

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

クライアントをクエリするための基本クラス。

継承
System.Object
QueryingClientBase
名前空間: Stylelabs.M.Sdk.Models.Clients
アセンブリ: Stylelabs.M.Sdk.dll
構文
public abstract class QueryingClientBase : object, IQueryingClient

コンストラクター

QueryingClientBase(IMClient)

宣言
protected QueryingClientBase(IMClient client)
パラメーター
型名前説明
IMClientclient

メソッド

CreateEntityIdIterator(Query)

Query に一致するすべての ID を繰り返す IEntityIterator を作成します。

宣言
public IIdIterator CreateEntityIdIterator(Query query)
パラメーター
型名前説明
Queryquery

繰り返すクエリ。

戻り値
型説明
IIdIterator

イテレーター。

CreateEntityIdScroller(Query, Nullable<TimeSpan>)

Query に一致するエンティティのすべての ID をスクロールする IIdScroller を作成します。

宣言
public IIdScroller CreateEntityIdScroller(Query query, TimeSpan? scrollTime = null)
パラメーター
型名前説明
Queryquery

スクロールするクエリ。

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 を作成します。

宣言
public IEntityIterator CreateEntityIterator(Query query, IEntityLoadConfiguration loadConfiguration = null)
パラメーター
型名前説明
Queryquery

繰り返すクエリ。

IEntityLoadConfigurationloadConfiguration

読み込み設定。これが null の場合、Default が使用されます。

戻り値
型説明
IEntityIterator

イテレーター。

備考

3.0 SDKとの互換性のために、読み込み設定は次のように解決されます。

  1. null でない場合、loadConfiguration が使用されます。
  2. null ではなく、該当する場合は、query から IQueryLoadConfiguration が使用されます。
  3. それ以外の場合、既定では Default です。

CreateEntityScroller(Query, Nullable<TimeSpan>, IEntityLoadConfiguration)

Query に一致するすべてのエンティティをスクロールする IEntityScroller を作成します。

宣言
public IEntityScroller CreateEntityScroller(Query query, TimeSpan? scrollTime = null, IEntityLoadConfiguration loadConfiguration = null)
パラメーター
型名前説明
Queryquery

スクロールするクエリ。

System.Nullable<TimeSpan>scrollTime

スクロールの持続時間。 指定されていない場合は、ScrollTime が使用されます。 スクロール時間は長すぎないようにする必要があります。結果の各バッチを処理するのに十分な長さにします。

IEntityLoadConfigurationloadConfiguration

読み込み設定。これが null の場合、Default が使用されます。

戻り値
型説明
IEntityScroller

IEntityScroller インスタンス。

備考

スクロールを適切に使用して、スクロールの持続時間について scrollTime を制限します。 スクロールを不適切に使用すると、パフォーマンスの問題が発生する可能性があります。 詳細については、https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html を参照してください。

GetEntityScrollEngine()

エンティティ検索用の実装固有のスクロール エンジンを取得します。

宣言
protected abstract IScrollEngine<IEntityScrollResult> GetEntityScrollEngine()
戻り値
型説明
IScrollEngine<IEntityScrollResult>

GetIdScrollEngine()

ID 検索用の実装固有のスクロール エンジンを取得します。

宣言
protected abstract IScrollEngine<IIdScrollResult> GetIdScrollEngine()
戻り値
型説明
IScrollEngine<IIdScrollResult>

QueryAsync(Query, IEntityLoadConfiguration)

query に一致するエンティティを取得します。

宣言
public abstract Task<IEntityQueryResult> QueryAsync(Query query, IEntityLoadConfiguration loadConfiguration = null)
パラメーター
型名前説明
Queryquery

実行するクエリ。

IEntityLoadConfigurationloadConfiguration

読み込み設定。これが null の場合、Default が使用されます。

戻り値
型説明
Task<IEntityQueryResult>

クエリの結果を含む IEntityQueryResult。

備考

3.0 SDKとの互換性のために、読み込み設定は次のように解決されます。

  1. null でない場合、loadConfiguration が使用されます。
  2. null ではなく、該当する場合は、query から IQueryLoadConfiguration が使用されます。
  3. それ以外の場合、既定では Default です。

QueryIdsAsync(Query)

query に一致するエンティティの ID を取得します。

宣言
public abstract Task<IIdQueryResult> QueryIdsAsync(Query query)
パラメーター
型名前説明
Queryquery

実行するクエリ。

戻り値
型説明
Task<IIdQueryResult>

クエリの結果を含む IEntityQueryResult。

ResolveLoadConfiguration(Query, IEntityLoadConfiguration)

宣言
protected static IQueryLoadConfiguration ResolveLoadConfiguration(Query query, IEntityLoadConfiguration loadConfiguration)
パラメーター
型名前説明
Queryquery
IEntityLoadConfigurationloadConfiguration
戻り値
型説明
IQueryLoadConfiguration

SingleAsync(Query, IEntityLoadConfiguration)

クエリに一致する単一のエンティティを取得します。

宣言
public Task<IEntity> SingleAsync(Query query, IEntityLoadConfiguration loadConfiguration = null)
パラメーター
型名前説明
Queryquery

実行するクエリ。

IEntityLoadConfigurationloadConfiguration

読み込み設定。これが null の場合、Default が使用されます。

戻り値
型説明
Task<IEntity>

クエリに一致するエンティティ。結果がない場合は null 。

備考

3.0 SDKとの互換性のために、読み込み設定は次のように解決されます。

  1. null でない場合、loadConfiguration が使用されます。
  2. null ではなく、該当する場合は、query から IQueryLoadConfiguration が使用されます。
  3. それ以外の場合、既定では Default です。

SingleIdAsync(Query)

クエリに一致するエンティティの ID を取得します。

宣言
public Task<long?> SingleIdAsync(Query query)
パラメーター
型名前説明
Queryquery

実行するクエリ。

戻り値
型説明
Task<System.Nullable<System.Int64>>

クエリに一致するエンティティの ID、または結果がない場合は null 。

実装

この記事を改善するための提案がある場合は、 お知らせください!