Skip to content

Commit 3f0e5c6

Browse files
DOCSP-14818 Document new Atlas Search searchMeta stage (#143)
Co-authored-by: Kanchana Sekhar <[email protected]>
1 parent 572ef94 commit 3f0e5c6

File tree

4 files changed

+64
-2
lines changed

4 files changed

+64
-2
lines changed

source/includes/extracts-agg-stages.yaml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,25 @@ content: |
183183
.. note::
184184
185185
``$search`` is only available for MongoDB Atlas clusters,
186-
and is not available for self-managed deployments.
186+
and is not available for self-managed deployments. To
187+
learn more, see :atlas:`Atlas Search Aggregation Pipeline
188+
Stages </reference/atlas-search/query-syntax>`.
187189
190+
* - :pipeline:`$searchMeta`
191+
192+
- Returns different types of metadata result documents for the
193+
:atlas:`Atlas Search </atlas-search>` query against an
194+
:atlas:`Atlas </reference/atlas-search/query-syntax/>`
195+
collection.
196+
197+
.. note::
198+
199+
``$searchMeta`` is only available for MongoDB Atlas
200+
clusters running MongoDB v4.4.9 or higher, and is not
201+
available for self-managed deployments. To learn more, see
202+
:atlas:`Atlas Search Aggregation Pipeline Stages
203+
</reference/atlas-search/query-syntax>`.
204+
188205
* - :pipeline:`$set`
189206
190207
- Adds new fields to documents. Similar to

source/reference/operator/aggregation-pipeline.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,25 @@ Alphabetical Listing of Stages
259259
``$search`` is only available for MongoDB Atlas clusters, and
260260
is not available for self-managed deployments.
261261

262+
To learn more, see :atlas:`Atlas Search Aggregation Pipeline
263+
Stages </reference/atlas-search/query-syntax>`.
264+
265+
* - :pipeline:`$searchMeta </reference/operator/aggregation/searcMeta>`
266+
267+
- Returns different types of :ref:`metadata result
268+
<fts-metadata-results>` documents for the :atlas:`Atlas Search
269+
</atlas-search>` query against an :atlas:`Atlas
270+
</reference/atlas-search/query-syntax/>` collection.
271+
272+
.. note::
273+
274+
``$searchMeta`` is only available for MongoDB Atlas clusters
275+
running MongoDB v4.4.9 or higher, and is not available for
276+
self-managed deployments.
277+
278+
To learn more, see :atlas:`Atlas Search Aggregation Pipeline
279+
Stages </reference/atlas-search/query-syntax>`.
280+
262281

263282
* - :pipeline:`$set`
264283

@@ -351,6 +370,7 @@ Alphabetical Listing of Stages
351370
/reference/operator/aggregation/replaceWith
352371
/reference/operator/aggregation/sample
353372
/reference/operator/aggregation/search
373+
/reference/operator/aggregation/searchMeta
354374
/reference/operator/aggregation/set
355375
/reference/operator/aggregation/setWindowFields
356376
/reference/operator/aggregation/skip

source/reference/operator/aggregation/search.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ by an :atlas:`Atlas Search
1212
- :atlas:`Index Definitions
1313
</reference/atlas-search/index-definitions/>` to learn more about
1414
creating and managing Atlas Search indexes.
15-
- :atlas:`$search Aggregation Pipeline Stage
15+
- :atlas:`Atlas Search Aggregation Pipeline Stages
1616
</reference/atlas-search/query-syntax/>` to learn more about the
1717
``$search`` pipeline stage syntax and usage.
1818
- :atlas:`$search Operators </reference/atlas-search/operators/>` to
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
=========================
2+
$searchMeta (aggregation)
3+
=========================
4+
5+
.. default-domain:: mongodb
6+
7+
``searchMeta`` returns different :ref:`types of metadata result
8+
<fts-metadata-results>` documents for Atlas Search queries on the field
9+
or fields in an Atlas collection. The fields must be covered by an
10+
:atlas:`Atlas Search </reference/atlas-search/index-definitions/>`
11+
index. See:
12+
13+
- :atlas:`Index Definitions
14+
</reference/atlas-search/index-definitions/>` to learn more about
15+
creating and managing Atlas Search indexes.
16+
- :atlas:`Atlas Search Aggregation Pipeline Stages
17+
</reference/atlas-search/query-syntax/>` to learn more about the
18+
``$searchMeta`` pipeline stage syntax, usage, and results.
19+
20+
.. important::
21+
22+
The ``$searchMeta`` aggregation pipeline stage is only available for
23+
collections hosted on :atlas:`MongoDB Atlas </>` cluster tiers
24+
running MongoDB version 4.4.9 or later. To learn more, see
25+
:atlas:`Atlas Search </atlas-search/>`.

0 commit comments

Comments
 (0)