ignore-malformed.asciidoc 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. [[ignore-malformed]]
  2. === `ignore_malformed`
  3. Sometimes you don't have much control over the data that you receive. One
  4. user may send a `login` field that is a <<date,`date`>>, and another sends a
  5. `login` field that is an email address.
  6. Trying to index the wrong datatype into a field throws an exception by
  7. default, and rejects the whole document. The `ignore_malformed` parameter, if
  8. set to `true`, allows the exception to be ignored. The malformed field is not
  9. indexed, but other fields in the document are processed normally.
  10. For example:
  11. [source,js]
  12. --------------------------------------------------
  13. PUT my_index
  14. {
  15. "mappings": {
  16. "my_type": {
  17. "properties": {
  18. "number_one": {
  19. "type": "integer"
  20. },
  21. "number_two": {
  22. "type": "integer",
  23. "ignore_malformed": true
  24. }
  25. }
  26. }
  27. }
  28. }
  29. PUT my_index/my_type/1
  30. {
  31. "text": "Some text value",
  32. "number_one": "foo" <1>
  33. }
  34. PUT my_index/my_type/2
  35. {
  36. "text": "Some text value",
  37. "number_two": "foo" <2>
  38. }
  39. --------------------------------------------------
  40. // AUTOSENSE
  41. <1> This document will be rejected because `number_one` does not allow malformed values.
  42. <2> This document will have the `text` field indexed, but not the `number_two` field.
  43. TIP: The `ignore_malformed` setting is allowed to have different settings for
  44. fields of the same name in the same index. Its value can be updated on
  45. existing fields using the <<indices-put-mapping,PUT mapping API>>.
  46. [[ignore-malformed-setting]]
  47. ==== Index-level default
  48. The `index.mapping.ignore_malformed` setting can be set on the index level to
  49. allow to ignore malformed content globally across all mapping types.
  50. [source,js]
  51. --------------------------------------------------
  52. PUT my_index
  53. {
  54. "settings": {
  55. "index.mapping.ignore_malformed": true <1>
  56. },
  57. "mappings": {
  58. "my_type": {
  59. "properties": {
  60. "number_one": { <1>
  61. "type": "byte"
  62. },
  63. "number_two": {
  64. "type": "integer",
  65. "ignore_malformed": false <2>
  66. }
  67. }
  68. }
  69. }
  70. }
  71. --------------------------------------------------
  72. // AUTOSENSE
  73. <1> The `number_one` field inherits the index-level setting.
  74. <2> The `number_two` field overrides the index-level setting to turn off `ignore_malformed`.