387 lines
10 KiB
Go
387 lines
10 KiB
Go
|
// Copyright 2012-present Oliver Eilhard. All rights reserved.
|
||
|
|
// Use of this source code is governed by a MIT-license.
|
||
|
|
// See http://olivere.mit-license.org/license.txt for details.
|
||
|
|
|
||
|
|
package elastic
|
||
|
|
|
||
|
|
// TermsAggregation is a multi-bucket value source based aggregation
|
||
|
|
// where buckets are dynamically built - one per unique value.
|
||
|
|
//
|
||
|
|
// See: http://www.elasticsearch.org/guide/en/elasticsearch/reference/6.2/search-aggregations-bucket-terms-aggregation.html
|
||
|
|
type TermsAggregation struct {
|
||
|
|
field string
|
||
|
|
script *Script
|
||
|
|
missing interface{}
|
||
|
|
subAggregations map[string]Aggregation
|
||
|
|
meta map[string]interface{}
|
||
|
|
|
||
|
|
size *int
|
||
|
|
shardSize *int
|
||
|
|
requiredSize *int
|
||
|
|
minDocCount *int
|
||
|
|
shardMinDocCount *int
|
||
|
|
valueType string
|
||
|
|
includeExclude *TermsAggregationIncludeExclude
|
||
|
|
executionHint string
|
||
|
|
collectionMode string
|
||
|
|
showTermDocCountError *bool
|
||
|
|
order []TermsOrder
|
||
|
|
}
|
||
|
|
|
||
|
|
func NewTermsAggregation() *TermsAggregation {
|
||
|
|
return &TermsAggregation{
|
||
|
|
subAggregations: make(map[string]Aggregation, 0),
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) Field(field string) *TermsAggregation {
|
||
|
|
a.field = field
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) Script(script *Script) *TermsAggregation {
|
||
|
|
a.script = script
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
// Missing configures the value to use when documents miss a value.
|
||
|
|
func (a *TermsAggregation) Missing(missing interface{}) *TermsAggregation {
|
||
|
|
a.missing = missing
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) SubAggregation(name string, subAggregation Aggregation) *TermsAggregation {
|
||
|
|
a.subAggregations[name] = subAggregation
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
// Meta sets the meta data to be included in the aggregation response.
|
||
|
|
func (a *TermsAggregation) Meta(metaData map[string]interface{}) *TermsAggregation {
|
||
|
|
a.meta = metaData
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) Size(size int) *TermsAggregation {
|
||
|
|
a.size = &size
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) RequiredSize(requiredSize int) *TermsAggregation {
|
||
|
|
a.requiredSize = &requiredSize
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) ShardSize(shardSize int) *TermsAggregation {
|
||
|
|
a.shardSize = &shardSize
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) MinDocCount(minDocCount int) *TermsAggregation {
|
||
|
|
a.minDocCount = &minDocCount
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) ShardMinDocCount(shardMinDocCount int) *TermsAggregation {
|
||
|
|
a.shardMinDocCount = &shardMinDocCount
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) Include(regexp string) *TermsAggregation {
|
||
|
|
if a.includeExclude == nil {
|
||
|
|
a.includeExclude = &TermsAggregationIncludeExclude{}
|
||
|
|
}
|
||
|
|
a.includeExclude.Include = regexp
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) IncludeValues(values ...interface{}) *TermsAggregation {
|
||
|
|
if a.includeExclude == nil {
|
||
|
|
a.includeExclude = &TermsAggregationIncludeExclude{}
|
||
|
|
}
|
||
|
|
a.includeExclude.IncludeValues = append(a.includeExclude.IncludeValues, values...)
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) Exclude(regexp string) *TermsAggregation {
|
||
|
|
if a.includeExclude == nil {
|
||
|
|
a.includeExclude = &TermsAggregationIncludeExclude{}
|
||
|
|
}
|
||
|
|
a.includeExclude.Exclude = regexp
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) ExcludeValues(values ...interface{}) *TermsAggregation {
|
||
|
|
if a.includeExclude == nil {
|
||
|
|
a.includeExclude = &TermsAggregationIncludeExclude{}
|
||
|
|
}
|
||
|
|
a.includeExclude.ExcludeValues = append(a.includeExclude.ExcludeValues, values...)
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) Partition(p int) *TermsAggregation {
|
||
|
|
if a.includeExclude == nil {
|
||
|
|
a.includeExclude = &TermsAggregationIncludeExclude{}
|
||
|
|
}
|
||
|
|
a.includeExclude.Partition = p
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) NumPartitions(n int) *TermsAggregation {
|
||
|
|
if a.includeExclude == nil {
|
||
|
|
a.includeExclude = &TermsAggregationIncludeExclude{}
|
||
|
|
}
|
||
|
|
a.includeExclude.NumPartitions = n
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
// ValueType can be string, long, or double.
|
||
|
|
func (a *TermsAggregation) ValueType(valueType string) *TermsAggregation {
|
||
|
|
a.valueType = valueType
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) Order(order string, asc bool) *TermsAggregation {
|
||
|
|
a.order = append(a.order, TermsOrder{Field: order, Ascending: asc})
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) OrderByCount(asc bool) *TermsAggregation {
|
||
|
|
// "order" : { "_count" : "asc" }
|
||
|
|
a.order = append(a.order, TermsOrder{Field: "_count", Ascending: asc})
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) OrderByCountAsc() *TermsAggregation {
|
||
|
|
return a.OrderByCount(true)
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) OrderByCountDesc() *TermsAggregation {
|
||
|
|
return a.OrderByCount(false)
|
||
|
|
}
|
||
|
|
|
||
|
|
// Deprecated: Use OrderByKey instead.
|
||
|
|
func (a *TermsAggregation) OrderByTerm(asc bool) *TermsAggregation {
|
||
|
|
// "order" : { "_term" : "asc" }
|
||
|
|
a.order = append(a.order, TermsOrder{Field: "_term", Ascending: asc})
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
// Deprecated: Use OrderByKeyAsc instead.
|
||
|
|
func (a *TermsAggregation) OrderByTermAsc() *TermsAggregation {
|
||
|
|
return a.OrderByTerm(true)
|
||
|
|
}
|
||
|
|
|
||
|
|
// Deprecated: Use OrderByKeyDesc instead.
|
||
|
|
func (a *TermsAggregation) OrderByTermDesc() *TermsAggregation {
|
||
|
|
return a.OrderByTerm(false)
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) OrderByKey(asc bool) *TermsAggregation {
|
||
|
|
// "order" : { "_term" : "asc" }
|
||
|
|
a.order = append(a.order, TermsOrder{Field: "_key", Ascending: asc})
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) OrderByKeyAsc() *TermsAggregation {
|
||
|
|
return a.OrderByKey(true)
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) OrderByKeyDesc() *TermsAggregation {
|
||
|
|
return a.OrderByKey(false)
|
||
|
|
}
|
||
|
|
|
||
|
|
// OrderByAggregation creates a bucket ordering strategy which sorts buckets
|
||
|
|
// based on a single-valued calc get.
|
||
|
|
func (a *TermsAggregation) OrderByAggregation(aggName string, asc bool) *TermsAggregation {
|
||
|
|
// {
|
||
|
|
// "aggs" : {
|
||
|
|
// "genders" : {
|
||
|
|
// "terms" : {
|
||
|
|
// "field" : "gender",
|
||
|
|
// "order" : { "avg_height" : "desc" }
|
||
|
|
// },
|
||
|
|
// "aggs" : {
|
||
|
|
// "avg_height" : { "avg" : { "field" : "height" } }
|
||
|
|
// }
|
||
|
|
// }
|
||
|
|
// }
|
||
|
|
// }
|
||
|
|
a.order = append(a.order, TermsOrder{Field: aggName, Ascending: asc})
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
// OrderByAggregationAndMetric creates a bucket ordering strategy which
|
||
|
|
// sorts buckets based on a multi-valued calc get.
|
||
|
|
func (a *TermsAggregation) OrderByAggregationAndMetric(aggName, metric string, asc bool) *TermsAggregation {
|
||
|
|
// {
|
||
|
|
// "aggs" : {
|
||
|
|
// "genders" : {
|
||
|
|
// "terms" : {
|
||
|
|
// "field" : "gender",
|
||
|
|
// "order" : { "height_stats.avg" : "desc" }
|
||
|
|
// },
|
||
|
|
// "aggs" : {
|
||
|
|
// "height_stats" : { "stats" : { "field" : "height" } }
|
||
|
|
// }
|
||
|
|
// }
|
||
|
|
// }
|
||
|
|
// }
|
||
|
|
a.order = append(a.order, TermsOrder{Field: aggName + "." + metric, Ascending: asc})
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) ExecutionHint(hint string) *TermsAggregation {
|
||
|
|
a.executionHint = hint
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
// Collection mode can be depth_first or breadth_first as of 1.4.0.
|
||
|
|
func (a *TermsAggregation) CollectionMode(collectionMode string) *TermsAggregation {
|
||
|
|
a.collectionMode = collectionMode
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) ShowTermDocCountError(showTermDocCountError bool) *TermsAggregation {
|
||
|
|
a.showTermDocCountError = &showTermDocCountError
|
||
|
|
return a
|
||
|
|
}
|
||
|
|
|
||
|
|
func (a *TermsAggregation) Source() (interface{}, error) {
|
||
|
|
// Example:
|
||
|
|
// {
|
||
|
|
// "aggs" : {
|
||
|
|
// "genders" : {
|
||
|
|
// "terms" : { "field" : "gender" }
|
||
|
|
// }
|
||
|
|
// }
|
||
|
|
// }
|
||
|
|
// This method returns only the { "terms" : { "field" : "gender" } } part.
|
||
|
|
|
||
|
|
source := make(map[string]interface{})
|
||
|
|
opts := make(map[string]interface{})
|
||
|
|
source["terms"] = opts
|
||
|
|
|
||
|
|
// ValuesSourceAggregationBuilder
|
||
|
|
if a.field != "" {
|
||
|
|
opts["field"] = a.field
|
||
|
|
}
|
||
|
|
if a.script != nil {
|
||
|
|
src, err := a.script.Source()
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
opts["script"] = src
|
||
|
|
}
|
||
|
|
if a.missing != nil {
|
||
|
|
opts["missing"] = a.missing
|
||
|
|
}
|
||
|
|
|
||
|
|
// TermsBuilder
|
||
|
|
if a.size != nil && *a.size >= 0 {
|
||
|
|
opts["size"] = *a.size
|
||
|
|
}
|
||
|
|
if a.shardSize != nil && *a.shardSize >= 0 {
|
||
|
|
opts["shard_size"] = *a.shardSize
|
||
|
|
}
|
||
|
|
if a.requiredSize != nil && *a.requiredSize >= 0 {
|
||
|
|
opts["required_size"] = *a.requiredSize
|
||
|
|
}
|
||
|
|
if a.minDocCount != nil && *a.minDocCount >= 0 {
|
||
|
|
opts["min_doc_count"] = *a.minDocCount
|
||
|
|
}
|
||
|
|
if a.shardMinDocCount != nil && *a.shardMinDocCount >= 0 {
|
||
|
|
opts["shard_min_doc_count"] = *a.shardMinDocCount
|
||
|
|
}
|
||
|
|
if a.showTermDocCountError != nil {
|
||
|
|
opts["show_term_doc_count_error"] = *a.showTermDocCountError
|
||
|
|
}
|
||
|
|
if a.collectionMode != "" {
|
||
|
|
opts["collect_mode"] = a.collectionMode
|
||
|
|
}
|
||
|
|
if a.valueType != "" {
|
||
|
|
opts["value_type"] = a.valueType
|
||
|
|
}
|
||
|
|
if len(a.order) > 0 {
|
||
|
|
var orderSlice []interface{}
|
||
|
|
for _, order := range a.order {
|
||
|
|
src, err := order.Source()
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
orderSlice = append(orderSlice, src)
|
||
|
|
}
|
||
|
|
opts["order"] = orderSlice
|
||
|
|
}
|
||
|
|
// Include/Exclude
|
||
|
|
if ie := a.includeExclude; ie != nil {
|
||
|
|
// Include
|
||
|
|
if ie.Include != "" {
|
||
|
|
opts["include"] = ie.Include
|
||
|
|
} else if len(ie.IncludeValues) > 0 {
|
||
|
|
opts["include"] = ie.IncludeValues
|
||
|
|
} else if ie.NumPartitions > 0 {
|
||
|
|
inc := make(map[string]interface{})
|
||
|
|
inc["partition"] = ie.Partition
|
||
|
|
inc["num_partitions"] = ie.NumPartitions
|
||
|
|
opts["include"] = inc
|
||
|
|
}
|
||
|
|
// Exclude
|
||
|
|
if ie.Exclude != "" {
|
||
|
|
opts["exclude"] = ie.Exclude
|
||
|
|
} else if len(ie.ExcludeValues) > 0 {
|
||
|
|
opts["exclude"] = ie.ExcludeValues
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if a.executionHint != "" {
|
||
|
|
opts["execution_hint"] = a.executionHint
|
||
|
|
}
|
||
|
|
|
||
|
|
// AggregationBuilder (SubAggregations)
|
||
|
|
if len(a.subAggregations) > 0 {
|
||
|
|
aggsMap := make(map[string]interface{})
|
||
|
|
source["aggregations"] = aggsMap
|
||
|
|
for name, aggregate := range a.subAggregations {
|
||
|
|
src, err := aggregate.Source()
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
aggsMap[name] = src
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// Add Meta data if available
|
||
|
|
if len(a.meta) > 0 {
|
||
|
|
source["meta"] = a.meta
|
||
|
|
}
|
||
|
|
|
||
|
|
return source, nil
|
||
|
|
}
|
||
|
|
|
||
|
|
// TermsAggregationIncludeExclude allows for include/exclude in a TermsAggregation.
|
||
|
|
type TermsAggregationIncludeExclude struct {
|
||
|
|
Include string
|
||
|
|
Exclude string
|
||
|
|
IncludeValues []interface{}
|
||
|
|
ExcludeValues []interface{}
|
||
|
|
Partition int
|
||
|
|
NumPartitions int
|
||
|
|
}
|
||
|
|
|
||
|
|
// TermsOrder specifies a single order field for a terms aggregation.
|
||
|
|
type TermsOrder struct {
|
||
|
|
Field string
|
||
|
|
Ascending bool
|
||
|
|
}
|
||
|
|
|
||
|
|
// Source returns serializable JSON of the TermsOrder.
|
||
|
|
func (order *TermsOrder) Source() (interface{}, error) {
|
||
|
|
source := make(map[string]string)
|
||
|
|
if order.Ascending {
|
||
|
|
source[order.Field] = "asc"
|
||
|
|
} else {
|
||
|
|
source[order.Field] = "desc"
|
||
|
|
}
|
||
|
|
return source, nil
|
||
|
|
}
|