ignore_malformed

Serverless Stack

Sometimes you don’t have much control over the data that you receive. One user may send a login field that is a date, and another sends a login field that is an email address.

Trying to index the wrong data type into a field throws an exception by default, and rejects the whole document. The ignore_malformed parameter, if set to true, allows the exception to be ignored. The malformed field is not indexed, but other fields in the document are processed normally.

For example:

 PUT my-index-000001 { "mappings": { "properties": { "number_one": { "type": "integer", "ignore_malformed": true }, "number_two": { "type": "integer" } } } } PUT my-index-000001/_doc/1 { "text": "Some text value", "number_one": "foo" } PUT my-index-000001/_doc/2 { "text": "Some text value", "number_two": "foo" } 

1. This document will have the text field indexed, but not the number_one field.
2. This document will be rejected because number_two does not allow malformed values.

The ignore_malformed setting is currently supported by the following mapping types:

Numeric

long, integer, short, byte, double, float, half_float, scaled_float

Boolean

boolean

Date

date

Date nanoseconds

date_nanos

Geopoint

geo_point for lat/lon points, although there is a special case for out-of-range values

Geoshape

geo_shape for complex shapes like polygons

IP

ip for IPv4 and IPv6 addresses

The index.mapping.ignore_malformed setting can be set on the index level to ignore malformed content globally across all allowed mapping types. Mapping types that don’t support the setting will ignore it if set on the index level.

 PUT my-index-000001 { "settings": { "index.mapping.ignore_malformed": true }, "mappings": { "properties": { "number_one": { "type": "byte" }, "number_two": { "type": "integer", "ignore_malformed": false } } } } 

1. The number_one field inherits the index-level setting.
2. The number_two field overrides the index-level setting to turn off ignore_malformed.

Malformed fields are silently ignored at indexing time when ignore_malformed is turned on. Whenever possible it is recommended to keep the number of documents that have a malformed field contained, or queries on this field will become meaningless. Elasticsearch makes it easy to check how many documents have malformed fields by using exists, term or terms queries on the special _ignored field.

With geo_point fields, there is the special case of values that have a syntactically valid format, but the numerical values for latitude and longitude are out of range. If ignore_malformed is false, an exception will be thrown as usual. But if it is true, the document will be indexed correctly, by normalizing the latitude and longitude values into the valid range. The special _ignored field will not be set. The original source document will remain as before, but indexed values, doc-values and stored fields will all be normalized.

You can’t use ignore_malformed with the following data types:

• Nested data type
• Object data type
• Range data types

You also can’t use ignore_malformed to ignore JSON objects submitted to fields of the wrong data type. A JSON object is any data surrounded by curly brackets "{}" and includes data mapped to the nested, object, and range data types.

If you submit a JSON object to an unsupported field, Elasticsearch will return an error and reject the entire document regardless of the ignore_malformed setting.