WARNING: Version 2.3 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.

« Array datatype Boolean datatype »
Elastic Docs ›Elasticsearch Guide [2.3] ›Mapping ›Field datatypes

Binary datatype

edit

Binary datatype

edit

The binary type accepts a binary value as a Base64 encoded string. The field is not stored by default and is not searchable:

PUT my_index
{
  "mappings": {
    "my_type": {
      "properties": {
        "name": {
          "type": "string"
        },
        "blob": {
          "type": "binary"
        }
      }
    }
  }
}

PUT my_index/my_type/1
{
  "name": "Some binary blob",
  "blob": "U29tZSBiaW5hcnkgYmxvYg==" 
}

The Base64 encoded binary value must not have embedded newlines \n.

Parameters for binary fields

edit

The following parameters are accepted by binary fields:

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.

store

Whether the field value should be stored and retrievable separately from the _source field. Accepts true or false (default).

« Array datatype Boolean datatype »