PHP Class Elastica\QueryBuilder\DSL\Aggregation

See link: http://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html

Author: Manuel Andreo Garcia ([email protected])

Inheritance: implements Elastica\QueryBuilder\DSL

Afficher le fichier Open project: ruflin/elastica Class Usage Examples

Méthodes publiques

Méthode	Description
avg ( string $name ) : Elastica\Aggregation\Avg	avg aggregation.
bucket_script ( string $name, array \| null $bucketsPath = null, string \| null $script = null ) : BucketScript	bucket script aggregation.
cardinality ( string $name ) : Elastica\Aggregation\Cardinality	cardinality aggregation.
children ( string $name )	children aggregation.
date_histogram ( string $name, string $field, integer $interval ) : DateHistogram	date histogram aggregation.
date_range ( string $name ) : Elastica\Aggregation\DateRange	date range aggregation.
extended_stats ( string $name ) : Elastica\Aggregation\ExtendedStats	extended stats aggregation.
filter ( string $name, Elastica\Query\AbstractQuery $filter = null ) : Filter	filter aggregation.
filters ( string $name ) : Filters	filters aggregation.
geo_bounds ( string $name )	geo bounds aggregation.
geo_distance ( string $name, string $field, string \| array $origin ) : Elastica\Aggregation\GeoDistance	geo distance aggregation.
geohash_grid ( string $name, string $field ) : Elastica\Aggregation\GeohashGrid	geohash grid aggregation.
getType ( ) : string	must return type for QueryBuilder usage.
global_agg ( string $name ) : Elastica\Aggregation\GlobalAggregation	global aggregation.
histogram ( string $name, string $field, integer $interval ) : Histogram	histogram aggregation.
ipv4_range ( string $name, string $field ) : IpRange	ipv4 range aggregation.
max ( string $name ) : Elastica\Aggregation\Max	max aggregation.
min ( string $name ) : Elastica\Aggregation\Min	min aggregation.
missing ( string $name, string $field ) : Elastica\Aggregation\Missing	missing aggregation.
nested ( string $name, string $path ) : Elastica\Aggregation\Nested	nested aggregation.
percentile_ranks ( string $name )	percentile ranks aggregation.
percentiles ( string $name, string $field = null ) : Elastica\Aggregation\Percentiles	percentiles aggregation.
range ( string $name ) : Range	range aggregation.
reverse_nested ( string $name, string $path = null ) : Elastica\Aggregation\ReverseNested	reverse nested aggregation.
scripted_metric ( string $name, string \| null $initScript = null, string \| null $mapScript = null, string \| null $combineScript = null, string \| null $reduceScript = null ) : Elastica\Aggregation\ScriptedMetric	scripted metric aggregation.
serial_diff ( string $name, string \| null $bucketsPath = null ) : SerialDiff	serial diff aggregation.
significant_terms ( string $name ) : SignificantTerms	significant terms aggregation.
stats ( string $name ) : Elastica\Aggregation\Stats	stats aggregation.
sum ( string $name ) : Elastica\Aggregation\Sum	sum aggregation.
terms ( string $name ) : Terms	terms aggregation.
top_hits ( string $name ) : TopHits	top hits aggregation.
value_count ( string $name, string $field ) : Elastica\Aggregation\ValueCount	value count aggregation.

Method Details

avg() public méthode

avg aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html

public avg ( string $name ) : Elastica\Aggregation\Avg
$name	string
Résultat	Elastica\Aggregation\Avg

bucket_script() public méthode

bucket script aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html

public bucket_script ( string $name, array \| null $bucketsPath = null, string \| null $script = null ) : BucketScript
$name	string
$bucketsPath	array \| null
$script	string \| null
Résultat	Elastica\Aggregation\BucketScript

cardinality() public méthode

cardinality aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html

public cardinality ( string $name ) : Elastica\Aggregation\Cardinality
$name	string
Résultat	Elastica\Aggregation\Cardinality

children() public méthode

children aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html

public children ( string $name )
$name	string

date_histogram() public méthode

date histogram aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html

public date_histogram ( string $name, string $field, integer $interval ) : DateHistogram
$name	string	the name of this aggregation
$field	string	the name of the field on which to perform the aggregation
$interval	integer	the interval by which documents will be bucketed
Résultat	Elastica\Aggregation\DateHistogram

date_range() public méthode

date range aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html

public date_range ( string $name ) : Elastica\Aggregation\DateRange
$name	string
Résultat	Elastica\Aggregation\DateRange

extended_stats() public méthode

extended stats aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-extendedstats-aggregation.html

public extended_stats ( string $name ) : Elastica\Aggregation\ExtendedStats
$name	string
Résultat	Elastica\Aggregation\ExtendedStats

filter() public méthode

filter aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html

public filter ( string $name, Elastica\Query\AbstractQuery $filter = null ) : Filter
$name	string
$filter	Elastica\Query\AbstractQuery
Résultat	Elastica\Aggregation\Filter

filters() public méthode

