Skip to content

DOCSP-14880 Create shell page for Atlas Search #5077

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

Merged
merged 1 commit into from
Mar 10, 2021
Merged
Show file tree
Hide file tree
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
11 changes: 11 additions & 0 deletions source/includes/extracts-agg-stages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,17 @@ content: |
- Randomly selects the specified number of documents from its
input.

* - :pipeline:`$search`

- Performs a full-text search of the field or fields in an
:atlas:`Atlas </reference/atlas-search/query-syntax/>`
collection.

.. note::

``$search`` is only available for MongoDB Atlas clusters,
and is not available for self-managed deployments.

* - :pipeline:`$set`

- Adds new fields to documents. Similar to
Expand Down
12 changes: 12 additions & 0 deletions source/reference/operator/aggregation-pipeline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,17 @@ Alphabetical Listing of Stages
- Randomly selects the specified number of documents from its input.


* - :doc:`$search </reference/operator/aggregation/search>`

- Performs a full-text search of the field or fields in an Atlas
collection.

.. note::

``$search`` is only available for MongoDB Atlas clusters, and
is not available for self-managed deployments.


* - :pipeline:`$set`

- Adds new fields to documents. Outputs documents that
Expand Down Expand Up @@ -320,6 +331,7 @@ Alphabetical Listing of Stages
/reference/operator/aggregation/replaceRoot
/reference/operator/aggregation/replaceWith
/reference/operator/aggregation/sample
/reference/operator/aggregation/search
/reference/operator/aggregation/set
/reference/operator/aggregation/skip
/reference/operator/aggregation/sort
Expand Down
26 changes: 26 additions & 0 deletions source/reference/operator/aggregation/search.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
=====================
$search (aggregation)
=====================

.. default-domain:: mongodb

``$search`` aggregation pipleline stage performs a full-text search of
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:`Atlas Search Index
</reference/atlas-search/index-definitions/>` to learn more about
creating and managing Atlas Search indexes.
- :atlas:`$search Aggregation Pipeline Stage` to learn more about the
``$search`` pipeline stage syntax and usage.
- :atlas:`$search Operators </reference/atlas-search/operators/>` to
learn more about the ``$search`` aggregation pipeline stage
operators.

.. important::

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