OpenSearch/docs/reference/mapping/params/meta.asciidoc

32 lines
782 B
Plaintext

[[mapping-field-meta]]
=== `meta`
Metadata attached to the field. This metadata is opaque to Elasticsearch, it is
only useful for multiple applications that work on the same indices to share
meta information about fields such as units
[source,console]
------------
PUT my-index-000001
{
"mappings": {
"properties": {
"latency": {
"type": "long",
"meta": {
"unit": "ms"
}
}
}
}
}
------------
// TEST
NOTE: Field metadata enforces at most 5 entries, that keys have a length that
is less than or equal to 20, and that values are strings whose length is less
than or equal to 50.
NOTE: Field metadata is updatable by submitting a mapping update. The metadata
of the update will override the metadata of the existing field.