IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Arrays Boolean field type »
Elastic Docs ›Elasticsearch Guide [8.14] ›Mapping ›Field data types

Binary field type

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

Binary field type

edit

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

response = client.indices.create(
  index: 'my-index-000001',
  body: {
    mappings: {
      properties: {
        name: {
          type: 'text'
        },
        blob: {
          type: 'binary'
        }
      }
    }
  }
)
puts response

response = client.index(
  index: 'my-index-000001',
  id: 1,
  body: {
    name: 'Some binary blob',
    blob: 'U29tZSBiaW5hcnkgYmxvYg=='
  }
)
puts response
PUT my-index-000001
{
  "mappings": {
    "properties": {
      "name": {
        "type": "text"
      },
      "blob": {
        "type": "binary"
      }
    }
  }
}

PUT my-index-000001/_doc/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 or false (default).

store

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

« Arrays Boolean field type »