/ /

/ /

Query, Filter, and Retrieve Arrays of Objects

You can use the returnScope option to set the context of the query and return arrays of objects as individual documents.

Requirements

To retrieve nested objects as individual documents using returnScope, you must:

Index the arrays of objects as the embeddedDocuments type.
Define storedSource for the nested fields that you want to retrieve. MongoDB Search only returns fields defined in the storedSource.
Set the returnStoredSource option to true in the query.

Syntax

returnScope has the following syntax in your queries:

{
  $search: {
   "<operator>": {
      <operator-specification>,
   },
   "returnScope": {
      "path": "<embedded-documents-field-to-retrieve>"
   },
   "returnStoredSource": true
  }
}

{
  $searchMeta: {
   "returnScope": {
      "path": "<embedded-documents-field-to-retrieve>"
   },
   "returnStoredSource": true
  },
  "facet": {
    "<operator>": {
      <operator-specification>,
   },
    "facets": {
      <facet-definition>
    }
  }
}

To learn more about query syntax, see $search.

Behavior

The returnScope option sets the retrieval context for the query. If you specify returnScope in your query, MongoDB Search scores, sorts, and counts each embedded document as if it were an individual document.

Considerations

In your operator specification, you must specify the full path to the field that you want to query.

When you use the returnScope option, MongoDB Search only returns the fields that you configured as storedSource within the embeddedDocument. Fields outside of the embeddedDocument path (such as fields at the root level) and fields that are not configured as storedSource are not returned.

Examples

The following examples demonstrate how to use the returnScope option in queries. The examples use the sample_training.companies sample dataset. If you load the data on your cluster and create the sample index on the fields in the collection, you can try the following queries against the sample data.

Sample Index

1 {
2   "mappings": { 
3     "dynamic": false,
4     "fields": { 
5       "funding_rounds": { 
6         "type": "embeddedDocuments",
7         "dynamic": true,
8         "fields": {
9           "investments": {
10             "type": "embeddedDocuments",
11             "dynamic": true
12           }
13         },
14         "storedSource": {
15           "include": [
16             "round_code", 
17             "raised_currency_code",
18             "raised_amount",
19             "investments.person",
20             "investments.financial_org"
21           ] 
22         },
23       } 
24     }
25   }
26 }

The preceding index definition configures MongoDB Search to:

Index the funding_rounds and funding_rounds.investments fields as the embeddedDocuments type.
Index all the dynamically indexable fields nested in the funding_rounds and funding_rounds.investments array of objects.
Store the following fields on mongot:
- funding_rounds.round_code
- funding_rounds.raised_currency_code
- funding_rounds.raised_amount
- funding_rounds.investments.person
- funding_rounds.investments.financial_org

You can use the embeddedDocument Operator to perform element-wise querying on both the funding_rounds and funding_rounds.investments fields. The following sections demonstrate some sample queries that use the returnScope option to retrieve the embeddedDocuments fields as individual documents.

Sample Document Structure from sample_training.companies Collection

{
  ...,
  "funding_rounds": [
    {
      "id": <integer>,
      "round_code": "<string>",
      "source_url": "<string>",
      "source_description": "<string>",
      "raised_amount": <integer>,
      "raised_currency_code": "<string>",
      "funded_year": <integer>,
      "funded_month": "<string>",
      "funded_day": "<string>",
      "investments": [
         {
           "company": "<string>",
           "financial_org": {
             "name": "<string>",
             "permalink": "<string>"
           },
           "person": {
             "first_name": "<string>",
             "last_name": "<string>",
             "permalink": "<string>"
           }
         },
         ...
      ]
    },
    ...
  ],
  ...
}

Sample Queries

The following sections demonstrate sample queries that use the returnScope option to retrieve fields in embeddedDocuments type fields that were stored on mongot.

Simple Query

Query and retrieve embedded document fields.

The following query uses the range (MongoDB Search Operator) to query the funding_rounds.raised_amount field for amount greater than and equal to 5000000 and less than and equal to 10000000. It sets the query scope as funding_rounds field using the returnScope option. It returns all the stored fields inside the funding_rounds array of objects, including fields in the funding_rounds.investments array of objects that were stored using the returnStoredSource option. It limits the number of results to only 5 funding_rounds documents.

