fields.asciidoc 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. [[mapping-fields]]
  2. == Meta-Fields
  3. Each document has metadata associated with it, such as the `_index`, mapping
  4. <<mapping-type-field,`_type`>>, and `_id` meta-fields. The behaviour of some of these meta-fields
  5. can be customised when a mapping type is created.
  6. [float]
  7. === Identity meta-fields
  8. [horizontal]
  9. <<mapping-index-field,`_index`>>::
  10. The index to which the document belongs.
  11. <<mapping-type-field,`_type`>>::
  12. The document's <<mapping-type,mapping type>>.
  13. <<mapping-id-field,`_id`>>::
  14. The document's ID.
  15. [float]
  16. === Document source meta-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. [float]
  23. === Indexing meta-fields
  24. <<mapping-field-names-field,`_field_names`>>::
  25. All fields in the document which contain non-null values.
  26. <<mapping-ignored-field,`_ignored`>>::
  27. All fields in the document that have been ignored at index time because of
  28. <<ignore-malformed,`ignore_malformed`>>.
  29. [float]
  30. === Routing meta-field
  31. <<mapping-routing-field,`_routing`>>::
  32. A custom routing value which routes a document to a particular shard.
  33. [float]
  34. === Other meta-field
  35. <<mapping-meta-field,`_meta`>>::
  36. Application specific metadata.
  37. include::fields/field-names-field.asciidoc[]
  38. include::fields/ignored-field.asciidoc[]
  39. include::fields/id-field.asciidoc[]
  40. include::fields/index-field.asciidoc[]
  41. include::fields/meta-field.asciidoc[]
  42. include::fields/routing-field.asciidoc[]
  43. include::fields/source-field.asciidoc[]
  44. include::fields/type-field.asciidoc[]