fields.asciidoc 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  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-field-names-field,`_field_names`>>::
  27. All fields in the document which contain non-null values.
  28. [float]
  29. === Routing meta-field
  30. <<mapping-routing-field,`_routing`>>::
  31. A custom routing value which routes a document to a particular shard.
  32. [float]
  33. === Other meta-field
  34. <<mapping-meta-field,`_meta`>>::
  35. Application specific metadata.
  36. include::fields/field-names-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[]
  42. include::fields/type-field.asciidoc[]
  43. include::fields/uid-field.asciidoc[]