summaryrefslogtreecommitdiff
path: root/docs/reference/search/request/source-filtering.asciidoc
blob: 7b81742e087cdaa37af3c676c505649475f8e555 (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
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
[[search-request-source-filtering]]
=== Source filtering

added[1.0.0.Beta1]


Allows to control how the `_source` field is returned with every hit.

By default operations return the contents of the `_source` field unless
you have used the `fields` parameter or if the `_source` field is disabled.

You can turn off `_source` retrieval by using the `_source` parameter:

To disable `_source` retrieval set to `false`:

[source,js]
--------------------------------------------------
{
    "_source": false,
    "query" : {
        "term" : { "user" : "kimchy" }
    }
}
--------------------------------------------------

The `_source` also accepts one or more wildcard patterns to control what parts of the `_source` should be returned:

For example:

[source,js]
--------------------------------------------------
{
    "_source": "obj.*",
    "query" : {
        "term" : { "user" : "kimchy" }
    }
}
--------------------------------------------------

Or

[source,js]
--------------------------------------------------
{
    "_source": [ "obj1.*", "obj2.*" ],
    "query" : {
        "term" : { "user" : "kimchy" }
    }
}
--------------------------------------------------

Finally, for complete control, you can specify both include and exclude patterns:

[source,js]
--------------------------------------------------
{
    "_source": {
        "include": [ "obj1.*", "obj2.*" ],
        "exclude": [ "*.description" ],
    }
    "query" : {
        "term" : { "user" : "kimchy" }
    }
}
--------------------------------------------------