Unsigned long field type

Unsigned long field type

Unsigned long is a numeric field type that represents an unsigned 64-bit integer with a minimum value of 0 and a maximum value of 264-1 (from 0 to 18446744073709551615 inclusive).

  1. PUT my_index
  2. {
  3.   "mappings": {
  4.     "properties": {
  5.       "my_counter": {
  6.         "type": "unsigned_long"
  7.       }
  8.     }
  9.   }
  10. }

Unsigned long can be indexed in a numeric or string form, representing integer values in the range [0, 18446744073709551615]. They can’t have a decimal part.

  1. POST /my_index/_bulk?refresh
  2. {"index":{"_id":1}}
  3. {"my_counter": 0}
  4. {"index":{"_id":2}}
  5. {"my_counter": 9223372036854775808}
  6. {"index":{"_id":3}}
  7. {"my_counter": 18446744073709551614}
  8. {"index":{"_id":4}}
  9. {"my_counter": 18446744073709551615}

Term queries accept any numbers in a numeric or string form.

  1. GET /my_index/_search
  2. {
  3.     "query": {
  4.         "term" : {
  5.             "my_counter" : 18446744073709551615
  6.         }
  7.     }
  8. }

Range query terms can contain values with decimal parts. In this case Elasticsearch converts them to integer values: gte and gt terms are converted to the nearest integer up inclusive, and lt and lte ranges are converted to the nearest integer down inclusive.

It is recommended to pass ranges as strings to ensure they are parsed without any loss of precision.

  1. GET /my_index/_search
  2. {
  3.     "query": {
  4.         "range" : {
  5.             "my_counter" : {
  6.                 "gte" : "9223372036854775808.5",
  7.                 "lte" : "18446744073709551615"
  8.             }
  9.         }
  10.     }
  11. }

For queries with sort on an unsigned_long field, for a particular document Elasticsearch returns a sort value of the type long if the value of this document is within the range of long values, or of the type BigInteger if the value exceeds this range.

REST clients need to be able to handle big integer values in JSON to support this field type correctly.

  1. GET /my_index/_search
  2. {
  3.     "query": {
  4.         "match_all" : {}
  5.     },
  6.     "sort" : {"my_counter" : "desc"}
  7. }

Unsigned long in scripts

Currently unsigned_long is not supported in scripts.

Stored fields

A stored field of unsigned_long is stored and returned as String.

Aggregations

For terms aggregations, similarly to sort values, Long or BigInteger values are used. For other aggregations, values are converted to the double type.

Queries with mixed numeric types

Searches with mixed numeric types one of which is unsigned_long are supported, except queries with sort. Thus, a sort query across two indexes where the same field name has an unsigned_long type in one index, and long type in another, doesn’t produce correct results and must be avoided. If there is a need for such kind of sorting, script based sorting can be used instead.

Aggregations across several numeric types one of which is unsigned_long are supported. In this case, values are converted to the double type.