2013-08-29 07:24:34 +08:00
|
|
|
[[mapping-fields]]
|
2020-08-06 01:21:00 +08:00
|
|
|
== Metadata fields
|
2013-08-29 07:24:34 +08:00
|
|
|
|
2020-09-30 22:47:29 +08:00
|
|
|
Each document has metadata associated with it, such as the `_index`
|
2021-03-31 21:57:47 +08:00
|
|
|
and `_id` metadata fields. The behavior of some of these metadata
|
2020-09-30 22:47:29 +08:00
|
|
|
fields can be customized when a mapping is created.
|
2013-08-29 07:24:34 +08:00
|
|
|
|
2020-07-23 23:48:22 +08:00
|
|
|
[discrete]
|
2020-08-06 01:21:00 +08:00
|
|
|
=== Identity metadata fields
|
2013-08-29 07:24:34 +08:00
|
|
|
|
2015-07-20 07:24:29 +08:00
|
|
|
[horizontal]
|
|
|
|
<<mapping-index-field,`_index`>>::
|
|
|
|
|
|
|
|
The index to which the document belongs.
|
|
|
|
|
|
|
|
<<mapping-id-field,`_id`>>::
|
|
|
|
|
|
|
|
The document's ID.
|
|
|
|
|
2020-07-23 23:48:22 +08:00
|
|
|
[discrete]
|
2020-08-06 01:21:00 +08:00
|
|
|
=== Document source metadata fields
|
2015-08-06 23:24:29 +08:00
|
|
|
|
2015-07-20 07:24:29 +08:00
|
|
|
<<mapping-source-field,`_source`>>::
|
|
|
|
|
|
|
|
The original JSON representing the body of the document.
|
|
|
|
|
2015-08-16 00:22:22 +08:00
|
|
|
{plugins}/mapper-size.html[`_size`]::
|
2015-08-06 23:24:29 +08:00
|
|
|
|
2015-08-16 00:00:55 +08:00
|
|
|
The size of the `_source` field in bytes, provided by the
|
2015-08-16 00:25:34 +08:00
|
|
|
{plugins}/mapper-size.html[`mapper-size` plugin].
|
2015-08-06 23:24:29 +08:00
|
|
|
|
2020-11-05 01:51:14 +08:00
|
|
|
[discrete]
|
2020-11-03 23:47:17 +08:00
|
|
|
=== Doc count metadata field
|
|
|
|
|
|
|
|
<<mapping-doc-count-field,`_doc_count`>>::
|
|
|
|
|
|
|
|
A custom field used for storing doc counts when a document represents pre-aggregated data.
|
|
|
|
|
2020-07-23 23:48:22 +08:00
|
|
|
[discrete]
|
2020-08-06 01:21:00 +08:00
|
|
|
=== Indexing metadata fields
|
2015-08-06 23:24:29 +08:00
|
|
|
|
2015-07-20 07:24:29 +08:00
|
|
|
<<mapping-field-names-field,`_field_names`>>::
|
|
|
|
|
|
|
|
All fields in the document which contain non-null values.
|
|
|
|
|
2018-05-02 16:47:02 +08:00
|
|
|
<<mapping-ignored-field,`_ignored`>>::
|
|
|
|
|
|
|
|
All fields in the document that have been ignored at index time because of
|
|
|
|
<<ignore-malformed,`ignore_malformed`>>.
|
|
|
|
|
2020-07-23 23:48:22 +08:00
|
|
|
[discrete]
|
2020-08-06 01:21:00 +08:00
|
|
|
=== Routing metadata field
|
2015-07-20 07:24:29 +08:00
|
|
|
|
|
|
|
<<mapping-routing-field,`_routing`>>::
|
|
|
|
|
|
|
|
A custom routing value which routes a document to a particular shard.
|
|
|
|
|
2020-07-23 23:48:22 +08:00
|
|
|
[discrete]
|
2020-08-06 01:21:00 +08:00
|
|
|
=== Other metadata field
|
2015-07-20 07:24:29 +08:00
|
|
|
|
2015-08-06 23:24:29 +08:00
|
|
|
<<mapping-meta-field,`_meta`>>::
|
2015-07-20 07:24:29 +08:00
|
|
|
|
2015-08-06 23:24:29 +08:00
|
|
|
Application specific metadata.
|
2015-07-20 07:24:29 +08:00
|
|
|
|
2021-04-09 02:41:52 +08:00
|
|
|
<<mapping-tier-field,`_tier`>>::
|
|
|
|
|
|
|
|
The current data tier preference of the index to which the document belongs.
|
|
|
|
|
2020-11-03 23:47:17 +08:00
|
|
|
include::fields/doc-count-field.asciidoc[]
|
2015-07-20 07:24:29 +08:00
|
|
|
|
2015-08-06 23:24:29 +08:00
|
|
|
include::fields/field-names-field.asciidoc[]
|
2013-08-29 07:24:34 +08:00
|
|
|
|
2018-05-02 16:47:02 +08:00
|
|
|
include::fields/ignored-field.asciidoc[]
|
|
|
|
|
2015-07-20 07:24:29 +08:00
|
|
|
include::fields/id-field.asciidoc[]
|
|
|
|
|
2015-08-06 23:24:29 +08:00
|
|
|
include::fields/index-field.asciidoc[]
|
2013-08-29 07:24:34 +08:00
|
|
|
|
2015-08-06 23:24:29 +08:00
|
|
|
include::fields/meta-field.asciidoc[]
|
2014-05-20 23:34:00 +08:00
|
|
|
|
2015-07-20 07:24:29 +08:00
|
|
|
include::fields/routing-field.asciidoc[]
|
2013-08-29 07:24:34 +08:00
|
|
|
|
2015-08-06 23:24:29 +08:00
|
|
|
include::fields/source-field.asciidoc[]
|
2021-04-09 02:41:52 +08:00
|
|
|
|
|
|
|
include::fields/tier-field.asciidoc[]
|