Skip to content

Commit 5ba307d

Browse files
DOCSP-14818 Document new Atlas Search searchMeta stage
1 parent b5dcaa5 commit 5ba307d

File tree

4 files changed

+64
-2
lines changed

4 files changed

+64
-2
lines changed

source/includes/extracts-agg-stages.yaml

+18-1
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,25 @@ content: |
176176
.. note::
177177
178178
``$search`` is only available for MongoDB Atlas clusters,
179-
and is not available for self-managed deployments.
179+
and is not available for self-managed deployments. To
180+
learn more, see :atlas:`Atlas Search Aggregation Pipeline
181+
Stages </reference/atlas-search/query-syntax>`.
180182
183+
* - :pipeline:`$searchMeta`
184+
185+
- Returns different types of metadata result documents for the
186+
:atlas:`Atlas Search </atlas-search>` query against an
187+
:atlas:`Atlas </reference/atlas-search/query-syntax/>`
188+
collection.
189+
190+
.. note::
191+
192+
``$searchMeta`` is only available for MongoDB Atlas
193+
clusters running MongoDB v4.4.9 or higher, and is not
194+
available for self-managed deployments. To learn more, see
195+
:atlas:`Atlas Search Aggregation Pipeline Stages
196+
</reference/atlas-search/query-syntax>`.
197+
181198
* - :pipeline:`$set`
182199
183200
- Adds new fields to documents. Similar to

source/reference/operator/aggregation-pipeline.txt

+20
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,25 @@ Alphabetical Listing of Stages
254254
``$search`` is only available for MongoDB Atlas clusters, and
255255
is not available for self-managed deployments.
256256

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

258277
* - :pipeline:`$set`
259278

@@ -344,6 +363,7 @@ Alphabetical Listing of Stages
344363
/reference/operator/aggregation/replaceWith
345364
/reference/operator/aggregation/sample
346365
/reference/operator/aggregation/search
366+
/reference/operator/aggregation/searchMeta
347367
/reference/operator/aggregation/set
348368
/reference/operator/aggregation/setWindowFields
349369
/reference/operator/aggregation/skip

source/reference/operator/aggregation/search.txt

+1-1
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
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)