fields.asciidoc 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  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. === Indexing metadata fields
  22. <<mapping-field-names-field,`_field_names`>>::
  23. All fields in the document which contain non-null values.
  24. <<mapping-ignored-field,`_ignored`>>::
  25. All fields in the document that have been ignored at index time because of
  26. <<ignore-malformed,`ignore_malformed`>>.
  27. [discrete]
  28. === Routing metadata field
  29. <<mapping-routing-field,`_routing`>>::
  30. A custom routing value which routes a document to a particular shard.
  31. [discrete]
  32. === Other metadata field
  33. <<mapping-meta-field,`_meta`>>::
  34. Application specific metadata.
  35. include::fields/field-names-field.asciidoc[]
  36. include::fields/ignored-field.asciidoc[]
  37. include::fields/id-field.asciidoc[]
  38. include::fields/index-field.asciidoc[]
  39. include::fields/meta-field.asciidoc[]
  40. include::fields/routing-field.asciidoc[]
  41. include::fields/source-field.asciidoc[]