Final updates for 1.19. Non-genuine warning. Release notes. MaxtimeMS. (#157)

* Final updates for 1.19. Non-genuine warning. Release notes. MaxtimeMS.

* Final updates for 1.19. Non-genuine warning. Release notes. MaxtimeMS.

Author: jeff-allen-mongo

source/connect.txt

@@ -15,6 +15,10 @@ Connect to MongoDB
 This page outlines how to use |compass-short| to connect to your
 MongoDB host.
 
+.. note::
+
+   .. include:: /includes/fact-non-genuine-warning.rst
+
 Connect
 -------
 

source/faq.txt

@@ -57,6 +57,13 @@ data in the operating system's credentials API. For more information on
 how Keytar operates and the specific APIs it accesses, refer to the
 `Keytar Github documentation <https://github.com/atom/node-keytar>`_.
 
+.. _compass-faq-non-genuine:
+
+Why am I seeing a warning about a non-genuine MongoDB server?
+-------------------------------------------------------------
+
+.. include:: /includes/fact-non-genuine-warning.rst
+
 .. _compass-faq-sampling:
 
 What is sampling and why is it used?

source/images/compass/max-time-ms.png

@@ -0,0 +1,5 @@
+Starting in |compass| 1.19, |compass-short| displays a
+warning message when connected to non-genuine MongoDB instances as
+these instances may behave differently from the official MongoDB
+instances; e.g. missing or incomplete features, different feature
+behaviors, etc.

source/includes/fact-non-genuine-warning.rst

@@ -21,6 +21,9 @@ documents from the collection.
 .. figure:: /images/compass/query-bar-documents-view.png
    :figwidth: 720px
 
+Options
+-------
+
 You can specify a query filter in the query bar. If you click
 :guilabel:`Options` to expand the query bar, you also have access to
 the ``project``, ``sort``, ``collation``, ``skip``, and ``limit``
@@ -47,6 +50,11 @@ options of the query.
 
      - Set the sort order of the returned documents.
 
+   * - :ref:`MaxTimeMS <query-bar-max-time-ms>`
+     
+     - Adjust the maximum time limit in milliseconds to process
+       the query bar operation.
+
    * - :ref:`Collation <query-bar-collation>`
 
      - Set the
@@ -79,14 +87,9 @@ Limitations
       Filter Returned Documents </query/filter>
       /query/project
       Sort Returned Documents </query/sort>
+      /query/maxtimems
       /query/collation
       Skip Through Documents </query/skip>
       Limit Number of Returned Documents </query/limit>
       /export-query-to-language
       /query/queries
-
-
-
-
-
-

source/query-bar.txt

@@ -0,0 +1,33 @@
+.. _query-bar-max-time-ms:
+
+========================================
+Adjust Maximum Time for Query Operations
+========================================
+
+You can modify the :guilabel:`MaxTimeMS` query bar option to adjust
+the cumulative time limit in milliseconds to process query bar
+operations. If the time limit is reached before the operation completes,
+|compass-short| interrupts the operation.
+
+The default :guilabel:`MaxTimeMS` value is ``5000``. Consider raising
+this value if you have a very large collection, or your operations
+are frequently timing out. You can also consider creating
+:ref:`indexes <compass-indexes>` to improve query performance.
+
+.. figure:: /images/compass/max-time-ms.png
+   :figwidth: 720px
+   :alt: MaxTimeMS Option
+
+Set MaxTimeMS
+-------------
+
+#. Click :guilabel:`Options`.
+
+#. Adjust :guilabel:`MaxTimeMS` to the desired value in milliseconds.
+
+Learn More
+----------
+
+To learn more about :guilabel:`MaxTimeMS`, see
+:manual:`cursor.maxTimeMS() </reference/method/cursor.maxTimeMS/>`
+in the MongoDB manual.

source/query/maxtimems.txt

@@ -9,6 +9,37 @@ Release Notes
    :backlinks: none
    :depth: 1
    :class: twocols
+
+|compass| 1.19
+--------------
+
+*Released August 11, 2019*
+
+- Added support for:
+
+  - :ref:`Views <view-details>`. You can create
+    views based on results from an
+    :ref:`aggregation pipeline <compass-agg-builder>`.
+
+  - :ref:`Wildcard Indexes <compass-indexes>`.
+
+  - Killing long-running operations from the
+    :ref:`Performance Tab <kill-long-ops>`.
+  
+  - :ref:`Adjusting the maximum timeout <query-bar-max-time-ms>` for
+    queries executed in the Query Bar.
+
+- New settings available in the
+  :ref:`aggregation pipeline builder <compass-agg-builder>`. You can
+  now specify a sample size, number of documents to preview, and a
+  maximum timeout for your pipeline operations.
+
+- Obscures fields encrypted with Field-Level Encryption. These fields
+  cannot be modified by |compass-short| users.
+
+- |compass-short| now warns users who are connected to non-genuine
+  MongoDB servers. For more information, see
+  :ref:`this entry in the FAQ <compass-faq-non-genuine>`.
 
 |compass| 1.18
 --------------