DOCSP-14818 Document new Atlas Search searchMeta stage

mongodb · Sep 27, 2021 · 5ba307d · 5ba307d
1 parent b5dcaa5
commit 5ba307d
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 2 deletions.
diff --git a/source/includes/extracts-agg-stages.yaml b/source/includes/extracts-agg-stages.yaml
@@ -176,8 +176,25 @@ content: |
           .. note:: 
 
              ``$search`` is only available for MongoDB Atlas clusters, 
-             and is not available for self-managed deployments.
+             and is not available for self-managed deployments. To 
+             learn more, see :atlas:`Atlas Search Aggregation Pipeline 
+             Stages </reference/atlas-search/query-syntax>`.
 
+      * - :pipeline:`$searchMeta`
+
+        - Returns different types of metadata result documents for the 
+          :atlas:`Atlas Search </atlas-search>` query against an 
+          :atlas:`Atlas </reference/atlas-search/query-syntax/>` 
+          collection. 
+
+          .. note:: 
+
+             ``$searchMeta`` is only available for MongoDB Atlas 
+             clusters running MongoDB v4.4.9 or higher, and is not 
+             available for self-managed deployments. To learn more, see 
+             :atlas:`Atlas Search Aggregation Pipeline Stages 
+             </reference/atlas-search/query-syntax>`.
+      
       * - :pipeline:`$set`
 
         - Adds new fields to documents. Similar to

diff --git a/source/reference/operator/aggregation-pipeline.txt b/source/reference/operator/aggregation-pipeline.txt
@@ -254,6 +254,25 @@ Alphabetical Listing of Stages
           ``$search`` is only available for MongoDB Atlas clusters, and 
           is not available for self-managed deployments.
 
+       To learn more, see :atlas:`Atlas Search Aggregation Pipeline 
+       Stages </reference/atlas-search/query-syntax>`.
+
+   * - :pipeline:`$searchMeta </reference/operator/aggregation/searcMeta>`
+
+     - Returns different types of :ref:`metadata result 
+       <fts-metadata-results>` documents for the :atlas:`Atlas Search 
+       </atlas-search>` query against an :atlas:`Atlas 
+       </reference/atlas-search/query-syntax/>` collection. 
+
+       .. note:: 
+
+          ``$searchMeta`` is only available for MongoDB Atlas clusters 
+          running MongoDB v4.4.9 or higher, and is not available for 
+          self-managed deployments.
+
+       To learn more, see :atlas:`Atlas Search Aggregation Pipeline 
+       Stages </reference/atlas-search/query-syntax>`.
+
 
    * - :pipeline:`$set`
 
@@ -344,6 +363,7 @@ Alphabetical Listing of Stages
    /reference/operator/aggregation/replaceWith
    /reference/operator/aggregation/sample
    /reference/operator/aggregation/search
+   /reference/operator/aggregation/searchMeta
    /reference/operator/aggregation/set
    /reference/operator/aggregation/setWindowFields
    /reference/operator/aggregation/skip

diff --git a/source/reference/operator/aggregation/search.txt b/source/reference/operator/aggregation/search.txt
@@ -12,7 +12,7 @@ by an :atlas:`Atlas Search
 - :atlas:`Index Definitions
   </reference/atlas-search/index-definitions/>` to learn more about 
   creating and managing Atlas Search indexes.
-- :atlas:`$search Aggregation Pipeline Stage
+- :atlas:`Atlas Search Aggregation Pipeline Stages
   </reference/atlas-search/query-syntax/>` to learn more about the 
   ``$search`` pipeline stage syntax and usage.
 - :atlas:`$search Operators </reference/atlas-search/operators/>` to 

diff --git a/source/reference/operator/aggregation/searchMeta.txt b/source/reference/operator/aggregation/searchMeta.txt
@@ -0,0 +1,25 @@
+=========================
+$searchMeta (aggregation)
+=========================
+
+.. default-domain:: mongodb
+
+``searchMeta`` returns different :ref:`types of metadata result 
+<fts-metadata-results>` documents for Atlas Search queries on 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:`Index Definitions
+  </reference/atlas-search/index-definitions/>` to learn more about 
+  creating and managing Atlas Search indexes.
+- :atlas:`Atlas Search Aggregation Pipeline Stages
+  </reference/atlas-search/query-syntax/>` to learn more about the 
+  ``$searchMeta`` pipeline stage syntax, usage, and results.
+
+.. important:: 
+
+   The ``$searchMeta`` aggregation pipeline stage is only available for 
+   collections hosted on :atlas:`MongoDB Atlas </>` cluster tiers 
+   running MongoDB version 4.4.9 or later. To learn more, see 
+   :atlas:`Atlas Search </atlas-search/>`.