filters aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html

public filters ( string $name ) : Filters
$name	string
Résultat	Elastica\Aggregation\Filters

geo_bounds() public méthode

geo bounds aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html

public geo_bounds ( string $name )
$name	string

geo_distance() public méthode

geo distance aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html

public geo_distance ( string $name, string $field, string \| array $origin ) : Elastica\Aggregation\GeoDistance
$name	string	the name if this aggregation
$field	string	the field on which to perform this aggregation
$origin	string \| array	the point from which distances will be calculated
Résultat	Elastica\Aggregation\GeoDistance

geohash_grid() public méthode

geohash grid aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html

public geohash_grid ( string $name, string $field ) : Elastica\Aggregation\GeohashGrid
$name	string	the name of this aggregation
$field	string	the field on which to perform this aggregation
Résultat	Elastica\Aggregation\GeohashGrid

getType() public méthode

must return type for QueryBuilder usage.

public getType ( ) : string
Résultat	string

global_agg() public méthode

global aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html

public global_agg ( string $name ) : Elastica\Aggregation\GlobalAggregation
$name	string
Résultat	Elastica\Aggregation\GlobalAggregation

histogram() public méthode

histogram aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html

public histogram ( string $name, string $field, integer $interval ) : Histogram
$name	string	the name of this aggregation
$field	string	the name of the field on which to perform the aggregation
$interval	integer	the interval by which documents will be bucketed
Résultat	Elastica\Aggregation\Histogram

ipv4_range() public méthode

ipv4 range aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html

public ipv4_range ( string $name, string $field ) : IpRange
$name	string
$field	string
Résultat	Elastica\Aggregation\IpRange

max() public méthode

max aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html

public max ( string $name ) : Elastica\Aggregation\Max
$name	string
Résultat	Elastica\Aggregation\Max

min() public méthode

min aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html

public min ( string $name ) : Elastica\Aggregation\Min
$name	string
Résultat	Elastica\Aggregation\Min

missing() public méthode

missing aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-missing-aggregation.html

public missing ( string $name, string $field ) : Elastica\Aggregation\Missing
$name	string
$field	string
Résultat	Elastica\Aggregation\Missing

nested() public méthode

nested aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html

public nested ( string $name, string $path ) : Elastica\Aggregation\Nested
$name	string
$path	string	the nested path for this aggregation
Résultat	Elastica\Aggregation\Nested

percentile_ranks() public méthode

percentile ranks aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html

public percentile_ranks ( string $name )
$name	string

percentiles() public méthode

percentiles aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-aggregation.html

public percentiles ( string $name, string $field = null ) : Elastica\Aggregation\Percentiles
$name	string	the name of this aggregation
$field	string	the field on which to perform this aggregation
Résultat	Elastica\Aggregation\Percentiles

range() public méthode

range aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html

public range ( string $name ) : Range
$name	string
Résultat	Elastica\Aggregation\Range

reverse_nested() public méthode

reverse nested aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-reverse-nested-aggregation.html

public reverse_nested ( string $name, string $path = null ) : Elastica\Aggregation\ReverseNested
$name	string	The name of this aggregation
$path	string	Optional path to the nested object for this aggregation. Defaults to the root of the main document.
Résultat	Elastica\Aggregation\ReverseNested

scripted_metric() public méthode

scripted metric aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html

public scripted_metric ( string $name, string \| null $initScript = null, string \| null $mapScript = null, string \| null $combineScript = null, string \| null $reduceScript = null ) : Elastica\Aggregation\ScriptedMetric
$name	string
$initScript	string \| null
$mapScript	string \| null
$combineScript	string \| null
$reduceScript	string \| null
Résultat	Elastica\Aggregation\ScriptedMetric

serial_diff() public méthode

serial diff aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-serialdiff-aggregation.html

public serial_diff ( string $name, string \| null $bucketsPath = null ) : SerialDiff
$name	string
$bucketsPath	string \| null
Résultat	Elastica\Aggregation\SerialDiff

significant_terms() public méthode

significant terms aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html

public significant_terms ( string $name ) : SignificantTerms
$name	string
Résultat	Elastica\Aggregation\SignificantTerms

stats() public méthode

stats aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html

public stats ( string $name ) : Elastica\Aggregation\Stats
$name	string
Résultat	Elastica\Aggregation\Stats

sum() public méthode

sum aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html

public sum ( string $name ) : Elastica\Aggregation\Sum
$name	string
Résultat	Elastica\Aggregation\Sum

terms() public méthode

terms aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html

public terms ( string $name ) : Terms
$name	string
Résultat	Elastica\Aggregation\Terms

top_hits() public méthode

top hits aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html

public top_hits ( string $name ) : TopHits
$name	string
Résultat	Elastica\Aggregation\TopHits

value_count() public méthode

value count aggregation.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html

public value_count ( string $name, string $field ) : Elastica\Aggregation\ValueCount
$name	string
$field	string
Résultat	Elastica\Aggregation\ValueCount