Browse Source

Docs: Add note about missing mapping for doc values field (#29036)

This commit adds a documentation note about the behavior when trying to
access docvalues for a field which does not exist in mappings.

closes #22056
Ryan Ernst 7 years ago
parent
commit
744777a6a0
1 changed files with 11 additions and 0 deletions
  1. 11 0
      docs/reference/modules/scripting/fields.asciidoc

+ 11 - 0
docs/reference/modules/scripting/fields.asciidoc

@@ -115,6 +115,17 @@ Doc-values can only return "simple" field values like numbers, dates, geo-
 points, terms, etc, or arrays of these values if the field is multi-valued.
 It cannot return JSON objects.
 
+[NOTE]
+.Missing fields
+===================================================
+
+The `doc['field']` will throw an error if `field` is missing from the mappings.
+In `painless`, a check can first be done with `doc.containsKey('field')` to guard
+accessing the `doc` map.  Unfortunately, there is no way to check for the
+existence of the field in mappings in an `expression` script.
+
+===================================================
+
 [NOTE]
 .Doc values and `text` fields
 ===================================================