diff --git a/source/includes/extracts-agg-stages.yaml b/source/includes/extracts-agg-stages.yaml index e99c6648bfc..cbbc1a47afe 100644 --- 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 `. + * - :pipeline:`$searchMeta` + + - Returns different types of metadata result documents for the + :atlas:`Atlas Search ` query against an + :atlas:`Atlas ` + 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 + `. + * - :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 index a066d8a7890..d52089a7672 100644 --- 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 `. + + * - :pipeline:`$searchMeta ` + + - Returns different types of :ref:`metadata result + ` documents for the :atlas:`Atlas Search + ` query against an :atlas:`Atlas + ` 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 `. + * - :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 index c469ed063a5..019404f53ef 100644 --- 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 ` to learn more about creating and managing Atlas Search indexes. -- :atlas:`$search Aggregation Pipeline Stage +- :atlas:`Atlas Search Aggregation Pipeline Stages ` to learn more about the ``$search`` pipeline stage syntax and usage. - :atlas:`$search Operators ` to diff --git a/source/reference/operator/aggregation/searchMeta.txt b/source/reference/operator/aggregation/searchMeta.txt new file mode 100644 index 00000000000..58128711627 --- /dev/null +++ b/source/reference/operator/aggregation/searchMeta.txt @@ -0,0 +1,25 @@ +========================= +$searchMeta (aggregation) +========================= + +.. default-domain:: mongodb + +``searchMeta`` returns different :ref:`types of metadata result +` documents for Atlas Search queries on the field +or fields in an Atlas collection. The fields must be covered by an +:atlas:`Atlas Search ` +index. See: + +- :atlas:`Index Definitions + ` to learn more about + creating and managing Atlas Search indexes. +- :atlas:`Atlas Search Aggregation Pipeline Stages + ` 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 `.