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.

Sign up for GitHub

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

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b55ff34
DOCS-14819 Add SEARCH_META variable that populates from mongot
kanchana-mongodb Sep 27, 2021
ededc03
DOCS-15819 updates for tech review feedback
kanchana-mongodb Oct 19, 2021
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
12 changes: 12 additions & 0 deletions source/reference/aggregation-variables.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,18 @@ 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 Search
query. In a :pipeline:`$project` stage, a field set to the
Copy link

@eplotkin-mongodb eplotkin-mongodb Sep 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to my comment on this PR: https://github.com/10gen/cloud-docs/pull/2424#pullrequestreview-764761761

I don't know that we want to tie $$SEARCH_META directly to project. It is similar to $$NOW and can be accessed a number of ways.

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