summaryrefslogtreecommitdiff
path: root/docs/reference/mapping/fields/source-field.asciidoc
blob: 22bb963fa9de4bd6dbf3b765f5ef6333ee3d63ce (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
[[mapping-source-field]]
=== `_source`

The `_source` field is an automatically generated field that stores the
actual JSON that was used as the indexed document. It is not indexed
(searchable), just stored. When executing "fetch" requests, like
<<docs-get,get>> or
<<search-search,search>>, the `_source` field is
returned by default.

Though very handy to have around, the source field does incur storage
overhead within the index. For this reason, it can be disabled. For
example:

[source,js]
--------------------------------------------------
{
    "tweet" : {
        "_source" : {"enabled" : false}
    }
}
--------------------------------------------------

[float]
[[include-exclude]]
==== Includes / Excludes

Allow to specify paths in the source that would be included / excluded
when it's stored, supporting `*` as wildcard annotation. For example:

[source,js]
--------------------------------------------------
{
    "my_type" : {
        "_source" : {
            "includes" : ["path1.*", "path2.*"],
            "excludes" : ["pat3.*"]
        }
    }
}
--------------------------------------------------