すべてのプロダクト
Search

このプロダクト

    OpenSearch:SearchParamsBuilder

    ドキュメントセンター

    OpenSearch:SearchParamsBuilder

    最終更新日:Dec 28, 2024

    概要

    SearchParamsBuilder クラスは、SearchParams オブジェクトのパラメーターオブジェクトを構築するために使用されます。

    コンストラクター

    メソッド定義

    mixed  OpenSearch\Util\SearchParamsBuilder::__construct($opts)

    パラメーターの説明

    パラメーター

    型

    説明

    $opts

    mixed

    クエリパラメーター。

    setStart

    検索結果で返される最初のドキュメントの序数を指定します。

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setStart(integer $start)

    パラメーターの説明

    パラメーター

    型

    説明

    $start

    integer

    検索結果で返される最初のドキュメントの序数。

    setHits

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setHits( $hits)

    パラメーターの説明

    パラメーター

    型

    説明

    $hits

    integer

    各結果セットのドキュメントの最大数。

    setFormat

    戻り結果のデータ形式を指定します。サポートされている形式は、XML、JSON、および FULLJSON です。JSON 形式と比較して、FULLJSON 形式は variableValue などの追加フィールドをサポートしています。

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setFormat(String $format)

    パラメーターの説明

    パラメーター

    型

    説明

    $format

    String

    戻り結果のデータ形式。

    setAppName

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setAppName($appNames)

    パラメーターの説明

    パラメーター

    型

    説明

    $appNames

    mixed

    検索機能を実装するアプリケーションの名前。

    setQuery

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setQuery( $query)

    パラメーターの説明

    パラメーター

    型

    説明

    $query

    String

    次の形式のクエリキーワード：インデックスフィールド名：'キーワード' [AND または OR …]。

    setKvPairs

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setKvPairs( $kvPairs)

    パラメーターの説明

    パラメーター

    型

    説明

    $kvPairs

    String

    設定するキーと値のペア。

    setFetchFields

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setFetchFields(array $fetchFields)

    パラメーターの説明

    パラメーター

    型

    説明

    $fetchFields

    array

    結果に返されるフィールド。例：array('a', 'b')。

    setRouteValue

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setRouteValue( $routeValue)

    パラメーターの説明

    パラメーター

    型

    説明

    $routeValue

    Mixed

    グループ化に使用されるフィールド値。

    setCustomConfig

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setCustomConfig(String $key, Mixed $value)

    パラメーターの説明

    パラメーター

    型

    説明

    $key

    String

    カスタムパラメーターのキー。

    $value

    Mixed

    カスタムパラメーターの値。

    addFilter

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::addFilter( $filter,  $condition)

    パラメーターの説明

    パラメーター

    型

    説明

    $filter

    String

    フィルター条件。例：a > 1。

    $condition

    String

    2 つのフィルター条件を接続する論理演算子（AND や OR など）。

    setFilter

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setFilter($filterString)

    パラメーターの説明

    パラメーター

    型

    説明

    $filterString

    mixed

    フィルター条件。

    addSort

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::addSort( $field, $order)

    パラメーターの説明

    パラメーター

    型

    説明

    $field

    String

    ドキュメントのソート基準となるフィールド。

    $order

    mixed

    ソート方法。有効な値：SearchParamsBuilder::SORT_INCREASE および SearchParamsBuilder::SORT_DECREASE。

    setFirstRankName

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setFirstRankName( $firstRankName)

    パラメーターの説明

    パラメーター

    型

    説明

    $firstRankName

    String

    大まかなソート式に設定する名前。

    setSecondRankName

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setSecondRankName( $secondRankName)

    パラメーターの説明

    パラメーター

    型

    説明

    $secondRankName

    String

    精密なソート式に設定する名前。

    addAggregate

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::addAggregate( $agg)

    パラメーターの説明

    パラメーター

    型

    説明

    $agg

    array

    指定する集計設定。

    addDistinct

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::addDistinct( $dist)

    パラメーターの説明

    パラメーター

    型

    説明

    $dist

    array

    指定する重複排除設定。

    addSummary

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::addSummary( $summaryMeta)

    パラメーターの説明

    パラメーター

    型

    説明

    $summaryMeta

    array

    指定する概要フィールド設定。

    addQueryProcessor

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::addQueryProcessor( $qpName)

    パラメーターの説明

    パラメーター

    型

    説明

    $qpName

    array

    指定するクエリ分析設定。

    addDisableFunctions

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::addDisableFunctions( $disabledFunction)

    パラメーターの説明

    パラメーター

    型

    説明

    $disabledFunction

    String

    無効にするカスタムパラメーター。

    setCustomParam

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setCustomParam( $key,  $value)

    パラメーターの説明

    パラメーター

    型

    説明

    $key

    String

    カスタムパラメーターのキー。

    $value

    String

    カスタムパラメーターの値。

    setScrollExpire

    各スクロールクエリのタイムアウト期間を設定します。

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setScrollExpire($expiredTime)

    パラメーターの説明

    パラメーター

    型

    説明

    $expiredTime

    mixed

    各スクロールクエリのタイムアウト期間（分単位）。例：3m。

    setScrollId

    実行するスクロールクエリの ID を指定します。ID は、最初のスクロールクエリが実行された後に返されます。

    メソッド定義

    void  OpenSearch\Util\SearchParamsBuilder::setScrollId(String $scrollId)

    パラメーターの説明

    パラメーター

    型

    説明

    $scrollId

    String

    実行するスクロールクエリの ID。

    build

    メソッド定義

    \OpenSearch\Generated\Search\SearchParams     OpenSearch\Util\SearchParamsBuilder::build()

    • このメソッドは、SearchParams オブジェクトを作成するために使用されます。