diff --git a/source/documents/modify-multiple.txt b/source/documents/modify-multiple.txt index b8e84fb49..288496026 100644 --- a/source/documents/modify-multiple.txt +++ b/source/documents/modify-multiple.txt @@ -30,7 +30,7 @@ About this Task - Previews of the documents affected by bulk update operations are only visible if your database is configured to support transactions. - For details, see :ref:`transactions`. + For details, see :manual:``. .. BEGIN-COMPASS-ONLY diff --git a/source/export-query-to-language.txt b/source/export-query-to-language.txt index 36b6c5142..83eff6303 100644 --- a/source/export-query-to-language.txt +++ b/source/export-query-to-language.txt @@ -63,7 +63,11 @@ Procedure :figwidth: 600px :alt: Copy button clicked in Export Query to Language modal +.. BEGIN-COMPASS-ONLY + Learn More ---------- - :ref:`compass-export-agg-builder-results` + +.. END-COMPASS-ONLY diff --git a/source/images/compass/field-percentage-breakdown.png b/source/images/compass/field-percentage-breakdown.png index 2d7f97d6e..0a8d0f5cb 100644 Binary files a/source/images/compass/field-percentage-breakdown.png and b/source/images/compass/field-percentage-breakdown.png differ diff --git a/source/images/compass/mixed-sample.png b/source/images/compass/mixed-sample.png index 9e83e47ce..cd41a9473 100644 Binary files a/source/images/compass/mixed-sample.png and b/source/images/compass/mixed-sample.png differ diff --git a/source/images/compass/mixed-sample2.png b/source/images/compass/mixed-sample2.png index 6d901498f..85344717f 100644 Binary files a/source/images/compass/mixed-sample2.png and b/source/images/compass/mixed-sample2.png differ diff --git a/source/indexes.txt b/source/indexes.txt index 179df848e..25c7bb7f9 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -81,8 +81,6 @@ Create an Index .. include:: /includes/shared/steps/create-index.rst -.. BEGIN-COMPASS-ONLY - Create an Atlas Search Index ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -97,8 +95,6 @@ Atlas Vector Search indexes enable you to index vector data *and* other data types, which facilitates semantic searches on the indexed fields. For more information, see :ref:`compass-create-vector-search`. -.. END-COMPASS-ONLY - .. _compass-wildcard-index: Create a Wildcard Index diff --git a/source/query/atlas-search.txt b/source/query/atlas-search.txt index 5cc81d8c5..2f9731360 100644 --- a/source/query/atlas-search.txt +++ b/source/query/atlas-search.txt @@ -12,11 +12,25 @@ Run Atlas Search Queries :depth: 1 :class: singlecol -You can run Atlas Search :pipeline:`$search` and :pipeline:`$searchMeta` -queries from |compass| if you :ref:`created the Atlas Search index -` for data on the Atlas cluster. You can -also run :pipeline:`$vectorSearch` queries from |compass| if you have an -existing Atlas Vector search index on your data in Atlas. +Atlas Search queries are run as an :ref:`aggregation pipeline stage +`. If you have an existing Atlas Search Index for data on +your Atlas cluster, you can run :pipeline:`$search` and :pipeline:`$searchMeta` +queries. If you have an existing Atlas Vector search index on your data in +Atlas, you can also run :pipeline:`$vectorSearch` queries. + +Before You Begin +---------------- + +Create an :ref:`Atlas Search index ` or an +:ref:`Atlas Vector Search index `. + +.. note:: + + Atlas Search index management in the |compass-short| UI is available only + for: + + - Atlas local deployments. + - Deployments running MongoDB 7.0 or later. Steps ----- @@ -25,32 +39,28 @@ Steps :style: normal .. step:: Find the index you want to use in your query - - a. From the :guilabel:`Indexes` tab, click :guilabel:`Search Indexes`. - #. Hover over the index you want to use in your query. - .. step:: Run the query + From the :guilabel:`Indexes` tab, click :guilabel:`Search Indexes`. + Hover over the search index you want to use in your query. - a. Click the :guilabel:`Aggregate` button. - - |compass| switches to the :guilabel:`Aggregations` tab where you - can run your query. - - #. Construct your query. + .. step:: Open the aggregation pipeline builder + + Click the :guilabel:`Aggregate` button that appears when you hover over + your search index. - By default, |compass| selects the :pipeline:`$search` stage for - your query. You can select the :pipeline:`$searchMeta` stage - to use in your query. If you are using a ``vectorSearch`` type - index in your query, you can only use the - :pipeline:`$vectorSearch` stage in your query. + .. step:: Construct your query + + By default, |compass| selects the :pipeline:`$search` stage for your + query. You can also select the :pipeline:`$searchMeta` stage to use in + your query. If you are using a ``vectorSearch`` type index in your query, + you can use the :pipeline:`$vectorSearch` stage. - .. note:: + .. note:: - The Atlas Search :pipeline:`$search` and :pipeline:`$searchMeta` and - the Atlas Vector Search :pipeline:`$vectorSearch` pipeline stages must - be the first stage in your aggregation pipeline. + If you use the ``$search``, ``$searchMeta``, or ``$vectorSearch`` + stage, it must be the first stage in your aggregation pipeline. - #. Click :guilabel:`Run` to run your query. + .. step:: Run your query Learn More ---------- diff --git a/source/schema.txt b/source/schema.txt index da5b75191..77433efc8 100644 --- a/source/schema.txt +++ b/source/schema.txt @@ -109,8 +109,8 @@ For fields that contain multiple data types, |compass-short| displays a percentage breakdown of the various data types across documents. In the example below, the chart shows the contents of a field called ``phone_no`` in which -81% of documents are of type ``string``, and the remaining 19% are of -type ``number``. +20% of documents are of type ``int32``, and the remaining 80% are of +type ``string``. .. figure:: /images/compass/field-percentage-breakdown.png :figwidth: 330px @@ -239,7 +239,7 @@ field shows the values that are strings: :figwidth: 574px :alt: Example of a field with mixed types -Clicking on the ``number`` type causes the chart to show its numeric +Clicking on the ``int32`` type causes the chart to show its numeric data: .. figure:: /images/compass/mixed-sample2.png