File: search_filters_range.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, sid, trixie
  • size: 1,964 kB
  • sloc: makefile: 17
file content (152 lines) | stat: -rw-r--r-- 3,140 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
// 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

// Filters documents with fields that have terms within
// a certain range. For details, see:
// http://www.elasticsearch.org/guide/reference/query-dsl/range-filter.html
type RangeFilter struct {
	Filter
	name         string
	from         *interface{}
	to           *interface{}
	timeZone     string
	format       string
	includeLower bool
	includeUpper bool
	cache        *bool
	cacheKey     string
	filterName   string
	execution    string
}

func NewRangeFilter(name string) RangeFilter {
	f := RangeFilter{name: name, includeLower: true, includeUpper: true}
	return f
}

// TimeZone allows for adjusting the from/to fields using a time zone.
// Only valid for date fields.
func (f RangeFilter) TimeZone(timeZone string) RangeFilter {
	f.timeZone = timeZone
	return f
}

// Format is a valid option for date fields in a Range filter.
func (f RangeFilter) Format(format string) RangeFilter {
	f.format = format
	return f
}

func (f RangeFilter) From(from interface{}) RangeFilter {
	f.from = &from
	return f
}

func (f RangeFilter) Gt(from interface{}) RangeFilter {
	f.from = &from
	f.includeLower = false
	return f
}

func (f RangeFilter) Gte(from interface{}) RangeFilter {
	f.from = &from
	f.includeLower = true
	return f
}

func (f RangeFilter) To(to interface{}) RangeFilter {
	f.to = &to
	return f
}

func (f RangeFilter) Lt(to interface{}) RangeFilter {
	f.to = &to
	f.includeUpper = false
	return f
}

func (f RangeFilter) Lte(to interface{}) RangeFilter {
	f.to = &to
	f.includeUpper = true
	return f
}

func (f RangeFilter) IncludeLower(includeLower bool) RangeFilter {
	f.includeLower = includeLower
	return f
}

func (f RangeFilter) IncludeUpper(includeUpper bool) RangeFilter {
	f.includeUpper = includeUpper
	return f
}

func (f RangeFilter) Cache(cache bool) RangeFilter {
	f.cache = &cache
	return f
}

func (f RangeFilter) CacheKey(cacheKey string) RangeFilter {
	f.cacheKey = cacheKey
	return f
}

func (f RangeFilter) FilterName(filterName string) RangeFilter {
	f.filterName = filterName
	return f
}

func (f RangeFilter) Execution(execution string) RangeFilter {
	f.execution = execution
	return f
}

func (f RangeFilter) Source() interface{} {
	// {
	//   "range" : {
	//     "name" : {
	//       "..." : "..."
	//     }
	//   }
	// }

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

	rangeQ := make(map[string]interface{})
	source["range"] = rangeQ

	params := make(map[string]interface{})
	rangeQ[f.name] = params

	params["from"] = f.from
	params["to"] = f.to
	if f.timeZone != "" {
		params["time_zone"] = f.timeZone
	}
	if f.format != "" {
		params["format"] = f.format
	}
	params["include_lower"] = f.includeLower
	params["include_upper"] = f.includeUpper

	if f.filterName != "" {
		rangeQ["_name"] = f.filterName
	}

	if f.cache != nil {
		rangeQ["_cache"] = *f.cache
	}

	if f.cacheKey != "" {
		rangeQ["_cache_key"] = f.cacheKey
	}

	if f.execution != "" {
		rangeQ["execution"] = f.execution
	}

	return source
}