Merge branch 'master' into DOCSP-48356-skipwhile-takewhile

Author: rustagir

config/redirects

@@ -1,6 +1,6 @@
 define: prefix docs/drivers/csharp
 define: base https://www.mongodb.com/${prefix}
-define: versions v2.19 v2.20 v2.21 v2.22 v2.23 v2.24 v2.25 v2.26 v2.27 v2.28 v2.29 v2.30 v3.0 v3.1 master
+define: versions v2.19 v2.20 v2.21 v2.22 v2.23 v2.24 v2.25 v2.26 v2.27 v2.28 v2.29 v2.30 v3.0 v3.1 v3.2 v3.3 master
 
 symlink: current -> master
 

snooty.toml

@@ -34,7 +34,7 @@ mdb-server = "MongoDB Server"
 mongo-community = "MongoDB Community Edition"
 mongo-enterprise = "MongoDB Enterprise Edition"
 docs-branch = "master"                                                                                          # always set this to the docs branch (i.e. master, 1.7, 1.8, etc.)
-version-number = "3.2"
+version-number = "3.3"
 last-version-2-number = "2.30"
 version = "v{+version-number+}"
 example = "https://raw.githubusercontent.com/mongodb/docs-csharp/{+docs-branch+}/source/includes/code-examples"

source/fundamentals/atlas-search.txt

@@ -48,18 +48,11 @@ The examples in this guide use the following documents in a collection called
 
 The following ``Guitar`` class models the documents in this collection.
 
-.. code-block:: csharp
-
-   public class Guitar
-   {
-       public int Id { get; set; }
-       public string Make { get; set; }
-       public List<string> Models { get; set; }
-       public int EstablishedYear { get; set; }
-       [BsonElement("in_stock")]
-       public bool InStock { get; set; }
-       public int? Rating { get; set; }
-   }
+.. literalinclude:: /includes/fundamentals/code-examples/atlas-search/AtlasSearchExamples.cs
+   :start-after: // start-guitar-class
+   :end-before: // end-guitar-class
+   :language: csharp
+   :dedent:
 
 .. note::
 
@@ -709,3 +702,116 @@ The search returns the following document:
 
 To learn more about the ``wildcard`` operator, see the :atlas:`wildcard </atlas-search/wildcard>` 
 Atlas guide.
+
+Modify Atlas Search Behavior
+----------------------------
+
+You can modify the behavior of the ``Search()`` method by passing
+a ``SearchOptions`` object as a parameter.
+
+The ``SearchOptions`` class contains the following properties:
+
+.. list-table::
+   :widths: 30 70
+   :header-rows: 1
+
+   * - Property
+     - Description
+
+   * - ``CountOptions`` 
+     - | The options for counting the search results.
+
+       | **Data type**: `SearchCountOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.SearchCountOptions.html>`__
+       | **Default**: ``null``
+
+   * - ``Highlight`` 
+     - | The options for displaying search terms in their original context.
+
+       | **Data type**: `SearchHighlightOptions<TDocument> <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.SearchHighlightOptions-1.html>`__
+       | **Default**: ``null``
+
+   * - ``IndexName`` 
+     - | The index to use for the search.
+
+       | **Data type**: {+string-data-type+}
+       | **Default**: ``null``
+
+   * - ``ReturnStoredSource`` 
+     - | A flag that specifies whether to perform a full document lookup on
+         the database or to return only stored source fields directly from
+         Atlas Search.
+
+       | **Data type**: {+bool-data-type+}
+       | **Default**: ``false``
+
+   * - ``ScoreDetails`` 
+     - | A flag that specifies whether to return detailed information about the
+         score for each document in the results.
+
+       | **Data type**: {+bool-data-type+}
+       | **Default**: ``false``
+
+   * - ``SearchAfter`` 
+     - | The starting point for pagination. When set, the search retrieves documents
+         starting immediately after the specified reference point.
+
+       | **Data type**: {+string-data-type+}
+       | **Default**: ``null``
+
+   * - ``SearchBefore`` 
+     - | The end point for pagination. When set, the search retrieves documents
+         starting immediately before the specified reference point.
+
+       | **Data type**: {+string-data-type+}
+       | **Default**: ``null``
+
+   * - ``Sort`` 
+     - | The sorting criteria to apply to the results.
+
+       | **Data type**: `SortDefinition<TDocument> <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.SortDefinition-1.html>`__
+       | **Default**: ``null``
+
+   * - ``Tracking`` 
+     - | The options for tracking search terms.
+
+       | **Data type**: `SearchTrackingOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.SearchTrackingOptions.html>`__
+       | **Default**: ``null``
+
+SearchAfter Example
+~~~~~~~~~~~~~~~~~~~
+
+The following example paginates the results of an Atlas Search
+operation by performing the following actions:
+
+- Defines a projection that uses the ``MetaSearchSequenceToken()``
+  builder method, which specifies a ``PaginationToken`` to contain
+  the point of reference
+
+- Creates a ``SearchOptions`` instance and sets the index and sort
+  criteria to use
+
+- Runs an initial search to find documents that have a ``description`` field value containing
+  the text ``"classic"``, applying the projection and options to the operation
+
+- Sets the ``SearchAfter`` property of the same ``SearchOptions`` instance to
+  instruct the next search to begin after the base search's first result
+
+- Runs another search operation that has the same matching criteria and applies
+  the search options to paginate the results
+
+.. literalinclude:: /includes/fundamentals/code-examples/atlas-search/AtlasSearchExamples.cs
+   :start-after: // start-pagination-options
+   :end-before: // end-pagination-options
+   :language: csharp
+   :dedent:
+
+The search returns the following document:
+
+.. code-block:: json
+
+   { "_id": 2, "make": "Gibson", "description": "Classic guitars known for their rich, full tones.", "establishedYear": 1902, "in_stock": true, "rating": 8 }
+
+.. tip::
+
+   To learn more about Atlas Search pagination, see :atlas:`Paginate the Results </atlas-search/paginate-results/>` 
+   in the Atlas documentation.

