功能簡介
搜尋參數配置類，用於構建搜尋參數對象。
建構函式
函數定義
mixed OpenSearch\Util\SearchParamsBuilder::__construct($opts)參數描述
參數名稱 | 類型 | 描述 |
$opts | mixed | 包含的內容為各種查詢參數 |
設定返回結果的位移量
設定從搜尋結果中第start個文檔開始返回。
函數定義
void OpenSearch\Util\SearchParamsBuilder::setStart(integer $start)參數描述
參數名稱 | 類型 | 描述 |
$start | integer | 設定從搜尋結果中第start個文檔開始返回。 |
設定返回結果的條數
函數定義
void OpenSearch\Util\SearchParamsBuilder::setHits( $hits)參數描述
參數名稱 | 類型 | 描述 |
$hits | integer | 返回結果的條數。 |
設定返回結果的格式
返回的文檔格式，有xml、JSON、fulljson三種格式可選。fulljson：比JSON類型多輸出一些節點，如variableValue等。
函數定義
void OpenSearch\Util\SearchParamsBuilder::setFormat(String $format)參數描述
參數名稱 | 類型 | 描述 |
$format | String | 返回結果的格式，有JSON。 |
設定要搜尋的應用程式名稱或ID
函數定義
void OpenSearch\Util\SearchParamsBuilder::setAppName($appNames)參數描述
參數名稱 | 類型 | 描述 |
$appNames | mixed | 應用程式名稱 |
設定搜尋關鍵詞
函數定義
void OpenSearch\Util\SearchParamsBuilder::setQuery( $query)參數描述
參數名稱 | 類型 | 描述 |
$query | String | 設定的搜尋關鍵詞，格式為：索引名：'關鍵詞' [ AND 或 OR … ] |
設定KVpairs
函數定義
void OpenSearch\Util\SearchParamsBuilder::setKvPairs( $kvPairs)參數描述
參數名稱 | 類型 | 描述 |
$kvPairs | String | 設定kvpairs。 |
設定結果集的返回欄位
函數定義
void OpenSearch\Util\SearchParamsBuilder::setFetchFields(array $fetchFields)參數描述
參數名稱 | 類型 | 描述 |
$fetchFields | array | 指定的返回欄位的列表，例如array('a', 'b') |
如果分組查詢時，指定分組的值
函數定義
void OpenSearch\Util\SearchParamsBuilder::setRouteValue( $routeValue)參數描述
參數名稱 | 類型 | 描述 |
$routeValue | Mixed | 分組欄位值。 |
在Config字句中增加自訂的參數
函數定義
void OpenSearch\Util\SearchParamsBuilder::setCustomConfig(String $key, Mixed $value)參數描述
參數名稱 | 類型 | 描述 |
$key | String | 設定自訂參數名。 |
$value | Mixed | 設定自訂參數值。 |
添加過濾條件
函數定義
void OpenSearch\Util\SearchParamsBuilder::addFilter( $filter, $condition)參數描述
參數名稱 | 類型 | 描述 |
$filter | String | 過濾，例如a>1。 |
$condition | String | 兩個過濾條件的串連符, 例如AND OR等。 |
設定過濾條件
函數定義
void OpenSearch\Util\SearchParamsBuilder::setFilter($filterString)參數描述
參數名稱 | 類型 | 描述 |
$filterString | mixed | 過濾條件 |
添加定序
函數定義
void OpenSearch\Util\SearchParamsBuilder::addSort( $field, $order)參數描述
參數名稱 | 類型 | 描述 |
$field | String | 排序欄位。 |
$order | mixed | SearchParamsBuilder::SORT_INCREASE 或 SearchParamsBuilder::SORT_DECREASE |
設定粗排運算式名稱
函數定義
void OpenSearch\Util\SearchParamsBuilder::setFirstRankName( $firstRankName)參數描述
參數名稱 | 類型 | 描述 |
$firstRankName | String | 指定的粗排運算式名稱。 |
設定精排運算式名稱。
函數定義
void OpenSearch\Util\SearchParamsBuilder::setSecondRankName( $secondRankName)參數描述
參數名稱 | 類型 | 描述 |
$secondRankName | String | 指定的精排運算式名稱。 |
設定彙總配置
函數定義
void OpenSearch\Util\SearchParamsBuilder::addAggregate( $agg)參數描述
參數名稱 | 類型 | 描述 |
$agg | array | 指定的彙總配置。 |
設定去重配置
函數定義
void OpenSearch\Util\SearchParamsBuilder::addDistinct( $dist)參數描述
參數名稱 | 類型 | 描述 |
$dist | array | 指定的去重配置。 |
設定搜尋結果摘要配置
函數定義
void OpenSearch\Util\SearchParamsBuilder::addSummary( $summaryMeta)參數描述
參數名稱 | 類型 | 描述 |
$summaryMeta | array | 指定的摘要欄位配置。 |
添加查詢分析配置
函數定義
void OpenSearch\Util\SearchParamsBuilder::addQueryProcessor( $qpName)參數描述
參數名稱 | 類型 | 描述 |
$qpName | array | 指定的摘要欄位配置。 |
添加要關閉的function
函數定義
void OpenSearch\Util\SearchParamsBuilder::addDisableFunctions( $disabledFunction)參數描述
參數名稱 | 類型 | 描述 |
$disabledFunction | String | 指定的摘要欄位配置。 |
設定自訂參數
函數定義
void OpenSearch\Util\SearchParamsBuilder::setCustomParam( $key, $value)參數描述
參數名稱 | 類型 | 描述 |
$key | String | 自訂參數的參數名。 |
$value | String | 自訂參數的參數值。 |
設定scroll掃描資料的到期時間
該到期時間，用於指定下一次發起scroll掃描操作的到期時間。
函數定義
void OpenSearch\Util\SearchParamsBuilder::setScrollExpire($expiredTime)參數描述
參數名稱 | 類型 | 描述 |
$expiredTime | mixed | 指定scroll下次查詢到期時間，比如設定為3分鐘，則值可設為 3m |
設定掃描資料的scrollId
ScrollId 為上一次掃描時返回的資訊。
函數定義
void OpenSearch\Util\SearchParamsBuilder::setScrollId(String $scrollId)參數描述
參數名稱 | 類型 | 描述 |
$scrollId | String | 設定scroll的scrollId。 |
擷取SearchParams對象
函數定義
\OpenSearch\Generated\Search\SearchParams OpenSearch\Util\SearchParamsBuilder::build()返回SearchParams對象