honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/query-dsl/range-query.asciidoc

72 lines
2.1 KiB
Plaintext
Raw Normal View History

Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[[query-dsl-range-query]]
Docs: Reorganised the Query DSL docs into families and explaing query vs filter context
2015-06-03 19:59:22 -04:00
=== Range Query
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Matches documents with fields that have terms within a certain range.
The type of the Lucene query depends on the field type, for `string`
fields, the `TermRangeQuery`, while for number/date fields, the query is
a `NumericRangeQuery`. The following example returns all documents where
`age` is between `10` and `20`:
[source,js]
--------------------------------------------------
{
"range" : {
[DOCS] Deprecated the from/to/include_lower/include_upper params in the range query, range filter and numeric range filter. Better to use gt/gte/lt/lte as they are explicit.
2013-09-12 09:07:15 -04:00
"age" : {
"gte" : 10,
"lte" : 20,
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
"boost" : 2.0
}
}
}
--------------------------------------------------
[DOCS] Deprecated the from/to/include_lower/include_upper params in the range query, range filter and numeric range filter. Better to use gt/gte/lt/lte as they are explicit.
2013-09-12 09:07:15 -04:00
The `range` query accepts the following parameters:
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[DOCS] Deprecated the from/to/include_lower/include_upper params in the range query, range filter and numeric range filter. Better to use gt/gte/lt/lte as they are explicit.
2013-09-12 09:07:15 -04:00
[horizontal]
`gte`:: Greater-than or equal to
`gt`:: Greater-than
`lte`:: Less-than or equal to
`lt`:: Less-than
[DOCS] fixed typo Closes #5272
2014-03-26 09:51:02 -04:00
`boost`:: Sets the boost value of the query, defaults to `1.0`
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Search: add `format` support for date range filter and queries When the date format is defined in mapping, you can not use another format when querying using range date query or filter. For example, this won't work: ``` DELETE /test PUT /test/t/1 { "date": "2014-01-01" } GET /test/_search { "query": { "filtered": { "filter": { "range": { "date": { "from": "01/01/2014" } } } } } } ``` It causes: ``` Caused by: org.elasticsearch.ElasticsearchParseException: failed to parse date field [01/01/2014], tried both date format [dateOptionalTime], and timestamp number ``` It could be nice if we can support at query time another date format just like we support `analyzer` at search time on String fields. Something like: ``` GET /test/_search { "query": { "filtered": { "filter": { "range": { "date": { "from": "01/01/2014", "format": "dd/MM/yyyy" } } } } } } ``` Same for queries: ``` GET /test/_search { "query": { "range": { "date": { "from": "01/01/2014", "format": "dd/MM/yyyy" } } } } ``` Closes #7189.
2014-09-22 13:40:16 -04:00
[float]
Docs: Reorganised the Query DSL docs into families and explaing query vs filter context
2015-06-03 19:59:22 -04:00
==== Date options
Search: add `format` support for date range filter and queries When the date format is defined in mapping, you can not use another format when querying using range date query or filter. For example, this won't work: ``` DELETE /test PUT /test/t/1 { "date": "2014-01-01" } GET /test/_search { "query": { "filtered": { "filter": { "range": { "date": { "from": "01/01/2014" } } } } } } ``` It causes: ``` Caused by: org.elasticsearch.ElasticsearchParseException: failed to parse date field [01/01/2014], tried both date format [dateOptionalTime], and timestamp number ``` It could be nice if we can support at query time another date format just like we support `analyzer` at search time on String fields. Something like: ``` GET /test/_search { "query": { "filtered": { "filter": { "range": { "date": { "from": "01/01/2014", "format": "dd/MM/yyyy" } } } } } } ``` Same for queries: ``` GET /test/_search { "query": { "range": { "date": { "from": "01/01/2014", "format": "dd/MM/yyyy" } } } } ``` Closes #7189.
2014-09-22 13:40:16 -04:00
Search: add time zone setting for relative date math in range filter/query Filters and Queries now supports `time_zone` parameter which defines which time zone should be applied to the query or filter to convert it to UTC time based value. When applied on `date` fields the `range` filter and queries accept also a `time_zone` parameter. The `time_zone` parameter will be applied to your input lower and upper bounds and will move them to UTC time based date: [source,js] -------------------------------------------------- { "constant_score": { "filter": { "range" : { "born" : { "gte": "2012-01-01", "lte": "now", "time_zone": "+1:00" } } } } } { "range" : { "born" : { "gte": "2012-01-01", "lte": "now", "time_zone": "+1:00" } } } -------------------------------------------------- In the above examples, `gte` will be actually moved to `2011-12-31T23:00:00` UTC date. NOTE: if you give a date with a timezone explicitly defined and use the `time_zone` parameter, `time_zone` will be ignored. For example, setting `from` to `2012-01-01T00:00:00+01:00` with `"time_zone":"+10:00"` will still use `+01:00` time zone. Closes #3729.
2014-07-31 10:22:03 -04:00
When applied on `date` fields the `range` filter accepts also a `time_zone` parameter.
The `time_zone` parameter will be applied to your input lower and upper bounds and will
move them to UTC time based date:
[source,js]
--------------------------------------------------
{
"range" : {
"born" : {
"gte": "2012-01-01",
"lte": "now",
Docs: Update time_zone specification closes #12317
2015-07-21 03:18:30 -04:00
"time_zone": "+01:00"
Search: add time zone setting for relative date math in range filter/query Filters and Queries now supports `time_zone` parameter which defines which time zone should be applied to the query or filter to convert it to UTC time based value. When applied on `date` fields the `range` filter and queries accept also a `time_zone` parameter. The `time_zone` parameter will be applied to your input lower and upper bounds and will move them to UTC time based date: [source,js] -------------------------------------------------- { "constant_score": { "filter": { "range" : { "born" : { "gte": "2012-01-01", "lte": "now", "time_zone": "+1:00" } } } } } { "range" : { "born" : { "gte": "2012-01-01", "lte": "now", "time_zone": "+1:00" } } } -------------------------------------------------- In the above examples, `gte` will be actually moved to `2011-12-31T23:00:00` UTC date. NOTE: if you give a date with a timezone explicitly defined and use the `time_zone` parameter, `time_zone` will be ignored. For example, setting `from` to `2012-01-01T00:00:00+01:00` with `"time_zone":"+10:00"` will still use `+01:00` time zone. Closes #3729.
2014-07-31 10:22:03 -04:00
}
}
}
--------------------------------------------------
In the above example, `gte` will be actually moved to `2011-12-31T23:00:00` UTC date.
NOTE: if you give a date with a timezone explicitly defined and use the `time_zone` parameter, `time_zone` will be
Docs: Update range-query.asciidoc Closes #8740
2014-12-02 06:15:47 -05:00
ignored. For example, setting `gte` to `2012-01-01T00:00:00+01:00` with `"time_zone":"+10:00"` will still use `+01:00` time zone.
Search: add time zone setting for relative date math in range filter/query Filters and Queries now supports `time_zone` parameter which defines which time zone should be applied to the query or filter to convert it to UTC time based value. When applied on `date` fields the `range` filter and queries accept also a `time_zone` parameter. The `time_zone` parameter will be applied to your input lower and upper bounds and will move them to UTC time based date: [source,js] -------------------------------------------------- { "constant_score": { "filter": { "range" : { "born" : { "gte": "2012-01-01", "lte": "now", "time_zone": "+1:00" } } } } } { "range" : { "born" : { "gte": "2012-01-01", "lte": "now", "time_zone": "+1:00" } } } -------------------------------------------------- In the above examples, `gte` will be actually moved to `2011-12-31T23:00:00` UTC date. NOTE: if you give a date with a timezone explicitly defined and use the `time_zone` parameter, `time_zone` will be ignored. For example, setting `from` to `2012-01-01T00:00:00+01:00` with `"time_zone":"+10:00"` will still use `+01:00` time zone. Closes #3729.
2014-07-31 10:22:03 -04:00
Search: add `format` support for date range filter and queries When the date format is defined in mapping, you can not use another format when querying using range date query or filter. For example, this won't work: ``` DELETE /test PUT /test/t/1 { "date": "2014-01-01" } GET /test/_search { "query": { "filtered": { "filter": { "range": { "date": { "from": "01/01/2014" } } } } } } ``` It causes: ``` Caused by: org.elasticsearch.ElasticsearchParseException: failed to parse date field [01/01/2014], tried both date format [dateOptionalTime], and timestamp number ``` It could be nice if we can support at query time another date format just like we support `analyzer` at search time on String fields. Something like: ``` GET /test/_search { "query": { "filtered": { "filter": { "range": { "date": { "from": "01/01/2014", "format": "dd/MM/yyyy" } } } } } } ``` Same for queries: ``` GET /test/_search { "query": { "range": { "date": { "from": "01/01/2014", "format": "dd/MM/yyyy" } } } } ``` Closes #7189.
2014-09-22 13:40:16 -04:00
When applied on `date` fields the `range` query accepts also a `format` parameter.
The `format` parameter will help support another date format than the one defined in mapping:
[source,js]
--------------------------------------------------
{
"range" : {
"born" : {
"gte": "01/01/2012",
"lte": "2013",
"format": "dd/MM/yyyy||yyyy"
}
}
}
--------------------------------------------------