File: search_aggs_significant_terms.go

package info (click to toggle)
golang-gopkg-olivere-elastic.v2 2.0.12-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, forky, sid, trixie
  • size: 1,964 kB
  • sloc: makefile: 17
file content (122 lines) | stat: -rw-r--r-- 3,339 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
// Copyright 2012-2015 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

// SignificantSignificantTermsAggregation is an aggregation that returns interesting
// or unusual occurrences of terms in a set.
// See: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html
type SignificantTermsAggregation struct {
	field           string
	subAggregations map[string]Aggregation

	minDocCount      *int
	shardMinDocCount *int
	requiredSize     *int
	shardSize        *int
	filter           Filter
	executionHint    string
}

func NewSignificantTermsAggregation() SignificantTermsAggregation {
	a := SignificantTermsAggregation{
		subAggregations: make(map[string]Aggregation, 0),
	}
	return a
}

func (a SignificantTermsAggregation) Field(field string) SignificantTermsAggregation {
	a.field = field
	return a
}

func (a SignificantTermsAggregation) SubAggregation(name string, subAggregation Aggregation) SignificantTermsAggregation {
	a.subAggregations[name] = subAggregation
	return a
}

func (a SignificantTermsAggregation) MinDocCount(minDocCount int) SignificantTermsAggregation {
	a.minDocCount = &minDocCount
	return a
}

func (a SignificantTermsAggregation) ShardMinDocCount(shardMinDocCount int) SignificantTermsAggregation {
	a.shardMinDocCount = &shardMinDocCount
	return a
}

func (a SignificantTermsAggregation) RequiredSize(requiredSize int) SignificantTermsAggregation {
	a.requiredSize = &requiredSize
	return a
}

func (a SignificantTermsAggregation) ShardSize(shardSize int) SignificantTermsAggregation {
	a.shardSize = &shardSize
	return a
}

func (a SignificantTermsAggregation) BackgroundFilter(filter Filter) SignificantTermsAggregation {
	a.filter = filter
	return a
}

func (a SignificantTermsAggregation) ExecutionHint(hint string) SignificantTermsAggregation {
	a.executionHint = hint
	return a
}

func (a SignificantTermsAggregation) Source() interface{} {
	// Example:
	// {
	//     "query" : {
	//         "terms" : {"force" : [ "British Transport Police" ]}
	//     },
	//     "aggregations" : {
	//         "significantCrimeTypes" : {
	//             "significant_terms" : { "field" : "crime_type" }
	//         }
	//     }
	// }
	//
	// This method returns only the
	//   { "significant_terms" : { "field" : "crime_type" }
	// part.

	source := make(map[string]interface{})
	opts := make(map[string]interface{})
	source["significant_terms"] = opts

	if a.field != "" {
		opts["field"] = a.field
	}
	if a.requiredSize != nil {
		opts["size"] = *a.requiredSize // not a typo!
	}
	if a.shardSize != nil {
		opts["shard_size"] = *a.shardSize
	}
	if a.minDocCount != nil {
		opts["min_doc_count"] = *a.minDocCount
	}
	if a.shardMinDocCount != nil {
		opts["shard_min_doc_count"] = *a.shardMinDocCount
	}
	if a.filter != nil {
		opts["background_filter"] = a.filter.Source()
	}
	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 {
			aggsMap[name] = aggregate.Source()
		}
	}

	return source
}