New

The executive guide to generative AI

Read more
About usPartnersSupport|Login

WARNING: Version 5.1 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« ignore_malformed index »
Elastic Docs ›Elasticsearch Guide [5.1] ›Mapping ›Mapping parameters

include_in_all

edit

include_in_all

edit

The include_in_all parameter provides per-field control over which fields are included in the _all field. It defaults to true, unless index is set to no.

This example demonstrates how to exclude the date field from the _all field:

PUT my_index
{
  "mappings": {
    "my_type": {
      "properties": {
        "title": { 
          "type": "text"
        },
        "content": { 
          "type": "text"
        },
        "date": { 
          "type": "date",
          "include_in_all": false
        }
      }
    }
  }
}
Copy as curlTry in Elastic 

The title and content fields will be included in the _all field.

The date field will not be included in the _all field.

The include_in_all 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 PUT mapping API.

The include_in_all parameter can also be set at the type level and on object or nested fields, in which case all sub- fields inherit that setting. For instance:

PUT my_index
{
  "mappings": {
    "my_type": {
      "include_in_all": false, 
      "properties": {
        "title":          { "type": "text" },
        "author": {
          "include_in_all": true, 
          "properties": {
            "first_name": { "type": "text" },
            "last_name":  { "type": "text" }
          }
        },
        "editor": {
          "properties": {
            "first_name": { "type": "text" }, 
            "last_name":  { "type": "text", "include_in_all": true } 
          }
        }
      }
    }
  }
}
Copy as curlTry in Elastic 

All fields in my_type are excluded from _all.

The author.first_name and author.last_name fields are included in _all.

Only the editor.last_name field is included in _all. The editor.first_name inherits the type-level setting and is excluded.

Multi-fields and include_in_all

The original field value is added to the _all field, not the terms produced by a field’s analyzer. For this reason, it makes no sense to set include_in_all to true on multi-fields, as each multi-field has exactly the same value as its parent.

« ignore_malformed index »
Was this helpful?
Feedback