1
0

fields.asciidoc 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. [[mapping-fields]]
  2. == Metadata fields
  3. Each document has metadata associated with it, such as the `_index`
  4. and `_id` metadata fields. The behavior of some of these metadata
  5. fields can be customized when a mapping is created.
  6. [discrete]
  7. === Identity metadata fields
  8. [horizontal]
  9. <<mapping-index-field,`_index`>>::
  10. The index to which the document belongs.
  11. <<mapping-tier-field,`_tier`>>::
  12. The current data tier preference of the index to which the document belongs.
  13. <<mapping-id-field,`_id`>>::
  14. The document's ID.
  15. [discrete]
  16. === Document source metadata fields
  17. <<mapping-source-field,`_source`>>::
  18. The original JSON representing the body of the document.
  19. {plugins}/mapper-size.html[`_size`]::
  20. The size of the `_source` field in bytes, provided by the
  21. {plugins}/mapper-size.html[`mapper-size` plugin].
  22. [discrete]
  23. === Doc count metadata field
  24. <<mapping-doc-count-field,`_doc_count`>>::
  25. A custom field used for storing doc counts when a document represents pre-aggregated data.
  26. [discrete]
  27. === Indexing metadata fields
  28. <<mapping-field-names-field,`_field_names`>>::
  29. All fields in the document which contain non-null values.
  30. <<mapping-ignored-field,`_ignored`>>::
  31. All fields in the document that have been ignored at index time because of
  32. <<ignore-malformed,`ignore_malformed`>>.
  33. [discrete]
  34. === Routing metadata field
  35. <<mapping-routing-field,`_routing`>>::
  36. A custom routing value which routes a document to a particular shard.
  37. [discrete]
  38. === Other metadata field
  39. <<mapping-meta-field,`_meta`>>::
  40. Application specific metadata.
  41. include::fields/doc-count-field.asciidoc[]
  42. include::fields/field-names-field.asciidoc[]
  43. include::fields/ignored-field.asciidoc[]
  44. include::fields/id-field.asciidoc[]
  45. include::fields/index-field.asciidoc[]
  46. include::fields/tier-field.asciidoc[]
  47. include::fields/meta-field.asciidoc[]
  48. include::fields/routing-field.asciidoc[]
  49. include::fields/source-field.asciidoc[]