DOCSP-47211-default-sort-order-setting

Author: ltran-mdb2

source/define-default-sort.txt

@@ -0,0 +1,62 @@
+.. _compass-sort-query-bar:
+
+======================
+Set Default Sort Order
+======================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+You can specify a default sort order documents that operations in the
+:ref:`query bar <compass-query-bar>` return. If you do not explicitly
+:ref:`specify a sort order in the query bar <compass-query-bar-sort>`, Compass
+applies the default sort order specified in the :guilabel:`Settings` panel. 
+
+About This Task
+---------------
+
+You can choose 1 of the following default sort options:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 80
+
+   * - Sort Key
+     - Description
+
+   * - $natural: 1 
+     - Sort in the natural order of documents
+
+   * - $natural: -1
+     - Sort in reverse natural order of documents
+
+   * - _id: 1
+     - Sort in ascending order by the ``_id`` field
+
+   * - _id: -1
+     - Sort in descending order by the ``_id`` field
+
+Procedure
+---------
+
+.. procedure:: 
+   :style: normal
+   
+   .. include:: includes/fact-navigate-to-settings.rst
+
+   .. step:: Open the :guilabel:`Default Sort for Query Bar` dropdown menu.
+
+   .. step:: Select the default sort order you would like to use.
+
+   .. step:: Click :guilabel:`Save`. 
+
+.. note:: 
+
+   If you do not specify a default sort order, Compass uses the MongoDB server
+   default sort order of ``$natural: 1``. 
+

source/query/sort.txt

@@ -16,6 +16,12 @@ Sort the Returned Documents
 If the query bar displays the :guilabel:`Sort` option, you can specify
 the sort order of the returned documents.
 
+.. note::
+
+   If you specify a sort order in the query bar, the specified sort order
+   overrides any :ref:`default sort order <compass-sort-query-bar>` you set
+   in :guilabel:`Settings`. 
+
 .. BEGIN-COMPASS-ONLY
 
 Compatibility

source/settings/settings-reference.txt

@@ -79,6 +79,12 @@ You can configure the following settings on the |compass| interface:
 
        To learn more, see :ref:`compass-protect-connection-strings`.
 
+   * - Default Sort for Query Bar
+     - General
+     - Defines how queries executed from the query bar sort results
+
+       To learn more, see :ref:`compass-sort-query-bar`. 
+
    * - Show Kerberos Password Field 
      - General
      - Show or hide the Kerberos password field on the |compass-short|