fields.asciidoc 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  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. The meta-fields are:
  7. [horizontal]
  8. <<mapping-index-field,`_index`>>::
  9. The index to which the document belongs.
  10. <<mapping-uid-field,`_uid`>>::
  11. A composite field consisting of the `_type` and the `_id`.
  12. <<mapping-type-field,`_type`>>::
  13. The document's <<all-mapping-types,mapping type>>.
  14. <<mapping-id-field,`_id`>>::
  15. The document's ID.
  16. <<mapping-source-field,`_source`>>::
  17. The original JSON representing the body of the document.
  18. <<mapping-all-field,`_all`>>::
  19. A _catch-all_ field that indexes the values of all other fields.
  20. <<mapping-field-names-field,`_field_names`>>::
  21. All fields in the document which contain non-null values.
  22. <<mapping-parent-field,`_parent`>>::
  23. Used to create a parent-child relationship between two mapping types.
  24. <<mapping-routing-field,`_routing`>>::
  25. A custom routing value which routes a document to a particular shard.
  26. <<mapping-size-field,`_size`>>::
  27. The size of the `_source` field in bytes.
  28. <<mapping-timestamp-field,`_timestamp`>>::
  29. A timestamp associated with the document, either specified manually or auto-generated.
  30. <<mapping-ttl-field,`_ttl`>>::
  31. How long a document should live before it is automatically deleted.
  32. include::fields/index-field.asciidoc[]
  33. include::fields/uid-field.asciidoc[]
  34. include::fields/type-field.asciidoc[]
  35. include::fields/id-field.asciidoc[]
  36. include::fields/source-field.asciidoc[]
  37. include::fields/all-field.asciidoc[]
  38. include::fields/field-names-field.asciidoc[]
  39. include::fields/parent-field.asciidoc[]
  40. include::fields/routing-field.asciidoc[]
  41. include::fields/size-field.asciidoc[]
  42. include::fields/timestamp-field.asciidoc[]
  43. include::fields/ttl-field.asciidoc[]