diff --git a/source/collections.txt b/source/collections.txt index 04eda077c..a3420f3f5 100644 --- a/source/collections.txt +++ b/source/collections.txt @@ -1,9 +1,9 @@ .. _compass-collection-tab: .. _compass-collections: -============================= -Manage Collections in Compass -============================= +===================================== +Manage Collections in |compass-short| +===================================== .. default-domain:: mongodb diff --git a/source/databases.txt b/source/databases.txt index 2d3efc852..6f0f8cd06 100644 --- a/source/databases.txt +++ b/source/databases.txt @@ -1,9 +1,9 @@ .. _compass-database-tab: .. _compass-dbs: -=========================== -Manage Databases in Compass -=========================== +=================================== +Manage Databases in |compass-short| +=================================== .. default-domain:: mongodb diff --git a/source/documents.txt b/source/documents.txt index 1bad8228b..16dcecfe0 100644 --- a/source/documents.txt +++ b/source/documents.txt @@ -1,9 +1,9 @@ .. _compass-documents: .. _compass-docs: -=========================== -Manage Documents in Compass -=========================== +=================================== +Manage Documents in |compass-short| +=================================== .. default-domain:: mongodb @@ -25,7 +25,7 @@ documents in your selected collection or view. .. note:: - For query result sets larger than 20 documents, Compass shows + For query result sets larger than 20 documents, |compass-short| shows paginated results. By default, pages display 20 documents at a time. .. END-COMPASS-ONLY diff --git a/source/documents/delete-multiple.txt b/source/documents/delete-multiple.txt index 9b02efa95..918a84f47 100644 --- a/source/documents/delete-multiple.txt +++ b/source/documents/delete-multiple.txt @@ -14,7 +14,7 @@ Delete Multiple Documents :depth: 1 :class: singlecol -You can perform bulk delete operations on multiple documents in Compass +You can perform bulk delete operations on multiple documents in |compass-short| by using the :guilabel:`Delete Documents` modal. This helps you visualize deletes before applying them. @@ -32,8 +32,8 @@ Before you Begin ---------------- The :guilabel:`Delete Documents` modal is available starting -in Compass version ``1.42.0``. For instructions on updating or installing -the latest Compass version, see :ref:`download-install`. +in |compass-short| version ``1.42.0``. For instructions on updating or installing +the latest |compass-short| version, see :ref:`download-install`. .. END-COMPASS-ONLY @@ -108,7 +108,7 @@ Steps #. Click the red :guilabel:`Delete Documents` button to confirm the operation. - Compass deletes the documents that match the filter + |compass-short| deletes the documents that match the filter expression. Example diff --git a/source/documents/delete.txt b/source/documents/delete.txt index fa0e45b7e..20b1c8c87 100644 --- a/source/documents/delete.txt +++ b/source/documents/delete.txt @@ -68,13 +68,13 @@ documents in List, JSON, or Table view: |compass-short| asks for confirmation that you want to remove the document. -Once you confirm, Compass deletes the document from the collection. +Once you confirm, |compass-short| deletes the document from the collection. Delete Multiple Documents ------------------------- You can use the bulk delete operations workflow to delete multiple -documents in Compass. For details, see :ref:`compass-bulk-delete`. +documents in |compass-short|. For details, see :ref:`compass-bulk-delete`. .. BEGIN-COMPASS-ONLY .. note:: diff --git a/source/documents/modify-multiple.txt b/source/documents/modify-multiple.txt index bc0ca781c..b8e84fb49 100644 --- a/source/documents/modify-multiple.txt +++ b/source/documents/modify-multiple.txt @@ -14,7 +14,7 @@ Modify Multiple Documents :depth: 1 :class: singlecol -You can perform bulk update operations on multiple documents in Compass +You can perform bulk update operations on multiple documents in |compass-short| by using the :guilabel:`Update Documents` modal. Performing updates with the :guilabel:`Update Documents` modal helps you visualize updates to your data before you apply them. @@ -38,8 +38,8 @@ Before you Begin ---------------- The :guilabel:`Update Documents` modal is available starting -in Compass version ``1.42.0``. For instructions on updating or installing -the latest Compass version, see :ref:`download-install`. +in |compass-short| version ``1.42.0``. For instructions on updating or installing +the latest |compass-short| version, see :ref:`download-install`. .. END-COMPASS-ONLY @@ -120,7 +120,7 @@ Steps Click :guilabel:`Update Documents`. - Compass applies the :guilabel:`Update` to the documents + |compass-short| applies the :guilabel:`Update` to the documents within the :guilabel:`Filter` expression. Example @@ -130,7 +130,7 @@ The following example uses the :ref:`sample_mflix dataset `. This example updates the ``tomatoes.viewer.numReviews`` and -``tomatoes.viewer.meter`` fields with the Compass +``tomatoes.viewer.meter`` fields with the |compass-short| :guilabel:`Update Documents` modal. Apply a filter in the :guilabel:`Query Bar` to filter movies which diff --git a/source/documents/modify.txt b/source/documents/modify.txt index c8a00bede..b2bb7776e 100644 --- a/source/documents/modify.txt +++ b/source/documents/modify.txt @@ -210,7 +210,7 @@ Modify Multiple Documents ------------------------- You can use the bulk update operations workflow to update multiple -documents in Compass. For details, see :ref:`compass-bulk-update`. +documents in |compass-short|. For details, see :ref:`compass-bulk-update`. .. BEGIN-COMPASS-ONLY diff --git a/source/includes/extracts-query-bar.yaml b/source/includes/extracts-query-bar.yaml index 323844a0e..f1f4c5c17 100644 --- a/source/includes/extracts-query-bar.yaml +++ b/source/includes/extracts-query-bar.yaml @@ -1,7 +1,7 @@ ref: query-bar-results content: | - For query result sets larger than 1000 documents, Compass shows a - subset of the results. Otherwise, Compass shows the entire result + For query result sets larger than 1000 documents, |compass-short| shows a + subset of the results. Otherwise, |compass-short| shows the entire result set. For details on sampling, see :ref:`Sampling `. diff --git a/source/indexes.txt b/source/indexes.txt index 6926bb8a8..8f1d4a5be 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -52,7 +52,7 @@ collection on the left hand pane and select the :guilabel:`Indexes` tab. :figwidth: 816px :alt: Indexes view -For each index, Compass displays the following information: +For each index, |compass-short| displays the following information: .. list-table:: @@ -178,7 +178,7 @@ Limitations - The :guilabel:`Indexes` tab is not available if you are connected to a :atlas:`Data Lake `. -- You can manage Atlas Search indexes in Compass if your deployment is +- You can manage Atlas Search indexes in |compass-short| if your deployment is local, has an Atlas cluster tier of M10 or larger, and runs MongoDB 7.0 or higher. diff --git a/source/query-with-natural-language/ai-and-data-usage-information.txt b/source/query-with-natural-language/ai-and-data-usage-information.txt index be193d80c..b7cac9538 100644 --- a/source/query-with-natural-language/ai-and-data-usage-information.txt +++ b/source/query-with-natural-language/ai-and-data-usage-information.txt @@ -9,7 +9,7 @@ AI and Data Usage Information :backlinks: none :depth: 1 -Querying with natural language in Compass is powered by Generative AI +Querying with natural language in |compass-short| is powered by Generative AI (Gen AI), and may give inaccurate responses. See our `Generative AI FAQ `__ for more information about Gen AI in MongoDB products. @@ -17,14 +17,14 @@ for more information about Gen AI in MongoDB products. Third Party Providers --------------------- -Querying with natural language in Compass currently uses the `Azure OpenAI Service -`__ +Querying with natural language in |compass-short| currently uses the +`Azure OpenAI Service `__ hosted by Microsoft. This is subject to change in the future. How Your Data is Used --------------------- -When you query with natural language in Compass, the following +When you query with natural language in |compass-short|, the following information is sent to MongoDB's backend and/or the third party AI provider: @@ -51,7 +51,7 @@ connection strings, credentials, or rows/documents from your databases. Disable Natural Language Querying --------------------------------- -- Natural language querying in Compass is available if you have +- Natural language querying in |compass-short| is available if you have enabled the :ref:`Generative AI setting ` and logged into Atlas. - If you no longer want to use the feature, uncheck diff --git a/source/query-with-natural-language/enable-natural-language-querying.txt b/source/query-with-natural-language/enable-natural-language-querying.txt index 6e078a004..4f454ea11 100644 --- a/source/query-with-natural-language/enable-natural-language-querying.txt +++ b/source/query-with-natural-language/enable-natural-language-querying.txt @@ -11,7 +11,7 @@ Enable Natural Language Querying :backlinks: none :depth: 1 -You can enable Compass natural language querying by toggling the +You can enable |compass-short| natural language querying by toggling the :guilabel:`Use Generative AI` setting. Natural language queries can be a helpful starting point and assist you in learning to write MongoDB queries. @@ -19,18 +19,18 @@ queries. About this Task --------------- -To enable natural language querying in Compass, follow the steps below. +To enable natural language querying in |compass-short|, follow the steps below. Alternatively, you can enable natural language querying by clicking the :guilabel:`Log in to Atlas to enable` button within the :guilabel:`Use natural language to generate queries and pipelines` modal. -You can display this modal on Compass versions 1.40.0 or later when +You can display this modal on |compass-short| versions 1.40.0 or later when you click the :guilabel:`Generate query` or :guilabel:`Generate aggregation` button on the query bar. Before you Begin ---------------- -To enable the generation of queries and aggregations in Compass, +To enable the generation of queries and aggregations in |compass-short|, you must: - Sign into Atlas. For details on how to get a free Atlas @@ -94,8 +94,7 @@ Steps .. step:: (Optional) Read MongoDB's GenAI FAQs - For more information about generative AI usage with MongoDB - Compass, see: + For more information about generative AI usage with |compass|, see: - :ref:`compass-ai-data-usage` - `FAQ For MongoDB Generative AI Features `__ diff --git a/source/query-with-natural-language/prompt-natural-language-aggregation.txt b/source/query-with-natural-language/prompt-natural-language-aggregation.txt index c4b57da25..84a0ad198 100644 --- a/source/query-with-natural-language/prompt-natural-language-aggregation.txt +++ b/source/query-with-natural-language/prompt-natural-language-aggregation.txt @@ -11,8 +11,8 @@ Prompt a Natural Language Aggregation :backlinks: none :depth: 1 -You can use MongoDB Compass to generate aggregation queries using natural -language. Compass uses AI to generate aggregations based on prompts +You can use |compass| to generate aggregation queries using natural +language. |compass-short| uses AI to generate aggregations based on prompts you provide. Querying with natural language can be a helpful starting point and assist you in learning to write MongoDB queries. @@ -34,7 +34,7 @@ About this Task Before you Begin ---------------- -You must :ref:`enable natural language querying in Compass`. +You must :ref:`enable natural language querying in Compass `. Steps ----- diff --git a/source/query-with-natural-language/prompt-natural-language-query.txt b/source/query-with-natural-language/prompt-natural-language-query.txt index 1631034b6..dbe18d9e0 100644 --- a/source/query-with-natural-language/prompt-natural-language-query.txt +++ b/source/query-with-natural-language/prompt-natural-language-query.txt @@ -11,8 +11,8 @@ Prompt a Natural Language Query :backlinks: none :depth: 1 -You can use MongoDB Compass to generate queries using natural -language. Compass uses AI to generate queries based on prompts +You can use |compass| to generate queries using natural +language. |compass-short| uses AI to generate queries based on prompts you provide. Querying with natural language can be a helpful starting point and assist you in learning to write MongoDB queries. diff --git a/source/query-with-natural-language/query-with-natural-language.txt b/source/query-with-natural-language/query-with-natural-language.txt index 5a3a7d6f8..4fd49a9c8 100644 --- a/source/query-with-natural-language/query-with-natural-language.txt +++ b/source/query-with-natural-language/query-with-natural-language.txt @@ -11,14 +11,14 @@ Query with Natural Language :backlinks: none :depth: 2 -You can use MongoDB Compass to ask natural language questions about your -data. Compass uses AI to generate filter queries and aggregations based +You can use |compass| to ask natural language questions about your +data. |compass-short| uses AI to generate filter queries and aggregations based on the prompts you provide. Use Cases --------- -You may want to use natural language to query in Compass to: +You may want to use natural language to query in |compass-short| to: - Ask plain text questions about your data. - Create an initial query or aggregation pipeline that you can @@ -28,7 +28,7 @@ You may want to use natural language to query in Compass to: Behavior -------- -- Compass natural language querying is available starting in version +- |compass-short| natural language querying is available starting in version ``1.40.x``. - Natural language querying utilizes `Azure Open AI @@ -36,7 +36,7 @@ Behavior as its current provider. This provider may be subject to change in the future. -- The MongoDB Compass natural language querying feature is on a rolling +- The |compass| natural language querying feature is on a rolling release schedule. As a result, some users may temporarily have functionality that other users do not. @@ -50,7 +50,7 @@ Get Started Details ------- -When you query your data using natural language in Compass, the text of +When you query your data using natural language in |compass-short|, the text of your prompts and details about your MongoDB schemas are sent to Microsoft and OpenAI for processing. Your data is not stored on any third party storage systems or used to train AI models. diff --git a/source/query/filter.txt b/source/query/filter.txt index 11bd7dd15..d894f2a24 100644 --- a/source/query/filter.txt +++ b/source/query/filter.txt @@ -422,7 +422,7 @@ in the MongoDB manual. Supported Data Types in the Query Bar ------------------------------------- -The Compass :guilabel:`Filter` supports using the +The |compass-short| :guilabel:`Filter` supports using the :binary:`~bin.mongosh` representation of the MongoDB Extended JSON :manual:`BSON data types `. @@ -437,11 +437,11 @@ Extended JSON :manual:`BSON data types `_, instead of comparing the values chronologically. @@ -461,8 +461,8 @@ Query Collections with Invalid UTF8 Data .. END-COMPASS-ONLY -How Does the Compass Query Compare to MongoDB and SQL Queries? --------------------------------------------------------------- +How Does the |compass-short| Query Compare to MongoDB and SQL Queries? +---------------------------------------------------------------------- :expression:`$filter` corresponds to the ``WHERE`` clause in a |sql| ``SELECT`` statement. @@ -472,7 +472,7 @@ How Does the Compass Query Compare to MongoDB and SQL Queries? You have 3,235 articles. You would like to see all articles that Joe Bloggs wrote. - Compass Filter Option + |compass-short| Filter Option .. code-block:: javascript { author : { $eq : "Joe Bloggs" } } diff --git a/source/query/limit.txt b/source/query/limit.txt index 67f978431..916bc688a 100644 --- a/source/query/limit.txt +++ b/source/query/limit.txt @@ -31,8 +31,8 @@ Clear the Query .. include:: /includes/clear-query.rst -How Does the Compass Query Compare to MongoDB and SQL Queries? --------------------------------------------------------------- +How Does the |compass-short| Query Compare to MongoDB and SQL Queries? +---------------------------------------------------------------------- :pipeline:`$skip` corresponds to the ``LIMIT ...`` clause in a |sql| ``SELECT`` statement. @@ -55,7 +55,7 @@ in a |sql| ``SELECT`` statement. { $limit : 10 } ); - Compass Limit Option + |compass-short| Limit Option .. code-block:: javascript $limit : 10 diff --git a/source/query/project.txt b/source/query/project.txt index 17efbdabe..aaf0305d8 100644 --- a/source/query/project.txt +++ b/source/query/project.txt @@ -50,8 +50,8 @@ To set a projection: .. include:: /includes/extracts/query-bar-results.rst -How Does the Compass Query Compare to MongoDB and SQL Queries? --------------------------------------------------------------- +How Does the |compass-short| Query Compare to MongoDB and SQL Queries? +---------------------------------------------------------------------- :pipeline:`$project` corresponds to choosing specific fields to return in a |sql| ``SELECT`` statement. @@ -73,7 +73,7 @@ in a |sql| ``SELECT`` statement. { $project : { headline : 1, author : 1 } } ); - Compass Project Option + |compass-short| Project Option .. code-block:: javascript { headline : 1, author : 1 } diff --git a/source/query/queries.txt b/source/query/queries.txt index f7b505d49..94adc79c3 100644 --- a/source/query/queries.txt +++ b/source/query/queries.txt @@ -64,10 +64,10 @@ once connected to your cluster. Using the :guilabel:`My Queries` Tab ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -When you click a saved or favorite query tile, Compass opens the +When you click a saved or favorite query tile, |compass-short| opens the :guilabel:`Documents` tab with the filter loaded. -When you click a saved or favorite pipeline tile, Compass opens the +When you click a saved or favorite pipeline tile, |compass-short| opens the :guilabel:`Aggregations` tab with the pipeline loaded. .. _compass-saved-favorite-query-view: diff --git a/source/query/skip.txt b/source/query/skip.txt index 840ee25c4..6a2b37c81 100644 --- a/source/query/skip.txt +++ b/source/query/skip.txt @@ -35,8 +35,8 @@ Clear the Query .. include:: /includes/clear-query.rst -How Does the Compass Query Compare to MongoDB and SQL Queries? --------------------------------------------------------------- +How Does the |compass-short| Query Compare to MongoDB and SQL Queries? +---------------------------------------------------------------------- :pipeline:`$skip` corresponds to the ``LIMIT ... OFFSET ...`` clause in a |sql| ``SELECT`` statement. @@ -60,7 +60,7 @@ in a |sql| ``SELECT`` statement. { $skip : 435 } ); - Compass Skip Option + |compass-short| Skip Option .. code-block:: javascript $skip : 435 diff --git a/source/query/sort.txt b/source/query/sort.txt index 75cc29e15..2c6adfbc5 100644 --- a/source/query/sort.txt +++ b/source/query/sort.txt @@ -64,8 +64,8 @@ Clear the Query .. include:: /includes/clear-query.rst -How Does the Compass Query Compare to MongoDB and SQL Queries? --------------------------------------------------------------- +How Does the |compass-short| Query Compare to MongoDB and SQL Queries? +---------------------------------------------------------------------- :pipeline:`$sort` corresponds to the ``ORDER BY ...`` clause @@ -89,7 +89,7 @@ in a |sql| ``SELECT`` statement. { $sort : { headline : 1 } } ); - Compass Sort Option + |compass-short| Sort Option .. code-block:: javascript $sort : { headline : 1 } diff --git a/source/schema.txt b/source/schema.txt index f60df8ebd..42fb8dfa4 100644 --- a/source/schema.txt +++ b/source/schema.txt @@ -43,7 +43,7 @@ percentage of each data type represented. - The ``_id`` field is an :manual:`ObjectId `. - Each ObjectId contains a timestamp, so Compass displays the range + Each ObjectId contains a timestamp, so |compass-short| displays the range of creation times for the sampled documents. - The ``address`` field contains four nested fields. You @@ -52,7 +52,7 @@ percentage of each data type represented. - The ``borough`` field contains a string indicating the borough in which the restaurant is located. The cardinality is low enough - that Compass can provide a graded bar of the field contents, with + that |compass-short| can provide a graded bar of the field contents, with the most-frequently occurring string on the left. - The ``grades`` field contains arrays of strings. The analysis @@ -86,9 +86,9 @@ particular fields to display and the number of results to return. Field Descriptions ------------------ -For each field, Compass displays summary information about the data +For each field, |compass-short| displays summary information about the data type or types the field contains and the range of values. Depending -on the data type and the level of cardinality, Compass displays +on the data type and the level of cardinality, |compass-short| displays histograms, graded bars, geographical maps, and sample data to provide a sense of the shape and scope of the data contained in each field. @@ -106,7 +106,7 @@ Field with Multiple Data Types ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For fields that contain multiple data types, -Compass displays a percentage breakdown of +|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 @@ -132,7 +132,7 @@ Strings ~~~~~~~ Strings can appear in three different ways. If there are -entirely unique strings in a field, Compass shows a random +entirely unique strings in a field, |compass-short| shows a random selection of string values from the specified field. Click the circular refresh icon to see a new set of randomly selected values from the field. @@ -142,7 +142,7 @@ a new set of randomly selected values from the field. :alt: Example of string data types If there are only a few different string values, -Compass shows the strings in a single graded bar which +|compass-short| shows the strings in a single graded bar which shows the percentage of the population of the string values. .. figure:: /images/compass/string-sample2.png @@ -150,7 +150,7 @@ shows the percentage of the population of the string values. :alt: Example of few string data types If there are multiple string values with some duplicates, -Compass shows a histogram indicating the frequency of +|compass-short| shows a histogram indicating the frequency of each string found within the field. .. figure:: /images/compass/string-sample3.png @@ -250,7 +250,7 @@ Query Builder ------------- In the :guilabel:`Schema` tab, you can type the filter manually into -the query bar or generate the filter with the Compass query builder. +the query bar or generate the filter with the |compass-short| query builder. The query builder allows you to select data elements from one or more fields in your schema and construct a query matching the selected elements. diff --git a/source/validation.txt b/source/validation.txt index f3c36bee0..e151a54f7 100644 --- a/source/validation.txt +++ b/source/validation.txt @@ -35,7 +35,7 @@ Validation Rules The validation editor supports :manual:`JSON Schema validation `, and validation with query expressions using :manual:`query operators `. -After you click the :guilabel:`Update` button, Compass updates to +After you click the :guilabel:`Update` button, |compass-short| updates to display a document from your collection that passes the validation and a document that fails. diff --git a/source/views.txt b/source/views.txt index e1e4be278..2de0ecfb0 100644 --- a/source/views.txt +++ b/source/views.txt @@ -1,9 +1,9 @@ .. _compass-view-details: .. _compass-views: -======================= -Manage Views in Compass -======================= +=============================== +Manage Views in |compass-short| +=============================== .. default-domain:: mongodb