Object field type

Object field type

JSON documents are hierarchical in nature: the document may contain inner objects which, in turn, may contain inner objects themselves:

  1. resp = client.index(
  2.     index="my-index-000001",
  3.     id="1",
  4.     document={
  5.         "region": "US",
  6.         "manager": {
  7.             "age": 30,
  8.             "name": {
  9.                 "first": "John",
  10.                 "last": "Smith"
  11.             }
  12.         }
  13.     },
  14. )
  15. print(resp)
  1. response = client.index(
  2.   index: 'my-index-000001',
  3.   id: 1,
  4.   body: {
  5.     region: 'US',
  6.     manager: {
  7.       age: 30,
  8.       name: {
  9.         first: 'John',
  10.         last: 'Smith'
  11.       }
  12.     }
  13.   }
  14. )
  15. puts response
  1. const response = await client.index({
  2.   index: "my-index-000001",
  3.   id: 1,
  4.   document: {
  5.     region: "US",
  6.     manager: {
  7.       age: 30,
  8.       name: {
  9.         first: "John",
  10.         last: "Smith",
  11.       },
  12.     },
  13.   },
  14. });
  15. console.log(response);
  1. PUT my-index-000001/_doc/1
  2. { 
  3.   "region": "US",
  4.   "manager": { 
  5.     "age":     30,
  6.     "name": { 
  7.       "first": "John",
  8.       "last":  "Smith"
  9.     }
  10.   }
  11. }

The outer document is also a JSON object.

It contains an inner object called manager.

Which in turn contains an inner object called name.

Internally, this document is indexed as a simple, flat list of key-value pairs, something like this:

  1. {
  2.   "region":             "US",
  3.   "manager.age":        30,
  4.   "manager.name.first": "John",
  5.   "manager.name.last":  "Smith"
  6. }

An explicit mapping for the above document could look like this:

  1. resp = client.indices.create(
  2.     index="my-index-000001",
  3.     mappings={
  4.         "properties": {
  5.             "region": {
  6.                 "type": "keyword"
  7.             },
  8.             "manager": {
  9.                 "properties": {
  10.                     "age": {
  11.                         "type": "integer"
  12.                     },
  13.                     "name": {
  14.                         "properties": {
  15.                             "first": {
  16.                                 "type": "text"
  17.                             },
  18.                             "last": {
  19.                                 "type": "text"
  20.                             }
  21.                         }
  22.                     }
  23.                 }
  24.             }
  25.         }
  26.     },
  27. )
  28. print(resp)
  1. response = client.indices.create(
  2.   index: 'my-index-000001',
  3.   body: {
  4.     mappings: {
  5.       properties: {
  6.         region: {
  7.           type: 'keyword'
  8.         },
  9.         manager: {
  10.           properties: {
  11.             age: {
  12.               type: 'integer'
  13.             },
  14.             name: {
  15.               properties: {
  16.                 first: {
  17.                   type: 'text'
  18.                 },
  19.                 last: {
  20.                   type: 'text'
  21.                 }
  22.               }
  23.             }
  24.           }
  25.         }
  26.       }
  27.     }
  28.   }
  29. )
  30. puts response
  1. const response = await client.indices.create({
  2.   index: "my-index-000001",
  3.   mappings: {
  4.     properties: {
  5.       region: {
  6.         type: "keyword",
  7.       },
  8.       manager: {
  9.         properties: {
  10.           age: {
  11.             type: "integer",
  12.           },
  13.           name: {
  14.             properties: {
  15.               first: {
  16.                 type: "text",
  17.               },
  18.               last: {
  19.                 type: "text",
  20.               },
  21.             },
  22.           },
  23.         },
  24.       },
  25.     },
  26.   },
  27. });
  28. console.log(response);
  1. PUT my-index-000001
  2. {
  3.   "mappings": {
  4.     "properties": { 
  5.       "region": {
  6.         "type": "keyword"
  7.       },
  8.       "manager": { 
  9.         "properties": {
  10.           "age":  { "type": "integer" },
  11.           "name": { 
  12.             "properties": {
  13.               "first": { "type": "text" },
  14.               "last":  { "type": "text" }
  15.             }
  16.           }
  17.         }
  18.       }
  19.     }
  20.   }
  21. }

Properties in the top-level mappings definition.

The manager field is an inner object field.

The manager.name field is an inner object field within the manager field.

You are not required to set the field type to object explicitly, as this is the default value.

Parameters for object fields

The following parameters are accepted by object fields:

dynamic

Whether or not new properties should be added dynamically to an existing object. Accepts true (default), runtime, false and strict.

enabled

Whether the JSON value given for the object field should be parsed and indexed (true, default) or completely ignored (false).

subobjects

Whether the object can hold subobjects (true, default) or not (false). If not, sub-fields with dots in their names will be treated as leaves instead, otherwise their field names would be expanded to their corresponding object structure.

properties

The fields within the object, which can be of any data type, including object. New properties may be added to an existing object.

If you need to index arrays of objects instead of single objects, read Nested first.