You're viewing version 2.17 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Parent ID query

The parent_id query returns child documents whose parent document has the specified ID. You can establish parent/child relationships between documents in the same index by using a join field type.

Example

Before you can run a parent_id query, your index must contain a join field in order to establish parent/child relationships. The index mapping request uses the following format:

PUT /example_index
{
  "mappings": {
    "properties": {
      "relationship_field": {
        "type": "join",
        "relations": {
          "parent_doc": "child_doc"
        }
      }
    }
  }
}

For this example, first configure an index that contains documents representing products and their brands as described in the has_child query example.

To search for child documents of a specific parent document, use a parent_id query. The following query returns child documents (products) whose parent document has the ID 1:

GET testindex1/_search
{
  "query": {
    "parent_id": {
      "type": "product",
      "id": "1"
    }
  }
}

The response returns the child product:

{
  "took": 57,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 1,
      "relation": "eq"
    },
    "max_score": 0.87546873,
    "hits": [
      {
        "_index": "testindex1",
        "_id": "3",
        "_score": 0.87546873,
        "_routing": "1",
        "_source": {
          "name": "Mechanical watch",
          "sales_count": 150,
          "product_to_brand": {
            "name": "product",
            "parent": "1"
          }
        }
      }
    ]
  }
}

Parameters

The following table lists all top-level parameters supported by parent_id queries.