File tree Expand file tree Collapse file tree 3 files changed +49
-0
lines changed Expand file tree Collapse file tree 3 files changed +49
-0
lines changed Original file line number Diff line number Diff line change @@ -165,6 +165,17 @@ content: |
165
165
- Randomly selects the specified number of documents from its
166
166
input.
167
167
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
+
168
179
* - :pipeline:`$set`
169
180
170
181
- Adds new fields to documents. Similar to
Original file line number Diff line number Diff line change @@ -242,6 +242,17 @@ Alphabetical Listing of Stages
242
242
- Randomly selects the specified number of documents from its input.
243
243
244
244
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
+
245
256
* - :pipeline:`$set`
246
257
247
258
- Adds new fields to documents. Outputs documents that
@@ -320,6 +331,7 @@ Alphabetical Listing of Stages
320
331
/reference/operator/aggregation/replaceRoot
321
332
/reference/operator/aggregation/replaceWith
322
333
/reference/operator/aggregation/sample
334
+ /reference/operator/aggregation/search
323
335
/reference/operator/aggregation/set
324
336
/reference/operator/aggregation/skip
325
337
/reference/operator/aggregation/sort
Original file line number Diff line number Diff line change
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/>`.
You can’t perform that action at this time.
0 commit comments