honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-08 22:14:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Edit validation section of dynamic templates docs (#57510)

Browse Source
This commit is contained in:
Jess 2020-06-02 22:28:06 +02:00 committed by GitHub
parent 928794cd61
commit dc12a687be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/reference/mapping/dynamic/templates.asciidoc
View File

@ -9,13 +9,13 @@ dynamically added fields based on:
* the full dotted path to the field, with <<path-match-unmatch,`path_match` and `path_unmatch`>>. * the full dotted path to the field, with <<path-match-unmatch,`path_match` and `path_unmatch`>>.
The original field name `{name}` and the detected datatype The original field name `{name}` and the detected datatype
`{dynamic_type`} <<template-variables,template variables>> can be used in `{dynamic_type}` <<template-variables,template variables>> can be used in
the mapping specification as placeholders. the mapping specification as placeholders.
IMPORTANT: Dynamic field mappings are only added when a field contains a IMPORTANT: Dynamic field mappings are only added when a field contains a
concrete value -- not `null` or an empty array. This means that if the concrete value -- not `null` or an empty array. This means that if the
`null_value` option is used in a `dynamic_template`, it will only be applied `null_value` option is used in a `dynamic_template`, it will only be applied
after the first document with a concrete value for the field has been after the first document with a concrete value for the field has been
indexed. indexed.
Dynamic templates are specified as an array of named objects: Dynamic templates are specified as an array of named objects:
@ -37,19 +37,20 @@ Dynamic templates are specified as an array of named objects:
<2> The match conditions can include any of : `match_mapping_type`, `match`, `match_pattern`, `unmatch`, `path_match`, `path_unmatch`. <2> The match conditions can include any of : `match_mapping_type`, `match`, `match_pattern`, `unmatch`, `path_match`, `path_unmatch`.
<3> The mapping that the matched field should use. <3> The mapping that the matched field should use.
If a provided mapping contains an invalid mapping snippet then that results in If a provided mapping contains an invalid mapping snippet, a validation error
a validation error. Validation always occurs when applying the dynamic template is returned. Validation occurs when applying the dynamic template at index time,
at index time or in most cases when updating the dynamic template. and, in most cases, when the dynamic template is updated. Providing an invalid mapping
snippet may cause the update or validation of a dynamic template to fail under certain conditions:
Whether updating the dynamic template fails when supplying an invalid mapping snippet depends on the following: * If no `match_mapping_type` has been specified but the template is valid for at least one predefined mapping type,
* If no `match_mapping_type` has been specified then if the template is valid with one predefined mapping type then the mapping snippet is considered valid. However, a validation error is returned at index time if a field matching
the mapping snippet is considered valid. However if at index time a field that matches with the template is indexed the template is indexed as a different type. For example, configuring a dynamic template with no `match_mapping_type`
as a different type then an validation error will occur at index time instead. For example configuring a dynamic is considered valid as string type, but if a field matching the dynamic template is indexed as a long, a validation
template with no `match_mapping_type` is considered valid as string type, but at index time a field that matches with error is returned at index time.
the dynamic template is indexed as a long, then at index time a validation error may still occur.
* If the `{{name}}` placeholder is used in the mapping snippet then the validation is skipped when updating * If the `{{name}}` placeholder is used in the mapping snippet, validation is skipped when updating the dynamic
the dynamic template. This is because the field name is unknown at that time. The validation will then occur template. This is because the field name is unknown at that time. Instead, validation occurs when the template is applied
when applying the template at index time. at index time.
Templates are processed in order -- the first matching template wins. When Templates are processed in order -- the first matching template wins. When
putting new dynamic templates through the <<indices-put-mapping, put mapping>> API, putting new dynamic templates through the <<indices-put-mapping, put mapping>> API,
@ -59,16 +60,16 @@ reordered or deleted after they were initially added.
[[match-mapping-type]] [[match-mapping-type]]
==== `match_mapping_type` ==== `match_mapping_type`
The `match_mapping_type` is the datatype detected by the json parser. Since The `match_mapping_type` is the datatype detected by the JSON parser. Since
JSON doesn't allow to distinguish a `long` from an `integer` or a `double` from JSON doesn't distinguish a `long` from an `integer` or a `double` from
a `float`, it will always choose the wider datatype, i.e. `long` for integers a `float`, it will always choose the wider datatype, i.e. `long` for integers
and `double` for floating-point numbers. and `double` for floating-point numbers.
The following datatypes may be automatically detected: The following datatypes may be automatically detected:
- `boolean` when `true` or `false` are encountered. - `boolean` when `true` or `false` are encountered.
- `date` when <<date-detection,date detection>> is enabled and a string is - `date` when <<date-detection,date detection>> is enabled and a string matching
found that matches any of the configured date formats. any of the configured date formats is found.
- `double` for numbers with a decimal part. - `double` for numbers with a decimal part.
- `long` for numbers without a decimal part. - `long` for numbers without a decimal part.
- `object` for objects, also called hashes. - `object` for objects, also called hashes.