PHP Class Elastica\Aggregation\AbstractTermsAggregation

Inheritance: extends AbstractSimpleAggregation
Show file Open project: ruflin/elastica

Public Methods

Method Description
setExclude ( string $pattern, string $flags = null ) Filter documents to exclude based on a regular expression.
setExecutionHint ( string $hint ) Instruct Elasticsearch to use direct field data or ordinals of the field values to execute this aggregation.
setInclude ( string $pattern, string $flags = null ) Filter documents to include based on a regular expression.
setMinimumDocumentCount ( integer $count ) Set the minimum number of documents in which a term must appear in order to be returned in a bucket.
setShardSize ( integer $shard_size ) Sets how many terms the coordinating node will request from each shard.
setSize ( integer $size ) Sets the amount of terms to be returned.

Method Details

setExclude() public method

Filter documents to exclude based on a regular expression.
public setExclude ( string $pattern, string $flags = null )
$pattern string a regular expression
$flags string Java Pattern flags

setExecutionHint() public method

The execution hint will be ignored if it is not applicable.
public setExecutionHint ( string $hint )
$hint string map or ordinals

setInclude() public method

Filter documents to include based on a regular expression.
public setInclude ( string $pattern, string $flags = null )
$pattern string a regular expression
$flags string Java Pattern flags

setMinimumDocumentCount() public method

Set the minimum number of documents in which a term must appear in order to be returned in a bucket.
public setMinimumDocumentCount ( integer $count )
$count integer

setShardSize() public method

Sets how many terms the coordinating node will request from each shard.
public setShardSize ( integer $shard_size )
$shard_size integer The amount of terms to be returned.

setSize() public method

Sets the amount of terms to be returned.
public setSize ( integer $size )
$size integer The amount of terms to be returned.