Skip to content

DOCS-14819 Add SEARCH_META variable that populates from mongot #5888

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions source/reference/aggregation-variables.txt
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,19 @@ MongoDB offers the following system variables:

- One of the allowed results of a :pipeline:`$redact` expression.

* - .. variable:: SEARCH_META

- A variable that stores the metadata results of an :atlas:`Atlas
Search </atlas-search/>` query. In all supported aggregation
pipeline stages, a field set to the variable
:variable:`$$SEARCH_META` returns the :atlas:`metadata results
</reference/atlas-search/query-syntax/#metadata-result-types>`
for the query.

For an example of its usage, see Atlas Search :atlas:`facet
</reference/atlas-search/facet/#search_meta-aggregation-variable>`
and :atlas:`count </reference/atlas-search/counting/#search_meta-aggregation-variable>`.

.. seealso::

- :expression:`$let`
Expand Down