OpenSearch/docs/reference/mapping/fields/meta-field.asciidoc

47 lines
1.0 KiB
Plaintext
Raw Normal View History

[[mapping-meta-field]]
=== `_meta` field
A 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": {
"_doc": {
"_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:
[source,js]
--------------------------------------------------
PUT my_index/_mapping/_doc
{
"_meta": {
"class": "MyApp2::User3",
"version": {
"min": "1.3",
"max": "1.5"
}
}
}
--------------------------------------------------
// CONSOLE
// TEST[continued]