From 00e03a5b63cc0287cf13fe23745fc18f8cd00f24 Mon Sep 17 00:00:00 2001 From: Kanchana Sekhar Date: Mon, 1 Mar 2021 08:36:40 -0800 Subject: [PATCH] DOCSP-14880 Create shell page for Atlas Search DOCSP-14880 updates for copy review feedback --- config/redirects | 4 +++ source/includes/extracts-agg-stages.yaml | 11 ++++++++ .../operator/aggregation-pipeline.txt | 12 +++++++++ .../reference/operator/aggregation/search.txt | 26 +++++++++++++++++++ 4 files changed, 53 insertions(+) create mode 100644 source/reference/operator/aggregation/search.txt diff --git a/config/redirects b/config/redirects index bd401194335..a865136311f 100644 --- a/config/redirects +++ b/config/redirects @@ -1651,6 +1651,9 @@ raw: /v2.8/release-notes/2.8-changes -> ${base}/v3.0/release-notes/3.0/ [v3.0-v4.0]: /${version}/reference/method/ClientEncryption.encrypt -> ${base}/${version}/reference/method/ [v3.0-v4.0]: /${version}/reference/method/ClientEncryption.decrypt -> ${base}/${version}/reference/method/ +# Redirects Atlas $search for ticket DOCSP-14880 +[v3.4-v4.0]: /${version}/reference/operator/aggregation/search -> ${base}/${version}/reference/operator/aggregation/ + [v4.0-*]: /${version}/core/security-built-in-roles -> ${base}/${version}/reference/built-in-roles/ [v4.0-*]: /${version}/core/security-network -> ${base}/${version}/core/security-hardening/ @@ -1709,6 +1712,7 @@ raw: /manual/core/wildcard -> ${base}/manual/core/index-wildcard/ [v3.4-v4.2]: /${version}/reference/operator/aggregation/replaceOne -> ${base}/${version}/reference/operator/aggregation/ [v3.4-v4.2]: /${version}/reference/operator/aggregation/function -> ${base}/${version}/reference/operator/aggregation/ + ## Redirects for release notes - trying something more specific [v4.2]: /${version}/release-notes/4.4 -> ${base}/${version}/release-notes/4.2/ diff --git a/source/includes/extracts-agg-stages.yaml b/source/includes/extracts-agg-stages.yaml index 1d3fc610205..47dfb4db4ab 100644 --- a/source/includes/extracts-agg-stages.yaml +++ b/source/includes/extracts-agg-stages.yaml @@ -165,6 +165,17 @@ content: | - Randomly selects the specified number of documents from its input. + * - :pipeline:`$search` + + - Performs a full-text search of the field or fields in an + :atlas:`Atlas ` + collection. + + .. note:: + + ``$search`` is only available for MongoDB Atlas clusters, + and is not available for self-managed deployments. + * - :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 3a16d04f19f..ae4e927595a 100644 --- a/source/reference/operator/aggregation-pipeline.txt +++ b/source/reference/operator/aggregation-pipeline.txt @@ -242,6 +242,17 @@ Alphabetical Listing of Stages - Randomly selects the specified number of documents from its input. + * - :doc:`$search ` + + - Performs a full-text search of the field or fields in an Atlas + collection. + + .. note:: + + ``$search`` is only available for MongoDB Atlas clusters, and + is not available for self-managed deployments. + + * - :pipeline:`$set` - Adds new fields to documents. Outputs documents that @@ -326,6 +337,7 @@ Alphabetical Listing of Stages /reference/operator/aggregation/replaceRoot /reference/operator/aggregation/replaceWith /reference/operator/aggregation/sample + /reference/operator/aggregation/search /reference/operator/aggregation/set /reference/operator/aggregation/skip /reference/operator/aggregation/sort diff --git a/source/reference/operator/aggregation/search.txt b/source/reference/operator/aggregation/search.txt new file mode 100644 index 00000000000..b92716f3c01 --- /dev/null +++ b/source/reference/operator/aggregation/search.txt @@ -0,0 +1,26 @@ +===================== +$search (aggregation) +===================== + +.. default-domain:: mongodb + +``$search`` aggregation pipleline stage performs a full-text search of +the field or fields in an Atlas collection. The fields must be covered +by an :atlas:`Atlas Search +` index. See: + +- :atlas:`Atlas Search Index + ` to learn more about + creating and managing Atlas Search indexes. +- :atlas:`$search Aggregation Pipeline Stage` to learn more about the + ``$search`` pipeline stage syntax and usage. +- :atlas:`$search Operators ` to + learn more about the ``$search`` aggregation pipeline stage + operators. + +.. important:: + + The ``$search`` aggregation pipeline stage is only available for + collections hosted on :atlas:`MongoDB Atlas ` cluster tiers + running MongoDB version 4.2 or later. To learn more, see + :atlas:`Atlas Search `.