summaryrefslogtreecommitdiff
path: root/docs/reference/mapping/fields/meta-field.asciidoc
blob: befaf4e8df0cd4ea8097c53219bdca9e3510d18d (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
[[mapping-meta-field]]
=== `_meta` field

Each mapping type can have custom meta data associated with it. These are not
used at all by Elasticsearch, but can be used to store application-specific
metadata, such as the class that a document belongs to:

[source,js]
--------------------------------------------------
PUT my_index
{
  "mappings": {
    "user": {
      "_meta": { <1>
        "class": "MyApp::User",
        "version": {
          "min": "1.0",
          "max": "1.3"
        }
      }
    }
  }
}
--------------------------------------------------
// CONSOLE
<1> This `_meta` info can be retrieved with the
    <<indices-get-mapping,GET mapping>> API.

The `_meta` field can be updated on an existing type using the
<<indices-put-mapping,PUT mapping>> API.