Getting ready

You need a working ElasticSearch cluster.

How to do it...

A nested object is defined as the standard object with the nested type.

From the example of the Mapping an object recipe, we can change the type from object to nested as shown in the following code:

{
  "order" : {
    "properties" : {
      "id" : {"type" : "string", 
      "store" : "yes", "index":"not_analyzed"},
      "date" : {"type" : "date", "store" : "no", 
      "index":"not_analyzed"},
      "customer_id" : {"type" : "string", "store" : "yes",
      "index":"not_analyzed"},
      "sent" : {"type" : "boolean", "store" : "no", 
      "index":"not_analyzed"},
      "item" : {
        "type" : "nested",
        "properties" : {
          "name" : {"type" : "string", "store" : "no",
          "index":"analyzed"},
          "quantity" : {"type" : "integer", 
            "store" : "no",
            "index":"not_analyzed"},
          "vat" : {"type" : "double", "store" : "no",
            "index":"not_analyzed"}
        }
      }
    }
  }
}

How it works...

When a document is indexed and if an embedded object is marked as nested, it's extracted by the original document and indexed in a new external document.

In the above example, we have reused the mapping of the Mapping an object recipe, but we have changed the type of the item from object to nested. No other required action must be taken to convert an embedded object to a nested object.

The nested objects are special Lucene documents that are saved in the same block of data of its parent. This approach allows fast joining with the parent document.

Nested objects are not searchable with standard queries, but only with the nested one. They are not shown in standard query results.

The lives of nested objects are related to their parents: deleting/updating a parent, automatically deletes/updates all nested children. Changing the parent means ElasticSearch will do the following:

There's more...

Sometimes it is required to propagate information of the nested objects to their parent or root objects, mainly to build simpler queries about their parents. To achieve this goal, there are two special properties of the nested objects, as follows:

These settings add data replication, but they reduce the complexity of some queries, thus improving performance.

See also