IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Token count data type

edit

Token count data type

edit

A field of type token_count is really an integer field which accepts string values, analyzes them, then indexes the number of tokens in the string.

For instance:

PUT my-index-000001
{
  "mappings": {
    "properties": {
      "name": { 
        "type": "text",
        "fields": {
          "length": { 
            "type":     "token_count",
            "analyzer": "standard"
          }
        }
      }
    }
  }
}

PUT my-index-000001/_doc/1
{ "name": "John Smith" }

PUT my-index-000001/_doc/2
{ "name": "Rachel Alice Williams" }

GET my-index-000001/_search
{
  "query": {
    "term": {
      "name.length": 3 
    }
  }
}

	The `name` field is a `text` field which uses the default `standard` analyzer.
	The `name.length` field is a `token_count` multi-field which will index the number of tokens in the `name` field.
	This query matches only the document containing `Rachel Alice Williams`, as it contains three tokens.

Parameters for `token_count` fields

edit

The following parameters are accepted by token_count fields:

`analyzer`	The analyzer which should be used to analyze the string value. Required. For best performance, use an analyzer without token filters.
`enable_position_increments`	Indicates if position increments should be counted. Set to `false` if you don’t want to count tokens removed by analyzer filters (like `stop`). Defaults to `true`.
`boost`	Mapping field-level query time boosting. Accepts a floating point number, defaults to `1.0`.
`doc_values`	Should the field be stored on disk in a column-stride fashion, so that it can later be used for sorting, aggregations, or scripting? Accepts `true` (default) or `false`.
`index`	Should the field be searchable? Accepts `true` (default) and `false`.
`null_value`	Accepts a numeric value of the same `type` as the field which is substituted for any explicit `null` values. Defaults to `null`, which means the field is treated as missing.
`store`	Whether the field value should be stored and retrievable separately from the `_source` field. Accepts `true` or `false` (default).

« Text data type Shape data type »

Token count data type

Token count data type

Parameters for token_count fields

Parameters for `token_count` fields