2015-08-06 11:24:29 -04:00
|
|
|
[[mapping-meta-field]]
|
|
|
|
=== `_meta` field
|
|
|
|
|
2017-07-05 06:30:19 -04:00
|
|
|
A mapping type can have custom meta data associated with it. These are not
|
2015-08-06 11:24:29 -04:00
|
|
|
used at all by Elasticsearch, but can be used to store application-specific
|
|
|
|
metadata, such as the class that a document belongs to:
|
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2015-08-06 11:24:29 -04:00
|
|
|
--------------------------------------------------
|
2019-01-22 09:13:52 -05:00
|
|
|
PUT my_index
|
2015-08-06 11:24:29 -04:00
|
|
|
{
|
|
|
|
"mappings": {
|
2019-01-22 09:13:52 -05:00
|
|
|
"_meta": { <1>
|
|
|
|
"class": "MyApp::User",
|
|
|
|
"version": {
|
|
|
|
"min": "1.0",
|
|
|
|
"max": "1.3"
|
2015-08-06 11:24:29 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
--------------------------------------------------
|
2019-09-06 11:31:13 -04:00
|
|
|
|
2015-08-06 11:24:29 -04:00
|
|
|
<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
|
2018-11-28 06:04:57 -05:00
|
|
|
<<indices-put-mapping,PUT mapping>> API:
|
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2018-11-28 06:04:57 -05:00
|
|
|
--------------------------------------------------
|
2019-01-14 16:08:01 -05:00
|
|
|
PUT my_index/_mapping
|
2018-11-28 06:04:57 -05:00
|
|
|
{
|
|
|
|
"_meta": {
|
|
|
|
"class": "MyApp2::User3",
|
|
|
|
"version": {
|
|
|
|
"min": "1.3",
|
|
|
|
"max": "1.5"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
--------------------------------------------------
|
|
|
|
// TEST[continued]
|