mtfosbot/vendor/github.com/olivere/elastic/search_aggs_bucket_histogram.go

266 lines
6.7 KiB
Go
Raw Normal View History

2018-10-05 08:36:16 +00:00
// 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
// HistogramAggregation is a multi-bucket values source based aggregation
// that can be applied on numeric values extracted from the documents.
// It dynamically builds fixed size (a.k.a. interval) buckets over the
// values.
// See: https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-aggregations-bucket-histogram-aggregation.html
type HistogramAggregation struct {
field string
script *Script
missing interface{}
subAggregations map[string]Aggregation
meta map[string]interface{}
interval float64
order string
orderAsc bool
minDocCount *int64
minBounds *float64
maxBounds *float64
offset *float64
}
func NewHistogramAggregation() *HistogramAggregation {
return &HistogramAggregation{
subAggregations: make(map[string]Aggregation),
}
}
func (a *HistogramAggregation) Field(field string) *HistogramAggregation {
a.field = field
return a
}
func (a *HistogramAggregation) Script(script *Script) *HistogramAggregation {
a.script = script
return a
}
// Missing configures the value to use when documents miss a value.
func (a *HistogramAggregation) Missing(missing interface{}) *HistogramAggregation {
a.missing = missing
return a
}
func (a *HistogramAggregation) SubAggregation(name string, subAggregation Aggregation) *HistogramAggregation {
a.subAggregations[name] = subAggregation
return a
}
// Meta sets the meta data to be included in the aggregation response.
func (a *HistogramAggregation) Meta(metaData map[string]interface{}) *HistogramAggregation {
a.meta = metaData
return a
}
// Interval for this builder, must be greater than 0.
func (a *HistogramAggregation) Interval(interval float64) *HistogramAggregation {
a.interval = interval
return a
}
// Order specifies the sort order. Valid values for order are:
// "_key", "_count", a sub-aggregation name, or a sub-aggregation name
// with a metric.
func (a *HistogramAggregation) Order(order string, asc bool) *HistogramAggregation {
a.order = order
a.orderAsc = asc
return a
}
func (a *HistogramAggregation) OrderByCount(asc bool) *HistogramAggregation {
// "order" : { "_count" : "asc" }
a.order = "_count"
a.orderAsc = asc
return a
}
func (a *HistogramAggregation) OrderByCountAsc() *HistogramAggregation {
return a.OrderByCount(true)
}
func (a *HistogramAggregation) OrderByCountDesc() *HistogramAggregation {
return a.OrderByCount(false)
}
func (a *HistogramAggregation) OrderByKey(asc bool) *HistogramAggregation {
// "order" : { "_key" : "asc" }
a.order = "_key"
a.orderAsc = asc
return a
}
func (a *HistogramAggregation) OrderByKeyAsc() *HistogramAggregation {
return a.OrderByKey(true)
}
func (a *HistogramAggregation) OrderByKeyDesc() *HistogramAggregation {
return a.OrderByKey(false)
}
// OrderByAggregation creates a bucket ordering strategy which sorts buckets
// based on a single-valued calc get.
func (a *HistogramAggregation) OrderByAggregation(aggName string, asc bool) *HistogramAggregation {
// {
// "aggs" : {
// "genders" : {
// "terms" : {
// "field" : "gender",
// "order" : { "avg_height" : "desc" }
// },
// "aggs" : {
// "avg_height" : { "avg" : { "field" : "height" } }
// }
// }
// }
// }
a.order = aggName
a.orderAsc = asc
return a
}
// OrderByAggregationAndMetric creates a bucket ordering strategy which
// sorts buckets based on a multi-valued calc get.
func (a *HistogramAggregation) OrderByAggregationAndMetric(aggName, metric string, asc bool) *HistogramAggregation {
// {
// "aggs" : {
// "genders" : {
// "terms" : {
// "field" : "gender",
// "order" : { "height_stats.avg" : "desc" }
// },
// "aggs" : {
// "height_stats" : { "stats" : { "field" : "height" } }
// }
// }
// }
// }
a.order = aggName + "." + metric
a.orderAsc = asc
return a
}
func (a *HistogramAggregation) MinDocCount(minDocCount int64) *HistogramAggregation {
a.minDocCount = &minDocCount
return a
}
func (a *HistogramAggregation) ExtendedBounds(min, max float64) *HistogramAggregation {
a.minBounds = &min
a.maxBounds = &max
return a
}
func (a *HistogramAggregation) ExtendedBoundsMin(min float64) *HistogramAggregation {
a.minBounds = &min
return a
}
func (a *HistogramAggregation) MinBounds(min float64) *HistogramAggregation {
a.minBounds = &min
return a
}
func (a *HistogramAggregation) ExtendedBoundsMax(max float64) *HistogramAggregation {
a.maxBounds = &max
return a
}
func (a *HistogramAggregation) MaxBounds(max float64) *HistogramAggregation {
a.maxBounds = &max
return a
}
// Offset into the histogram
func (a *HistogramAggregation) Offset(offset float64) *HistogramAggregation {
a.offset = &offset
return a
}
func (a *HistogramAggregation) Source() (interface{}, error) {
// Example:
// {
// "aggs" : {
// "prices" : {
// "histogram" : {
// "field" : "price",
// "interval" : 50
// }
// }
// }
// }
//
// This method returns only the { "histogram" : { ... } } part.
source := make(map[string]interface{})
opts := make(map[string]interface{})
source["histogram"] = 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
}
opts["interval"] = a.interval
if a.order != "" {
o := make(map[string]interface{})
if a.orderAsc {
o[a.order] = "asc"
} else {
o[a.order] = "desc"
}
opts["order"] = o
}
if a.offset != nil {
opts["offset"] = *a.offset
}
if a.minDocCount != nil {
opts["min_doc_count"] = *a.minDocCount
}
if a.minBounds != nil || a.maxBounds != nil {
bounds := make(map[string]interface{})
if a.minBounds != nil {
bounds["min"] = a.minBounds
}
if a.maxBounds != nil {
bounds["max"] = a.maxBounds
}
opts["extended_bounds"] = bounds
}
// 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
}