Merge branch 'master' into DOCSP-45715-sealed-classes

Author: mcmorisi

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 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 master
 
 symlink: current -> master
 

snooty.toml

@@ -32,7 +32,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.0"
+version-number = "3.1"
 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/serialization/polymorphic-objects.txt

@@ -156,7 +156,19 @@ you must explicitly list each class you're looking for:
 .. code-block:: csharp
    :copyable: true
 
-   var query = coll.Aggregate().Match(a => a is Cat || a is Lion || a is Tiger);
+   var query = coll.AsQueryable().Where(
+       item => item.GetType() == typeof(Cat) ||
+       item.GetType() == typeof(Lion) ||
+       item.GetType() == typeof(Tiger));
+
+.. note:: OfType<T>() and the is Operator
+
+   When checking the type of a scalar discriminator, use the ``Where`` syntax shown in
+   the preceding code example. If you try to use the ``Aggregate().OfType<T>()`` method,
+   or if you pass an expression containing the ``is`` operator to the
+   ``Aggregate().Match()`` method, the driver throws an exception.
+
+.. _csharp-discriminator-hierarchical:
 
 HierarchicalDiscriminatorConvention
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

source/includes/language-compatibility-table-csharp.rst

@@ -14,7 +14,7 @@
      - .NET Core 3.X
      - .NET Core 2.X
 
-   * - 3.0
+   * - 3.0 to 3.1
      - ✓
      - ✓
      - ✓
@@ -45,7 +45,7 @@
      - .NET 4.7 [#2.14-note]_
      - .NET 4.6
 
-   * - 3.0
+   * - 3.0 to 3.1
      - ✓
      - ✓
      - 

source/includes/mongodb-compatibility-table-csharp.rst

@@ -17,7 +17,7 @@
      - MongoDB 3.0
      - MongoDB 2.6
 
-   * - 3.0
+   * - 3.0 to 3.1
      - ✓
      - ✓
      - ✓

source/upgrade/v3.txt

@@ -203,7 +203,38 @@ Version 3.0 Breaking Changes
     property instead.
 
 - The driver removes individual cluster events from ``MongoClient.Cluster``. To listen for
-  cluster events, use `ClusterBuilder.Subscribe() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ClusterBuilder.Subscribe.html>`__.
+  cluster events, call the `ClusterBuilder.Subscribe() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ClusterBuilder.Subscribe.html>`__
+  method.
+
+- If any type in a collection uses a scalar discriminator, the driver throws
+  an exception if you perform either of the following actions on the collection:
+  
+  - Call the ``Aggregate().OfType<T>()`` method, as in the following example:
+
+    .. code-block:: csharp
+
+       collection.Aggregate().OfType<T>()
+
+  - Call the ``Aggregate().Match(item => item is T)`` method, as in the following example:
+
+    .. code-block:: csharp
+
+       collection.Aggregate().Match(item => item is T)
+  
+  To use either of the preceding methods on a collection, you can apply a hierarchical
+  discriminator to each class in the collection. See
+  the :ref:`Polymorphic Objects <csharp-discriminator-hierarchical>`
+  page to learn how.
+
+  Alternatively, you can check each item's type in a different way. For example, you
+  can call the ``Where()`` method and pass an expression that compares the item's type
+  to the type you're looking for, as in the following example:
+
+  .. code-block:: csharp
+
+     collection.AsQueryable().Where(item => item.GetType() == typeof(T));
+
+  To learn more about type discriminators, see :ref:`<csharp-polymorphism>`.
 
 - The driver has sealed some types that were not designed for extension by using inheritance.
   This includes the following changes:
@@ -213,4 +244,4 @@ Version 3.0 Breaking Changes
 
   - The driver seals the ``MongoClient``, ``MongoDatabase``, and ``MongoCollection`` classes.
     We recommend using the ``IMongoClient``, ``IMongoDatabase``, and ``IMongoCollection``
-    interfaces directly.
+    interfaces directly.

source/whats-new.txt

@@ -15,10 +15,11 @@ What's New
    :values: reference
 
 .. meta::
-   :keywords: update, new feature, deprecation, upgrade, driver v2.19, driver v2.20, driver v2.21, driver v2.22, driver v2.23, driver v2.24, driver v2.25, driver v2.26, driver v2.27, driver v2.28, driver v3.0
+   :keywords: update, new feature, deprecation, upgrade, driver v2.22, driver v2.23, driver v2.24, driver v2.25, driver v2.26, driver v2.27, driver v2.28, driver v3.0
 
 Learn what's new in:
 
+* :ref:`Version 3.1 <csharp-version-3.1>`
 * :ref:`Version 3.0 <csharp-version-3.0>`
 * :ref:`Version 2.30 <csharp-version-2.30>`
 * :ref:`Version 2.29 <csharp-version-2.29>`
@@ -29,10 +30,42 @@ Learn what's new in:
 * :ref:`Version 2.24 <version-2.24>`
 * :ref:`Version 2.23 <version-2.23>`
 * :ref:`Version 2.22 <version-2.22>`
-* :ref:`Version 2.21 <version-2.21>`
 
 .. _upcoming-breaking-changes:
 
+.. _csharp-version-3.1:
+
+What's New in 3.1
+-----------------
+
+The 3.1 driver release includes the following new features:
+
+- Adds new default serializers for immutable collections in the
+  `System.Collections.Immutable <https://learn.microsoft.com/en-us/dotnet/api/system.collections.immutable?view=net-8.0>`__
+  namespace. The driver can now serialize ``ImmutableArray`` objects, and serialization
+  for other immutable collections is more memory efficient.
+
+- Adds support for the token field type and array field expressions with Atlas Search
+  builders for the ``equals`` operator. To learn more about using Atlas Search with the
+  {+driver-short+}, see :ref:`csharp-atlas-search`.
+
+- Adds support for sequential pagination in Atlas Search.
+
+- Adds support for valid SRV hostnames with fewer than 3 parts.
+
+- Adds support for the ``Exists``, ``IsMissing``, and ``IsNullOrMissing`` methods
+  in MongoDB Query API filters.
+
+- Adds support for Exact Nearest Neighbor (ENN) vector search. To learn more about ENN
+  Vector Search, see :atlas:`Run Vector Search Queries </atlas-vector-search/vector-search-stage>`
+  in the Atlas Search documentation.
+
+- Adds support for the ``sort`` option to be passed to update commands. To learn more about
+  using update commands with the {+driver-short+}, see :ref:`csharp-change-guide`.
+
+For more information about this release, see the :github:`v3.1 release notes
+</mongodb/mongo-csharp-driver/releases/tag/v3.1.0>`.
+
 .. _csharp-version-3.0:
 
 What's New in 3.0