summaryrefslogtreecommitdiff
path: root/docs/reference/query-dsl/queries/span-near-query.asciidoc
blob: 39982e2ba227036b5e4e711548357cee0ea33d66 (plain)
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
[[query-dsl-span-near-query]]
=== Span Near Query

Matches spans which are near one another. One can specify _slop_, the
maximum number of intervening unmatched positions, as well as whether
matches are required to be in-order. The span near query maps to Lucene
`SpanNearQuery`. Here is an example:

[source,js]
--------------------------------------------------
{
    "span_near" : {
        "clauses" : [
            { "span_term" : { "field" : "value1" } },
            { "span_term" : { "field" : "value2" } },
            { "span_term" : { "field" : "value3" } }
        ],
        "slop" : 12,
        "in_order" : false,
        "collect_payloads" : false
    }
}
--------------------------------------------------

The `clauses` element is a list of one or more other span type queries
and the `slop` controls the maximum number of intervening unmatched
positions permitted.