1 db.companies.aggregate(
2   {
3     "$search": {
4       "range": {
5         "path": "funding_rounds.raised_amount",
6         "gte": 5000000,
7         "lte": 10000000
8       },
9       "returnStoredSource": true,
10       "returnScope": {
11         "path": "funding_rounds"
12       }
13     }
14   },
15   {
16     "$limit": 5
17   }
18 )

[
  {
    round_code: 'a',
    raised_amount: 5250000,
    raised_currency_code: 'USD',
    investments: [
      {
        financial_org: {
          name: 'Frazier Technology Ventures',
          permalink: 'frazier-technology-ventures'
        },
        person: null
      },
      {
        financial_org: { name: 'Trinity Ventures', permalink: 'trinity-ventures' },
        person: null
      }
    ]
  },
  {
    round_code: 'b',
    raised_amount: 9500000,
    raised_currency_code: 'USD',
    investments: [
      {
        financial_org: { name: 'Accel Partners', permalink: 'accel-partners' },
        person: null
      },
      {
        financial_org: {
          name: 'Frazier Technology Ventures',
          permalink: 'frazier-technology-ventures'
        },
        person: null
      },
      {
        financial_org: { name: 'Trinity Ventures', permalink: 'trinity-ventures' },
        person: null
      }
    ]
  },
  {
    round_code: 'a',
    raised_amount: 5000000,
    raised_currency_code: 'USD',
    investments: [
      {
        financial_org: {
          name: 'Charles River Ventures',
          permalink: 'charles-river-ventures'
        },
        person: null
      },
      {
        financial_org: {
          name: 'Union Square Ventures',
          permalink: 'union-square-ventures'
        },
        person: null
      },
      {
        financial_org: null,
        person: {
          first_name: 'Marc',
          last_name: 'Andreessen',
          permalink: 'marc-andreessen'
        }
      },
      {
        financial_org: null,
        person: {
          first_name: 'Dick',
          last_name: 'Costolo',
          permalink: 'dick-costolo'
        }
      },
      {
        financial_org: null,
        person: {
          first_name: 'Naval',
          last_name: 'Ravikant',
          permalink: 'naval-ravikant'
        }
      },
      {
        financial_org: null,
        person: {
          first_name: 'Ron',
          last_name: 'Conway',
          permalink: 'ron-conway'
        }
      },
      {
        financial_org: null,
        person: {
          first_name: 'Chris',
          last_name: 'Sacca',
          permalink: 'chris-sacca'
        }
      },
      {
        financial_org: null,
        person: {
          first_name: 'Greg',
          last_name: 'Yaitanes',
          permalink: 'greg-yaitanes'
        }
      },
      {
        financial_org: null,
        person: {
          first_name: 'Brian',
          last_name: 'Pokorny',
          permalink: 'brian-pokorny'
        }
      },
      {
        financial_org: { name: 'SV Angel', permalink: 'sv-angel' },
        person: null
      }
    ]
  },
  {
    round_code: 'e',
    raised_amount: 5166511,
    raised_currency_code: 'USD',
    investments: []
  },
  {
    round_code: 'b',
    raised_amount: 9000000,
    raised_currency_code: 'USD',
    investments: [
      {
        financial_org: {
          name: 'Charles River Ventures',
          permalink: 'charles-river-ventures'
        },
        person: null
      },
      {
        financial_org: { name: 'Redpoint Ventures', permalink: 'redpoint-ventures' },
        person: null
      },
      {
        financial_org: {
          name: 'The Kinsey Hills Group',
          permalink: 'kinsey-hills-group'
        },
        person: null
      }
    ]
  }
]

Compound Query

Query and retrieve multiple embedded document fields.

The following query uses the compound Operator to search multiple levels of nested embeddedDocuments fields in the same query:

Must match``funding_rounds.raised_currency_code`` with USD
Should match funding_rounds.investments.financial_org.name with Trinity Ventures

It returns all the stored fields inside the funding_rounds array of objects, including fields in the funding_rounds.investments. It limits the number of results to only 5 funding_rounds documents.

1 db.companies.aggregate(
2   {
3     "$search": {
4       "compound": {
5         "must": [{
6           "text": {
7             "path": "funding_rounds.raised_currency_code",
8             "query": "usd"
9           }
10         }],
11         "should": [{
12           "phrase": {
13             "path": "funding_rounds.investments.financial_org",
14             "query": "Trinity Ventures",
15           }
16         }]
17       },
18       "returnStoredSource": true,
19       "returnScope": {
20         "path": "funding_rounds"
21       }
22     }
23   },
24   {
25     "$limit": 5
26   }
27 )

