Skip to content

(DOCSP-13152): Improve Atlas Search callouts #4918

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions source/core/index-text.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ Text Indexes
:depth: 1
:class: singlecol

.. include:: /includes/fact-atlas-search-banner.rst

Overview
--------

Expand Down
2 changes: 2 additions & 0 deletions source/core/text-search-operators.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ For more information and examples of text search in the
:doc:`/aggregation` framework, see
:doc:`/tutorial/text-search-in-aggregation`.

.. include:: /includes/fact-atlas-search-search-stage.rst

.. [#meta-aggregation]

.. include:: /includes/fact-meta-operator-disambiguation.rst
Expand Down
4 changes: 4 additions & 0 deletions source/includes/fact-atlas-search-languages.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
For data hosted on MongoDB Atlas, :atlas:`Atlas Search </atlas-search>`
provides support for additional languages. To see the complete list of
languages supported by Atlas Search, see the :atlas:`Atlas Search
Language Analyzers </reference/atlas-search/analyzers/language/>`.
3 changes: 3 additions & 0 deletions source/includes/fact-atlas-search-search-stage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
For data hosted on MongoDB Atlas, :atlas:`Atlas Search </atlas-search>`
provides the :atlas:`$search </reference/atlas-search/query-syntax/>`
aggregation stage to perform full-text search on your collections.
5 changes: 5 additions & 0 deletions source/includes/fact-text-index-limit-one.rst
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
A collection can have at most **one** ``text`` index.

Atlas Search (available in `MongoDB Atlas
<https://www.mongodb.com/cloud/atlas?tck=docs_server>`__) supports
multiple full-text search indexes on a single collection. To learn more,
see the :atlas:`Atlas Search documentation </atlas-search>`.
11 changes: 9 additions & 2 deletions source/reference/operator/query/text.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ $text
:depth: 1
:class: singlecol

.. include:: /includes/fact-atlas-search-banner.rst

Definition
----------

Expand Down Expand Up @@ -165,6 +163,15 @@ The :query:`text` operator treats most punctuation
in the string as delimiters, except a hyphen-minus (``-``) that negates term or
an escaped double quotes ``\"`` that specifies a phrase.

.. note::

The ``$search`` field for the :query:`$text` expression is different
than the the :atlas:`$search aggregation stage
</reference/atlas-search/query-syntax/>` provided by
:atlas:`Atlas Search </atlas-search>`. The ``$search`` aggregation
stage performs full-text search on specified fields and is only
available on MongoDB Atlas.

.. _text-operator-phrases:

Phrases
Expand Down
2 changes: 2 additions & 0 deletions source/reference/text-search-languages.txt
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,7 @@ language name:

.. include:: /includes/fact-text-search-language-none.rst

.. include:: /includes/fact-atlas-search-languages.rst

.. seealso:: :doc:`/tutorial/specify-language-for-text-index`

4 changes: 2 additions & 2 deletions source/text-search.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ Text Search
:depth: 1
:class: singlecol

.. include:: /includes/fact-atlas-search-banner.rst

Overview
--------

Expand Down Expand Up @@ -108,6 +106,8 @@ MongoDB supports text search for various languages. See
:doc:`/reference/text-search-languages` for a list of supported
languages.

.. include:: /includes/fact-atlas-search-languages.rst

.. toctree::
:titlesonly:
:hidden:
Expand Down
7 changes: 7 additions & 0 deletions source/tutorial/control-results-of-text-search.txt
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,10 @@ each other. For instance, a term match in the ``content`` field has:

- ``10`` times (i.e. ``10:1``) the impact as a term match in the
``about`` field.

.. note::

For data hosted on MongoDB Atlas,
:atlas:`Atlas Search </atlas-search>` provides more robust custom
scoring than ``text`` indexes. To learn more, see the Atlas Search
:atlas:`Scoring </reference/atlas-search/scoring/>` documentation.
9 changes: 7 additions & 2 deletions source/tutorial/text-search-in-aggregation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In the aggregation pipeline, text search is available via the use of
the :query:`$text` query operator in the :pipeline:`$match` stage.

Restrictions
~~~~~~~~~~~~
------------

For general :query:`$text` operator restrictions, see :ref:`operator
restrictions <text-query-operator-behavior>`.
Expand All @@ -36,7 +36,7 @@ restrictions:
.. |sort-object| replace:: :pipeline:`$sort` pipeline

Text Score
~~~~~~~~~~
----------

.. include:: /includes/fact-text-search-score.rst

Expand Down Expand Up @@ -132,3 +132,8 @@ matching documents in the :pipeline:`$group` stage.
{ $group: { _id: null, views: { $sum: "$views" } } }
]
)

``$search`` Stage in Atlas Search
---------------------------------

.. include:: /includes/fact-atlas-search-search-stage.rst