Skip to content
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

DOCSP-14818 Document new Atlas Search searchMeta stage #5887

Closed
wants to merge 1 commit into from
Closed

DOCSP-14818 Document new Atlas Search searchMeta stage #5887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 18 additions & 1 deletion source/includes/extracts-agg-stages.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,25 @@ content: |
.. note::

``$search`` is only available for MongoDB Atlas clusters,
and is not available for self-managed deployments.
and is not available for self-managed deployments. To
learn more, see :atlas:`Atlas Search Aggregation Pipeline
Stages </reference/atlas-search/query-syntax>`.

* - :pipeline:`$searchMeta`

- Returns different types of metadata result documents for the
:atlas:`Atlas Search </atlas-search>` query against an
:atlas:`Atlas </reference/atlas-search/query-syntax/>`
collection.

.. note::

``$searchMeta`` is only available for MongoDB Atlas
clusters running MongoDB v4.4.9 or higher, and is not
available for self-managed deployments. To learn more, see
Copy link

Choose a reason for hiding this comment

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

Might also be good to mention that the feature flag needs to be turned on right now.

Copy link

Choose a reason for hiding this comment

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

very important.

Copy link

Choose a reason for hiding this comment

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

It isn't critical at this stage though because all the customers are being handheld through the process and the page will be unlisted.

:atlas:`Atlas Search Aggregation Pipeline Stages
</reference/atlas-search/query-syntax>`.

* - :pipeline:`$set`

- Adds new fields to documents. Similar to
Expand Down
20 changes: 20 additions & 0 deletions source/reference/operator/aggregation-pipeline.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,25 @@ Alphabetical Listing of Stages
``$search`` is only available for MongoDB Atlas clusters, and
is not available for self-managed deployments.

To learn more, see :atlas:`Atlas Search Aggregation Pipeline
Stages </reference/atlas-search/query-syntax>`.

* - :pipeline:`$searchMeta </reference/operator/aggregation/searcMeta>`

- Returns different types of :ref:`metadata result
<fts-metadata-results>` documents for the :atlas:`Atlas Search
</atlas-search>` query against an :atlas:`Atlas
</reference/atlas-search/query-syntax/>` collection.

.. note::

``$searchMeta`` is only available for MongoDB Atlas clusters
running MongoDB v4.4.9 or higher, and is not available for
self-managed deployments.

To learn more, see :atlas:`Atlas Search Aggregation Pipeline
Stages </reference/atlas-search/query-syntax>`.


* - :pipeline:`$set`

Expand Down Expand Up @@ -344,6 +363,7 @@ Alphabetical Listing of Stages
/reference/operator/aggregation/replaceWith
/reference/operator/aggregation/sample
/reference/operator/aggregation/search
/reference/operator/aggregation/searchMeta
/reference/operator/aggregation/set
/reference/operator/aggregation/setWindowFields
/reference/operator/aggregation/skip
Expand Down
2 changes: 1 addition & 1 deletion source/reference/operator/aggregation/search.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ by an :atlas:`Atlas Search
- :atlas:`Index Definitions
</reference/atlas-search/index-definitions/>` to learn more about
creating and managing Atlas Search indexes.
- :atlas:`$search Aggregation Pipeline Stage
- :atlas:`Atlas Search Aggregation Pipeline Stages
</reference/atlas-search/query-syntax/>` to learn more about the
``$search`` pipeline stage syntax and usage.
- :atlas:`$search Operators </reference/atlas-search/operators/>` to
Expand Down
25 changes: 25 additions & 0 deletions source/reference/operator/aggregation/searchMeta.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
=========================
$searchMeta (aggregation)
=========================

.. default-domain:: mongodb

``searchMeta`` returns different :ref:`types of metadata result
<fts-metadata-results>` documents for Atlas Search queries on the field
or fields in an Atlas collection. The fields must be covered by an
:atlas:`Atlas Search </reference/atlas-search/index-definitions/>`
index. See:

- :atlas:`Index Definitions
</reference/atlas-search/index-definitions/>` to learn more about
creating and managing Atlas Search indexes.
- :atlas:`Atlas Search Aggregation Pipeline Stages
</reference/atlas-search/query-syntax/>` to learn more about the
``$searchMeta`` pipeline stage syntax, usage, and results.

.. important::

The ``$searchMeta`` aggregation pipeline stage is only available for
collections hosted on :atlas:`MongoDB Atlas </>` cluster tiers
running MongoDB version 4.4.9 or later. To learn more, see
:atlas:`Atlas Search </atlas-search/>`.