[
  {
    round_code: 'a',
    raised_amount: 5250000,
    raised_currency_code: 'USD',
    investments: [
      {
        financial_org: {
          name: 'Frazier Technology Ventures',
          permalink: 'frazier-technology-ventures'
        },
        person: null
      },
      {
        financial_org: { name: 'Trinity Ventures', permalink: 'trinity-ventures' },
        person: null
      }
    ]
  },
  {
    round_code: 'b',
    raised_amount: 9500000,
    raised_currency_code: 'USD',
    investments: [
      {
        financial_org: { name: 'Accel Partners', permalink: 'accel-partners' },
        person: null
      },
      {
        financial_org: {
          name: 'Frazier Technology Ventures',
          permalink: 'frazier-technology-ventures'
        },
        person: null
      },
      {
        financial_org: { name: 'Trinity Ventures', permalink: 'trinity-ventures' },
        person: null
      }
    ]
  },
  {
    round_code: 'c',
    raised_amount: 25000000,
    raised_currency_code: 'USD',
    investments: [
      {
        financial_org: { name: 'DAG Ventures', permalink: 'dag-ventures' },
        person: null
      },
      {
        financial_org: { name: 'Accel Partners', permalink: 'accel-partners' },
        person: null
      },
      {
        financial_org: { name: 'Trinity Ventures', permalink: 'trinity-ventures' },
        person: null
      },
      {
        financial_org: {
          name: 'Frazier Technology Ventures',
          permalink: 'frazier-technology-ventures'
        },
        person: null
      }
    ]
  },
  {
    round_code: 'angel',
    raised_amount: 500000,
    raised_currency_code: 'USD',
    investments: [
      {
        financial_org: null,
        person: {
          first_name: 'Peter',
          last_name: 'Thiel',
          permalink: 'peter-thiel'
        }
      },
      {
        financial_org: null,
        person: {
          first_name: 'Reid',
          last_name: 'Hoffman',
          permalink: 'reid-hoffman'
        }
      }
    ]
  },
  {
    round_code: 'a',
    raised_amount: 12700000,
    raised_currency_code: 'USD',
    investments: [
      {
        financial_org: { name: 'Accel Partners', permalink: 'accel-partners' },
        person: null
      },
      {
        financial_org: null,
        person: {
          first_name: 'Mark',
          last_name: 'Pincus',
          permalink: 'mark-pincus'
        }
      },
      {
        financial_org: null,
        person: {
          first_name: 'Reid',
          last_name: 'Hoffman',
          permalink: 'reid-hoffman'
        }
      }
    ]
  }
]

Back

searchSequenceToken

tracking

1	{
2	"mappings": {
3	"dynamic": false,
4	"fields": {
5	"funding_rounds": {
6	"type": "embeddedDocuments",
7	"dynamic": true,
8	"fields": {
9	"investments": {
10	"type": "embeddedDocuments",
11	"dynamic": true
12	}
13	},
14	"storedSource": {
15	"include": [
16	"round_code",
17	"raised_currency_code",
18	"raised_amount",
19	"investments.person",
20	"investments.financial_org"
21	]
22	},
23	}
24	}
25	}
26	}

1	db.companies.aggregate(
2	{
3	"$search": {
4	"range": {
5	"path": "funding_rounds.raised_amount",
6	"gte": 5000000,
7	"lte": 10000000
8	},
9	"returnStoredSource": true,
10	"returnScope": {
11	"path": "funding_rounds"
12	}
13	}
14	},
15	{
16	"$limit": 5
17	}
18	)

1	db.companies.aggregate(
2	{
3	"$search": {
4	"compound": {
5	"must": [{
6	"text": {
7	"path": "funding_rounds.raised_currency_code",
8	"query": "usd"
9	}
10	}],
11	"should": [{
12	"phrase": {
13	"path": "funding_rounds.investments.financial_org",
14	"query": "Trinity Ventures",
15	}
16	}]
17	},
18	"returnStoredSource": true,
19	"returnScope": {
20	"path": "funding_rounds"
21	}
22	}
23	},
24	{
25	"$limit": 5
26	}
27	)