source/fundamentals/builders.txt

@@ -99,6 +99,8 @@ to a LINQ query:
    var filter = builder.Lt("Price", 20) & builder.Eq("Category", "Perennial");
    var query = collection.AsQueryable().Where(f => filter.Inject());
 
+.. _csharp-builders-array-operators:
+
 Array Operators
 ~~~~~~~~~~~~~~~
 

source/fundamentals/connection/connect.txt

@@ -154,3 +154,7 @@ hosts, including ``sample.host1``:
    :language: csharp
    :start-after: // start replica set connection
    :end-before: // end replica set connection
+
+.. note:: Replica Set in Docker
+
+   .. sharedinclude:: dbx/docker-replica-set.rst

source/fundamentals/crud/read-operations/change-streams.txt

@@ -65,20 +65,11 @@ classes:
 - ``Collection``: To monitor changes in the collection
 
 The following example opens a change stream on the ``restaurants`` collection
-and outputs the changes as they occur. Select the
-:guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to see the corresponding
-code.
+and outputs the changes as they occur. Select the :guilabel:`Synchronous` or
+:guilabel:`Asynchronous` tab to see the corresponding code.
 
 .. tabs::
 
-   .. tab:: Asynchronous
-      :tabid: change-stream-async
-
-      .. literalinclude:: /includes/code-examples/change-streams/change-streams.cs
-         :start-after: start-open-change-stream-async
-         :end-before: end-open-change-stream-async
-         :language: csharp
-
    .. tab:: Synchronous
       :tabid: change-stream-sync
 
@@ -87,6 +78,14 @@ code.
          :end-before: end-open-change-stream
          :language: csharp
 
+   .. tab:: Asynchronous
+      :tabid: change-stream-async
+
+      .. literalinclude:: /includes/code-examples/change-streams/change-streams.cs
+         :start-after: start-open-change-stream-async
+         :end-before: end-open-change-stream-async
+         :language: csharp
+
 To begin watching for changes, run the application. Then, in a separate
 application or shell, modify the ``restaurants`` collection. Updating a document
 that has a ``"name"`` value of ``"Blarney Castle"`` results in the following
@@ -134,20 +133,12 @@ You can specify the following aggregation stages in the ``pipeline`` parameter:
 Monitor Update Events Example
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The following example uses the ``pipeline`` parameter to open a change stream
-that records only update operations. Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to see the
-corresponding code.
+The following example uses the ``pipeline`` parameter to open a change stream that records
+only update operations. Select the :guilabel:`Synchronous` or :guilabel:`Asynchronous` tab
+to see the corresponding code.
 
 .. tabs::
 
