mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-09 14:34:43 +00:00
4b1c116461
Adds infrastructure so `gradle :docs:check` will extract tests from snippets in the documentation and execute the tests. This is included in `gradle check` so it should happen on CI and during a normal build. By default each `// AUTOSENSE` snippet creates a unique REST test. These tests are executed in a random order and the cluster is wiped between each one. If multiple snippets chain together into a test you can annotate all snippets after the first with `// TEST[continued]` to have the generated tests for both snippets joined. Snippets marked as `// TESTRESPONSE` are checked against the response of the last action. See docs/README.asciidoc for lots more. Closes #12583. That issue is about catching bugs in the docs during build. This catches *some* bugs in the docs during build which is a good start.
94 lines
2.2 KiB
Plaintext
94 lines
2.2 KiB
Plaintext
[[coerce]]
|
|
=== `coerce`
|
|
|
|
Data is not always clean. Depending on how it is produced a number might be
|
|
rendered in the JSON body as a true JSON number, e.g. `5`, but it might also
|
|
be rendered as a string, e.g. `"5"`. Alternatively, a number that should be
|
|
an integer might instead be rendered as a floating point, e.g. `5.0`, or even
|
|
`"5.0"`.
|
|
|
|
Coercion attempts to clean up dirty values to fit the datatype of a field.
|
|
For instance:
|
|
|
|
* Strings will be coerced to numbers.
|
|
* Floating points will be truncated for integer values.
|
|
|
|
For instance:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT my_index
|
|
{
|
|
"mappings": {
|
|
"my_type": {
|
|
"properties": {
|
|
"number_one": {
|
|
"type": "integer"
|
|
},
|
|
"number_two": {
|
|
"type": "integer",
|
|
"coerce": false
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
PUT my_index/my_type/1
|
|
{
|
|
"number_one": "10" <1>
|
|
}
|
|
|
|
PUT my_index/my_type/2
|
|
{
|
|
"number_two": "10" <2>
|
|
}
|
|
--------------------------------------------------
|
|
// AUTOSENSE
|
|
// TEST[catch:request]
|
|
<1> The `number_one` field will contain the integer `10`.
|
|
<2> This document will be rejected because coercion is disabled.
|
|
|
|
TIP: The `coerce` setting is allowed to have different settings for fields of
|
|
the same name in the same index. Its value can be updated on existing fields
|
|
using the <<indices-put-mapping,PUT mapping API>>.
|
|
|
|
[[coerce-setting]]
|
|
==== Index-level default
|
|
|
|
The `index.mapping.coerce` setting can be set on the index level to disable
|
|
coercion globally across all mapping types:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT my_index
|
|
{
|
|
"settings": {
|
|
"index.mapping.coerce": false
|
|
},
|
|
"mappings": {
|
|
"my_type": {
|
|
"properties": {
|
|
"number_one": {
|
|
"type": "integer",
|
|
"coerce": true
|
|
},
|
|
"number_two": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
PUT my_index/my_type/1
|
|
{ "number_one": "10" } <1>
|
|
|
|
PUT my_index/my_type/2
|
|
{ "number_two": "10" } <2>
|
|
--------------------------------------------------
|
|
// AUTOSENSE
|
|
// TEST[catch:request]
|
|
<1> The `number_one` field overrides the index level setting to enable coercion.
|
|
<2> This document will be rejected because the `number_two` field inherits the index-level coercion setting.
|