IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Mapper Size Plugin Mapper Murmur3 Plugin »
Elastic Docs ›Elasticsearch Plugins and Integrations [7.7] ›Mapper Plugins ›Mapper Size Plugin

Using the _size field

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Using the _size field

edit

In order to enable the _size field, set the mapping as follows:

PUT my_index
{
  "mappings": {
    "_size": {
      "enabled": true
    }
  }
}

The value of the _size field is accessible in queries, aggregations, scripts, and when sorting:

# Example documents
PUT my_index/_doc/1
{
  "text": "This is a document"
}

PUT my_index/_doc/2
{
  "text": "This is another document"
}

GET my_index/_search
{
  "query": {
    "range": {
      "_size": {                      
        "gt": 10
      }
    }
  },
  "aggs": {
    "sizes": {
      "terms": {
        "field": "_size",             
        "size": 10
      }
    }
  },
  "sort": [
    {
      "_size": {                      
        "order": "desc"
      }
    }
  ],
  "script_fields": {
    "size": {
      "script": "doc['_size']"        
    }
  },
  "docvalue_fields": [
    {
      "field": "_size"                
    }
  ]
}

Querying on the _size field

Aggregating on the _size field

Sorting on the _size field

Uses a script field to return the _size field in the search response.

Uses a doc value field to return the _size field in the search response. Doc value fields are useful if inline scripts are disabled.
« Mapper Size Plugin Mapper Murmur3 Plugin »