Feature description
Configures search parameters and builds a SearchParams object.
Constructor
Function definition
mixed OpenSearch\Util\SearchParamsBuilder::__construct($opts)Parameter description
Parameter name | Type | Description |
$opts | mixed | Contains various query parameters. |
Set the offset of the result set
Specifies the starting document from which to return results.
Function definition
void OpenSearch\Util\SearchParamsBuilder::setStart(integer $start)Parameter description
Parameter name | Type | Description |
$start | integer | The document from which to start returning results. |
Specify the number of results to return
Function overview
void OpenSearch\Util\SearchParamsBuilder::setHits( $hits)Parameter description
Parameter Name | Type | Description |
$hits | integer | The number of results to return. |
Set the format of the result set
Specifies the format of the returned documents. Valid formats are xml, JSON, and fulljson. The fulljson format returns more nodes than the JSON format, such as `variableValue`.
Function definition
void OpenSearch\Util\SearchParamsBuilder::setFormat(String $format)Parameter description
Parameter Name | Type | Description |
$format | String | The format of the result set, which is JSON. |
Set the name or ID of the application to search
Function definition
void OpenSearch\Util\SearchParamsBuilder::setAppName($appNames)Parameter description
Parameter name | Type | Description |
$appNames | mixed | The application name. |
Set the search keywords
Function definition
void OpenSearch\Util\SearchParamsBuilder::setQuery( $query)Parameter description
Parameter name | Type | Description |
$query | String | The search keywords. Use the following format: `index_name:'keyword' [ AND | OR ... ]`. |
Set key-value pairs
Function definition
void OpenSearch\Util\SearchParamsBuilder::setKvPairs( $kvPairs)Parameter description
Parameter name | Type | Description |
$kvPairs | String | Set the key-value pairs. |
Set the fields to return in the result set
Function definition
void OpenSearch\Util\SearchParamsBuilder::setFetchFields(array $fetchFields)Parameter description
Parameter name | Type | Description |
$fetchFields | array | A list of fields to return. For example, `array('a', 'b')`. |
Specify the group value for a group query
Function definition
void OpenSearch\Util\SearchParamsBuilder::setRouteValue( $routeValue)Parameter description
Parameter name | Type | Description |
$routeValue | Mixed | The value of the grouping field. |
Add a custom parameter to the Config clause
Function definition
void OpenSearch\Util\SearchParamsBuilder::setCustomConfig(String $key, Mixed $value)Parameter description
Parameter name | Type | Description |
$key | String | You can set a custom parameter name. |
$value | Mixed | You can set custom parameter values. |
Add a filter condition
Function definition
void OpenSearch\Util\SearchParamsBuilder::addFilter( $filter, $condition)Parameter description
Parameter Name | Type | Description |
$filter | String | The filter condition. For example, `a>1`. |
$condition | String | The operator that connects two filter conditions, such as AND or OR. |
Set the filter condition
Function definition
void OpenSearch\Util\SearchParamsBuilder::setFilter($filterString)Parameter description
Parameter | Type | Description |
$filterString | mixed | The filter condition. |
Add a sort rule
Function definition
void OpenSearch\Util\SearchParamsBuilder::addSort( $field, $order)Parameter description
Parameter name | Type | Description |
$field | String | The field to sort by. |
$order | mixed | `SearchParamsBuilder::SORT_INCREASE` or `SearchParamsBuilder::SORT_DECREASE` |
Set the rough sort expression name
Function definition
void OpenSearch\Util\SearchParamsBuilder::setFirstRankName( $firstRankName)Parameter description
Parameter name | Type | Description |
$firstRankName | String | The name of the rough sort expression. |
Set the fine sort expression name
Function definition
void OpenSearch\Util\SearchParamsBuilder::setSecondRankName( $secondRankName)Parameter description
Parameter name | Type | Description |
$secondRankName | String | The name of the fine sort expression. |
Set the aggregation configuration
Function definition
void OpenSearch\Util\SearchParamsBuilder::addAggregate( $agg)Parameter description
Parameter name | Type | Description |
$agg | array | The aggregation configuration. |
Set the deduplication configuration
Function definition
void OpenSearch\Util\SearchParamsBuilder::addDistinct( $dist)Parameter description
Parameter name | Type | Description |
$dist | array | The deduplication configuration. |
Set the search result summary configuration
Function definition
void OpenSearch\Util\SearchParamsBuilder::addSummary( $summaryMeta)Parameter description
Parameter name | Type | Description |
$summaryMeta | array | The summary field configuration. |
Add a query analysis configuration
Function definition
void OpenSearch\Util\SearchParamsBuilder::addQueryProcessor( $qpName)Parameter description
Parameter name | Type | Description |
$qpName | array | The specified summary field configuration. |
Add a shutdown function
Function definition
void OpenSearch\Util\SearchParamsBuilder::addDisableFunctions( $disabledFunction)Parameter description
Parameter name | Type | Description |
$disabledFunction | String | The specified field configuration for the summary. |
Set a custom parameter
Function definition
void OpenSearch\Util\SearchParamsBuilder::setCustomParam( $key, $value)Parameter description
Parameter name | Type | Description |
$key | String | The name of the custom parameter. |
$value | String | The value of the custom parameter. |
Set the expiration time for scroll scan data
This time-to-live (TTL) specifies when the next scroll scan operation expires.
Function definition
void OpenSearch\Util\SearchParamsBuilder::setScrollExpire($expiredTime)Parameter description
Parameter name | Type | Description |
$expiredTime | mixed | The expiration time for the next scroll query. For example, to set the expiration to 3 minutes, set the value to `3m`. |
Set the scroll ID for scan data
The scroll ID is returned from the previous scan operation.
Function definition
void OpenSearch\Util\SearchParamsBuilder::setScrollId(String $scrollId)Parameter description
Parameter name | Type | Description |
$scrollId | String | Sets the scroll ID. |
Build the SearchParams object
Function definition
\OpenSearch\Generated\Search\SearchParams OpenSearch\Util\SearchParamsBuilder::build()Returns a `SearchParams` object.