WARNING: Version 1.6 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› › ›

Range Filter

edit

Range Filter

edit

Filters documents with fields that have terms within a certain range. Similar to range query, except that it acts as a filter. Can be placed within queries that accept a filter.

{
    "constant_score" : {
        "filter" : {
            "range" : {
                "age" : {
                    "gte": 10,
                    "lte": 20
                }
            }
        }
    }
}

The range filter accepts the following parameters:

`gte`	Greater-than or equal to
`gt`	Greater-than
`lte`	Less-than or equal to
`lt`	Less-than

Date options

edit

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:

{
    "constant_score": {
        "filter": {
            "range" : {
                "born" : {
                    "gte": "2012-01-01",
                    "lte": "now",
                    "time_zone": "+1:00"
                }
            }
        }
    }
}

In the above example, gte will be actually moved to 2011-12-31T23:00:00 UTC date.

if you give a date with a timezone explicitly defined and use the time_zone parameter, time_zone will be 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.

When applied on date fields the range filter accepts also a format parameter. The format parameter will help support another date format than the one defined in mapping:

{
    "constant_score": {
        "filter": {
            "range" : {
                "born" : {
                    "gte": "01/01/2012",
                    "lte": "2013",
                    "format": "dd/MM/yyyy||yyyy"
                }
            }
        }
    }
}

Execution

edit

The execution option controls how the range filter internally executes. The execution option accepts the following values:

`index`	Uses the field’s inverted index in order to determine whether documents fall within the specified range.
`fielddata`	Uses fielddata in order to determine whether documents fall within the specified range.

In general for small ranges the index execution is faster and for longer ranges the fielddata execution is faster.

The fielddata execution, as the name suggests, uses field data and therefore requires more memory, so make sure you have sufficient memory on your nodes in order to use this execution mode. It usually makes sense to use it on fields you’re already aggregating or sorting by.

Caching

edit

The result of the filter is only automatically cached by default if the execution is set to index. The _cache can be set to false to turn it off.

If the now date math expression is used without rounding then a range filter will never be cached even if _cache is set to true. Also any filter that wraps this filter will never be cached.

« Query Filter Regexp Filter »