Skip to content

Commit 395d524

Browse files
kanchana-mongodbjeff-allen-mongo
authored andcommitted
DOCSP-14880 Create shell page for Atlas Search
DOCSP-14880 updates for copy review feedback
1 parent cfc3305 commit 395d524

File tree

4 files changed

+53
-0
lines changed

4 files changed

+53
-0
lines changed

config/redirects

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1651,6 +1651,9 @@ raw: /v2.8/release-notes/2.8-changes -> ${base}/v3.0/release-notes/3.0/
16511651
[v3.0-v4.0]: /${version}/reference/method/ClientEncryption.encrypt -> ${base}/${version}/reference/method/
16521652
[v3.0-v4.0]: /${version}/reference/method/ClientEncryption.decrypt -> ${base}/${version}/reference/method/
16531653

1654+
# Redirects Atlas $search for ticket DOCSP-14880
1655+
[v3.4-v4.0]: /${version}/reference/operator/aggregation/search -> ${base}/${version}/reference/operator/aggregation/
1656+
16541657
[v4.0-*]: /${version}/core/security-built-in-roles -> ${base}/${version}/reference/built-in-roles/
16551658
[v4.0-*]: /${version}/core/security-network -> ${base}/${version}/core/security-hardening/
16561659

@@ -1709,6 +1712,7 @@ raw: /manual/core/wildcard -> ${base}/manual/core/index-wildcard/
17091712
[v3.4-v4.2]: /${version}/reference/operator/aggregation/replaceOne -> ${base}/${version}/reference/operator/aggregation/
17101713
[v3.4-v4.2]: /${version}/reference/operator/aggregation/function -> ${base}/${version}/reference/operator/aggregation/
17111714

1715+
17121716
## Redirects for release notes - trying something more specific
17131717

17141718
[v4.2]: /${version}/release-notes/4.4 -> ${base}/${version}/release-notes/4.2/

source/includes/extracts-agg-stages.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,17 @@ content: |
165165
- Randomly selects the specified number of documents from its
166166
input.
167167
168+
* - :pipeline:`$search`
169+
170+
- Performs a full-text search of the field or fields in an
171+
:atlas:`Atlas </reference/atlas-search/query-syntax/>`
172+
collection.
173+
174+
.. note::
175+
176+
``$search`` is only available for MongoDB Atlas clusters,
177+
and is not available for self-managed deployments.
178+
168179
* - :pipeline:`$set`
169180
170181
- Adds new fields to documents. Similar to

source/reference/operator/aggregation-pipeline.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,17 @@ Alphabetical Listing of Stages
242242
- Randomly selects the specified number of documents from its input.
243243

244244

245+
* - :doc:`$search </reference/operator/aggregation/search>`
246+
247+
- Performs a full-text search of the field or fields in an Atlas
248+
collection.
249+
250+
.. note::
251+
252+
``$search`` is only available for MongoDB Atlas clusters, and
253+
is not available for self-managed deployments.
254+
255+
245256
* - :pipeline:`$set`
246257

247258
- Adds new fields to documents. Outputs documents that
@@ -326,6 +337,7 @@ Alphabetical Listing of Stages
326337
/reference/operator/aggregation/replaceRoot
327338
/reference/operator/aggregation/replaceWith
328339
/reference/operator/aggregation/sample
340+
/reference/operator/aggregation/search
329341
/reference/operator/aggregation/set
330342
/reference/operator/aggregation/skip
331343
/reference/operator/aggregation/sort
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
=====================
2+
$search (aggregation)
3+
=====================
4+
5+
.. default-domain:: mongodb
6+
7+
``$search`` aggregation pipleline stage performs a full-text search of
8+
the field or fields in an Atlas collection. The fields must be covered
9+
by an :atlas:`Atlas Search
10+
</reference/atlas-search/index-definitions/>` index. See:
11+
12+
- :atlas:`Atlas Search Index
13+
</reference/atlas-search/index-definitions/>` to learn more about
14+
creating and managing Atlas Search indexes.
15+
- :atlas:`$search Aggregation Pipeline Stage` to learn more about the
16+
``$search`` pipeline stage syntax and usage.
17+
- :atlas:`$search Operators </reference/atlas-search/operators/>` to
18+
learn more about the ``$search`` aggregation pipeline stage
19+
operators.
20+
21+
.. important::
22+
23+
The ``$search`` aggregation pipeline stage is only available for
24+
collections hosted on :atlas:`MongoDB Atlas </>` cluster tiers
25+
running MongoDB version 4.2 or later. To learn more, see
26+
:atlas:`Atlas Search </atlas-search/>`.

0 commit comments

Comments
 (0)