fields.asciidoc 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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-id-field,`_id`>>::
  12. The document's ID.
  13. [discrete]
  14. === Document source metadata fields
  15. <<mapping-source-field,`_source`>>::
  16. The original JSON representing the body of the document.
  17. {plugins}/mapper-size.html[`_size`]::
  18. The size of the `_source` field in bytes, provided by the
  19. {plugins}/mapper-size.html[`mapper-size` plugin].
  20. [discrete]
  21. === Doc count metadata field
  22. <<mapping-doc-count-field,`_doc_count`>>::
  23. A custom field used for storing doc counts when a document represents pre-aggregated data.
  24. [discrete]
  25. === Indexing metadata fields
  26. <<mapping-field-names-field,`_field_names`>>::
  27. All fields in the document which contain non-null values.
  28. <<mapping-ignored-field,`_ignored`>>::
  29. All fields in the document that have been ignored at index time because of
  30. <<ignore-malformed,`ignore_malformed`>>.
  31. [discrete]
  32. === Routing metadata field
  33. <<mapping-routing-field,`_routing`>>::
  34. A custom routing value which routes a document to a particular shard.
  35. [discrete]
  36. === Other metadata field
  37. <<mapping-meta-field,`_meta`>>::
  38. Application specific metadata.
  39. <<mapping-tier-field,`_tier`>>::
  40. The current data tier preference of the index to which the document belongs.
  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/meta-field.asciidoc[]
  47. include::fields/routing-field.asciidoc[]
  48. include::fields/source-field.asciidoc[]
  49. include::fields/tier-field.asciidoc[]