-   .. tab:: Asynchronous
-      :tabid: change-stream-async
-
-      .. literalinclude:: /includes/code-examples/change-streams/change-streams.cs
-         :start-after: start-change-stream-pipeline-async
-         :end-before: end-change-stream-pipeline-async
-         :language: csharp
-
    .. tab:: Synchronous
       :tabid: change-stream-sync
 
@@ -156,6 +147,14 @@ corresponding code.
          :end-before: end-change-stream-pipeline
          :language: csharp
 
+   .. tab:: Asynchronous
+      :tabid: change-stream-async
+
+      .. literalinclude:: /includes/code-examples/change-streams/change-streams.cs
+         :start-after: start-change-stream-pipeline-async
+         :end-before: end-change-stream-pipeline-async
+         :language: csharp
+
 Split Large Change Events Example
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -173,14 +172,6 @@ reassemble any event fragments:
 
 .. tabs::
 
-   .. tab:: Asynchronous
-      :tabid: change-stream-split-async
-
-      .. literalinclude:: /includes/code-examples/change-streams/change-streams.cs
-         :start-after: start-split-change-event-async
-         :end-before: end-split-change-event-async
-         :language: csharp
-
    .. tab:: Synchronous
       :tabid: change-stream-split-sync
 
@@ -189,6 +180,14 @@ reassemble any event fragments:
          :end-before: end-split-change-event-sync
          :language: csharp
 
+   .. tab:: Asynchronous
+      :tabid: change-stream-split-async
+
+      .. literalinclude:: /includes/code-examples/change-streams/change-streams.cs
+         :start-after: start-split-change-event-async
+         :end-before: end-split-change-event-async
+         :language: csharp
+
 .. note::
 
    We recommend reassembling change event fragments, as shown in the 
@@ -202,6 +201,14 @@ The following code defines these methods:
 
 .. tabs::
 
+   .. tab:: Synchronous
+      :tabid: split-event-helpers-sync
+
+      .. literalinclude:: /includes/code-examples/change-streams/change-streams.cs
+         :start-after: start-split-event-helpers-sync
+         :end-before: end-split-event-helpers-sync
+         :language: csharp
+
    .. tab:: Asynchronous
       :tabid: split-event-helpers-async
 
@@ -210,14 +217,6 @@ The following code defines these methods:
          :end-before: end-split-event-helpers-async
          :language: csharp
 
-   .. tab:: Synchronous
-      :tabid: split-event-helpers-sync
-
-      .. literalinclude:: /includes/code-examples/change-streams/change-streams.cs
-         :start-after: start-split-event-helpers-sync
-         :end-before: end-split-event-helpers-sync
-         :language: csharp
-         
 .. tip::
 
    To learn more about splitting large change events, see
@@ -344,19 +343,11 @@ one of the following values:
 
 The following example opens a change stream on a collection and includes the post-image
 of updated documents by specifying the ``FullDocument`` option. Select the
-:guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to see the corresponding
+:guilabel:`Synchronous` or :guilabel:`Asynchronous` tab to see the corresponding
 code.
 
 .. tabs::
 
-   .. tab:: Asynchronous
-      :tabid: change-stream-async
-
-      .. literalinclude:: /includes/code-examples/change-streams/change-streams.cs
-         :start-after: start-change-stream-post-image-async
-         :end-before: end-change-stream-post-image-async
-         :language: csharp
-
    .. tab:: Synchronous
       :tabid: change-stream-sync
 
@@ -365,6 +356,14 @@ code.
          :end-before: end-change-stream-post-image
          :language: csharp
 
+   .. tab:: Asynchronous
+      :tabid: change-stream-async
+
+      .. literalinclude:: /includes/code-examples/change-streams/change-streams.cs
+         :start-after: start-change-stream-post-image-async
+         :end-before: end-change-stream-post-image-async
+         :language: csharp
+
 Running the preceding code example and updating a document that has a ``"name"``
 value of ``"Blarney Castle"`` results in the following change stream output: