Você pode usar a opção returnScope para definir o contexto da query e retornar arrays de objetos como documentos individuais.
Requisitos
Para recuperar objetos aninhados como documentos individuais usando returnScope, você deve:
Índice os arrays de objetos como o tipo embeddedDocuments.
Defina storedSource para os campos aninhados que você deseja recuperar. A pesquisa do MongoDB retorna apenas os campos definidos no
storedSource.Defina a opção returnStoredSource como
truena query.
Sintaxe
returnScope tem a seguinte sintaxe em suas 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> } }}Para saber mais sobre sintaxe de query, consulte $search.
Comportamento
A opção returnScope define o contexto de recuperação para a query. Se você especificar returnScope em sua query, o MongoDB Search pontua, classifica e conta cada documento incorporado como se fosse um documento individual.
Considerações
Quando você usa a opção returnScope, o MongoDB pesquisa retorna apenas os campos que você configurou como storedSource dentro do embeddedDocument. Os campos fora do caminho embeddedDocument (como os campos no nível da raiz) e os campos que não estão configurados como storedSource não são retornados.
Na especificação do operador, você deve especificar o caminho completo para o campo que deseja fazer a query. Ao usar a opção returnScope, você deve garantir que todos os caminhos de especificações do operador estejam aninhados em returnScope.path. Para fazer query em um campo fora do returnScope.path, você deve usar o operador hasAncestor ou hasRoot. Para aprender mais, consulte:
Recuperar o ID do documento raiz
Quando você usa returnScope em uma query, o MongoDB Search preenche um campo de metadados searchRootDocumentId. Você pode usar o campo de metadados searchRootDocumentId em clusters que executam o MongoDB 8.3 ou posterior. Este campo contém o identificador do documento raiz que contém cada documento incorporado retornado. Para projetar esse valor, use a expressão $meta com a palavra-chave searchRootDocumentId.
O MongoDB Search preenche searchRootDocumentId somente quando sua query define returnStoredSource: true e returnScope.path. Se você fizer referência a searchRootDocumentId em uma query que não especifica returnScope, a query falhará com o seguinte erro:
query requires $search root document id metadata, but it is notavailableUse searchRootDocumentId se quiser:
Buscar campos do documento pai após filtrar nos documentos filho.
Agrupe documentos filho por seu pai.
Não use searchRootDocumentId se:
Você precisa apenas de campos dos documentos filhos correspondentes.
Você deseja retornar o documento pai para cada documento filho no conjunto de resultados, pois isso pode ser caro.
Exemplos
Os exemplos a seguir demonstram como usar a opção returnScope em consultas. Os exemplos usam o conjunto de dados de amostra sample_training.companies. Se você carregar os dados no seu cluster e criar o índice de amostra nos campos da coleção, poderá tentar as seguintes consultas nos dados de amostra.
Índice de amostra
{ "mappings": { "dynamic": false, "fields": { "funding_rounds": { "type": "embeddedDocuments", "dynamic": true, "fields": { "investments": { "type": "embeddedDocuments", "dynamic": true } }, "storedSource": { "include": [ "round_code", "raised_currency_code", "raised_amount", "investments.person", "investments.financial_org" ] } } } }}A definição de índice anterior configura a pesquisa do MongoDB para:
Indexe os campos
funding_roundsefunding_rounds.investmentscomo o tipoembeddedDocuments.Indexe todos os campos indexáveis dinamicamente aninhados no array de objetos
funding_roundsefunding_rounds.investments.Armazene os seguintes campos em
mongot:funding_rounds.round_codefunding_rounds.raised_currency_codefunding_rounds.raised_amountfunding_rounds.investments.personfunding_rounds.investments.financial_org
Você pode usar o embeddedDocument Operador para realizar queries elemento a elemento em ambos os campos funding_rounds e funding_rounds.investments. As seções a seguir demonstram algumas queries de amostra que usam a opção returnScope para recuperar os campos embeddedDocuments como documentos individuais.
Estrutura de documento de amostra da coleção sample_training.companies
{ ..., "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>" } }, ... ] }, ... ], ...}Exemplos de queries
As seções seguintes demonstram queries de exemplo que usam a opção returnScope para recuperar campos em campos do tipo embeddedDocuments que foram armazenados em mongot.