SearchParamsBuilder类

功能简介

搜索参数配置类,用于构建搜索参数对象。

构造函数

函数定义

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对象

阿里云首页 智能开放搜索 OpenSearch 相关技术圈