File: search_aggs_date_histogram.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 (303 lines) | stat: -rw-r--r-- 8,283 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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
// 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

// DateHistogramAggregation is a multi-bucket aggregation similar to the
// histogram except it can only be applied on date values.
// See: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html
type DateHistogramAggregation struct {
	field           string
	script          string
	scriptFile      string
	lang            string
	params          map[string]interface{}
	subAggregations map[string]Aggregation

	interval                   string
	order                      string
	orderAsc                   bool
	minDocCount                *int64
	extendedBoundsMin          interface{}
	extendedBoundsMax          interface{}
	preZone                    string
	postZone                   string
	preZoneAdjustLargeInterval *bool
	format                     string
	preOffset                  int64
	postOffset                 int64
	factor                     *float32
}

func NewDateHistogramAggregation() DateHistogramAggregation {
	a := DateHistogramAggregation{
		params:          make(map[string]interface{}),
		subAggregations: make(map[string]Aggregation),
	}
	return a
}

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

func (a DateHistogramAggregation) Script(script string) DateHistogramAggregation {
	a.script = script
	return a
}

func (a DateHistogramAggregation) ScriptFile(scriptFile string) DateHistogramAggregation {
	a.scriptFile = scriptFile
	return a
}

func (a DateHistogramAggregation) Lang(lang string) DateHistogramAggregation {
	a.lang = lang
	return a
}

func (a DateHistogramAggregation) Param(name string, value interface{}) DateHistogramAggregation {
	a.params[name] = value
	return a
}

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

// Allowed values are: "year", "quarter", "month", "week", "day",
// "hour", "minute". It also supports time settings like "1.5h"
// (up to "w" for weeks).
func (a DateHistogramAggregation) Interval(interval string) DateHistogramAggregation {
	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 DateHistogramAggregation) Order(order string, asc bool) DateHistogramAggregation {
	a.order = order
	a.orderAsc = asc
	return a
}

func (a DateHistogramAggregation) OrderByCount(asc bool) DateHistogramAggregation {
	// "order" : { "_count" : "asc" }
	a.order = "_count"
	a.orderAsc = asc
	return a
}

func (a DateHistogramAggregation) OrderByCountAsc() DateHistogramAggregation {
	return a.OrderByCount(true)
}

func (a DateHistogramAggregation) OrderByCountDesc() DateHistogramAggregation {
	return a.OrderByCount(false)
}

func (a DateHistogramAggregation) OrderByKey(asc bool) DateHistogramAggregation {
	// "order" : { "_key" : "asc" }
	a.order = "_key"
	a.orderAsc = asc
	return a
}

func (a DateHistogramAggregation) OrderByKeyAsc() DateHistogramAggregation {
	return a.OrderByKey(true)
}

func (a DateHistogramAggregation) OrderByKeyDesc() DateHistogramAggregation {
	return a.OrderByKey(false)
}

// OrderByAggregation creates a bucket ordering strategy which sorts buckets
// based on a single-valued calc get.
func (a DateHistogramAggregation) OrderByAggregation(aggName string, asc bool) DateHistogramAggregation {
	// {
	//     "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 DateHistogramAggregation) OrderByAggregationAndMetric(aggName, metric string, asc bool) DateHistogramAggregation {
	// {
	//     "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 DateHistogramAggregation) MinDocCount(minDocCount int64) DateHistogramAggregation {
	a.minDocCount = &minDocCount
	return a
}

func (a DateHistogramAggregation) PreZone(preZone string) DateHistogramAggregation {
	a.preZone = preZone
	return a
}

func (a DateHistogramAggregation) PostZone(postZone string) DateHistogramAggregation {
	a.postZone = postZone
	return a
}

func (a DateHistogramAggregation) PreZoneAdjustLargeInterval(preZoneAdjustLargeInterval bool) DateHistogramAggregation {
	a.preZoneAdjustLargeInterval = &preZoneAdjustLargeInterval
	return a
}

func (a DateHistogramAggregation) PreOffset(preOffset int64) DateHistogramAggregation {
	a.preOffset = preOffset
	return a
}

func (a DateHistogramAggregation) PostOffset(postOffset int64) DateHistogramAggregation {
	a.postOffset = postOffset
	return a
}

func (a DateHistogramAggregation) Factor(factor float32) DateHistogramAggregation {
	a.factor = &factor
	return a
}

func (a DateHistogramAggregation) Format(format string) DateHistogramAggregation {
	a.format = format
	return a
}

// ExtendedBoundsMin accepts int, int64, string, or time.Time values.
func (a DateHistogramAggregation) ExtendedBoundsMin(min interface{}) DateHistogramAggregation {
	a.extendedBoundsMin = min
	return a
}

// ExtendedBoundsMax accepts int, int64, string, or time.Time values.
func (a DateHistogramAggregation) ExtendedBoundsMax(max interface{}) DateHistogramAggregation {
	a.extendedBoundsMax = max
	return a
}

func (a DateHistogramAggregation) Source() interface{} {
	// Example:
	// {
	//     "aggs" : {
	//         "articles_over_time" : {
	//             "date_histogram" : {
	//                 "field" : "date",
	//                 "interval" : "month"
	//             }
	//         }
	//     }
	// }
	//
	// This method returns only the { "date_histogram" : { ... } } part.

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

	// ValuesSourceAggregationBuilder
	if a.field != "" {
		opts["field"] = a.field
	}
	if a.script != "" {
		opts["script"] = a.script
	}
	if a.scriptFile != "" {
		opts["script_file"] = a.scriptFile
	}
	if a.lang != "" {
		opts["lang"] = a.lang
	}
	if len(a.params) > 0 {
		opts["params"] = a.params
	}

	opts["interval"] = a.interval
	if a.minDocCount != nil {
		opts["min_doc_count"] = *a.minDocCount
	}
	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.preZone != "" {
		opts["pre_zone"] = a.preZone
	}
	if a.postZone != "" {
		opts["post_zone"] = a.postZone
	}
	if a.preZoneAdjustLargeInterval != nil {
		opts["pre_zone_adjust_large_interval"] = *a.preZoneAdjustLargeInterval
	}
	if a.preOffset != 0 {
		opts["pre_offset"] = a.preOffset
	}
	if a.postOffset != 0 {
		opts["post_offset"] = a.postOffset
	}
	if a.factor != nil {
		opts["factor"] = *a.factor
	}
	if a.format != "" {
		opts["format"] = a.format
	}
	if a.extendedBoundsMin != nil || a.extendedBoundsMax != nil {
		bounds := make(map[string]interface{})
		if a.extendedBoundsMin != nil {
			bounds["min"] = a.extendedBoundsMin
		}
		if a.extendedBoundsMax != nil {
			bounds["max"] = a.extendedBoundsMax
		}
		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 {
			aggsMap[name] = aggregate.Source()
		}
	}

	return source
}