fields.asciidoc 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  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-uid-field,`_uid`>>::
  12. A composite field consisting of the `_type` and the `_id`.
  13. <<mapping-type-field,`_type`>>::
  14. The document's <<mapping-type,mapping type>>.
  15. <<mapping-id-field,`_id`>>::
  16. The document's ID.
  17. [float]
  18. === Document source meta-fields
  19. <<mapping-source-field,`_source`>>::
  20. The original JSON representing the body of the document.
  21. {plugins}/mapper-size.html[`_size`]::
  22. The size of the `_source` field in bytes, provided by the
  23. {plugins}/mapper-size.html[`mapper-size` plugin].
  24. [float]
  25. === Indexing meta-fields
  26. <<mapping-all-field,`_all`>>::
  27. A _catch-all_ field that indexes the values of all other fields.
  28. <<mapping-field-names-field,`_field_names`>>::
  29. All fields in the document which contain non-null values.
  30. [float]
  31. === Routing meta-fields
  32. <<mapping-parent-field,`_parent`>>::
  33. Used to create a parent-child relationship between two mapping types.
  34. <<mapping-routing-field,`_routing`>>::
  35. A custom routing value which routes a document to a particular shard.
  36. [float]
  37. === Other meta-field
  38. <<mapping-meta-field,`_meta`>>::
  39. Application specific metadata.
  40. include::fields/all-field.asciidoc[]
  41. include::fields/field-names-field.asciidoc[]
  42. include::fields/id-field.asciidoc[]
  43. include::fields/index-field.asciidoc[]
  44. include::fields/meta-field.asciidoc[]
  45. include::fields/parent-field.asciidoc[]
  46. include::fields/routing-field.asciidoc[]
  47. include::fields/source-field.asciidoc[]
  48. include::fields/type-field.asciidoc[]
  49. include::fields/uid-field.asciidoc[]