Skip to content

Commit b29563b

Browse files
author
Chris Cho
authored
DOCSP-32130: v2.21 updates (#110)
* DOCSP-32130: v2.21 updates
1 parent 74c9c5c commit b29563b

File tree

6 files changed

+77
-15
lines changed

6 files changed

+77
-15
lines changed

config/redirects

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
define: prefix docs/drivers/csharp
22
define: base https://www.mongodb.com/${prefix}
3-
define: versions 2.19 2.20 master
3+
define: versions 2.19 2.20 2.21 master
44

55
raw: ${prefix}/ -> ${base}/current/
66
raw: ${prefix}/stable -> ${base}/current/

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ language = "C#"
2525
mongo-community = "MongoDB Community Edition"
2626
mongo-enterprise = "MongoDB Enterprise Edition"
2727
docs-branch = "master" # always set this to the docs branch (i.e. master, 1.7, 1.8, etc.)
28-
version-number = "2.20" # always set this to the driver branch (i.e. 1.7.0, 1.8.0, etc.)
28+
version-number = "2.21" # always set this to the driver branch (i.e. 1.7.0, 1.8.0, etc.)
2929
version = "v{+version-number+}"
3030
example = "https://raw.githubusercontent.com/mongodb/docs-csharp/{+docs-branch+}/source/includes/code-examples"
3131
stable-api = "Stable API"

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@
1616
- .NET 4.7 [#2.14-note]_
1717
- .NET 4.6
1818
- .NET 4.5 [#4.5.2]_
19+
* - 2.21
20+
- ✓
21+
- ✓
22+
- ✓
23+
- ✓
24+
- ✓
25+
- ✓
26+
-
27+
-
28+
- ✓
29+
- ✓
30+
-
31+
-
1932
* - 2.20
2033
- ✓
2134
- ✓

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

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@
1616
- MongoDB 3.2
1717
- MongoDB 3.0
1818
- MongoDB 2.6
19+
* - 2.21
20+
- ✓
21+
- ✓
22+
- ✓
23+
- ✓
24+
- ✓
25+
- ✓
26+
- ✓
27+
- ✓
28+
-
29+
-
30+
-
31+
-
1932
* - 2.20
2033
- ✓
2134
- ✓
@@ -28,7 +41,7 @@
2841
-
2942
-
3043
-
31-
-
44+
-
3245
* - 2.19
3346
- ⊛
3447
- ✓
@@ -41,7 +54,7 @@
4154
-
4255
-
4356
-
44-
-
57+
-
4558
* - 2.18
4659
- ⊛
4760
- ✓
@@ -302,5 +315,5 @@
302315
-
303316
- ✓
304317
- ✓
305-
318+
306319
The driver doesn't support older versions of MongoDB.

source/upgrade.txt

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,31 @@ changes between the current and upgrade versions. For example, if you
5050
are upgrading the driver from v2.0 to v2.20, address all breaking changes from
5151
the version after v2.0 including any listed under v2.20.
5252

53+
.. _csharp-breaking-changes-2.21.0:
54+
55+
Version 2.21.0 Breaking Changes
56+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
57+
58+
- The function signature of ``Render`` methods in the Atlas Search builders
59+
changed. The following code snippet shows the function signature prior
60+
to the change and after the change:
61+
62+
.. code-block:: csharp
63+
64+
// Render function signature prior to v2.21.0
65+
Render(IBsonSerializer<TDocument> documentSerializer, IBsonSerializerRegistry serializerRegistry);
66+
67+
// Render function signature in v2.21.0 and later
68+
Render(SearchDefinitionRenderContext<TDocument> renderContext);
69+
5370
Version 2.19.0 Breaking Changes
5471
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5572

5673
- The ``ObjectSerializer`` only allows deserialization of
5774
types that are considered safe. If not specified otherwise, the
5875
``ObjectSerializer`` uses the types returned by
59-
``ObjectSerializer.DefaultAllowedTypes``.
60-
76+
``ObjectSerializer.DefaultAllowedTypes``.
77+
6178
To learn more about the ``ObjectSerializer``, visit the
6279
:ref:`FAQ <csharp-faq-object-serializer>`. For more information on
6380
``DefaultAllowedTypes``, visit the `API Documentation
@@ -66,9 +83,9 @@ Version 2.19.0 Breaking Changes
6683
- The default ``LinqProvider`` has been changed to LINQ3. The ``LinqProvider``
6784
can be configured for LINQ2 in ``MongoClientSettings`` as shown in the
6885
following code example:
69-
86+
7087
.. code-block:: csharp
71-
88+
7289
var connectionString = "<connection string>";
7390
var clientSettings = MongoClientSettings
7491
.FromConnectionString(connectionString);
@@ -104,11 +121,11 @@ The driver discontinues support for a MongoDB Server version after it
104121
reaches end-of-life (EOL).
105122

106123
To learn more about the MongoDB support for EOL products see the `Legacy
107-
Support Policy <https://www.mongodb.com/support-policy/legacy>`__.
124+
Support Policy <https://www.mongodb.com/support-policy/legacy>`__.
108125

109126
To learn more about the compatibility between .NET/C# driver versions
110127
and MongoDB Server versions, visit the
111-
:ref:`Compatibility <csharp-compatibility-tables>` page.
128+
:ref:`Compatibility <csharp-compatibility-tables>` page.
112129

113130
Version 2.14 Release Support Changes
114131
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -120,4 +137,4 @@ Version 2.14 Release Support Changes
120137

121138
- :ref:`<3.6-upgrade-replica-set>`
122139
- :ref:`<3.6-upgrade-standalone>`
123-
- :ref:`<3.6-upgrade-sharded-cluster>`
140+
- :ref:`<3.6-upgrade-sharded-cluster>`

source/whats-new.txt

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,33 @@ What's New
1212

1313
Learn what's new in:
1414

15+
* :ref:`Version 2.21 <version-2.21>`
1516
* :ref:`Version 2.20 <version-2.20>`
1617
* :ref:`Version 2.19 <version-2.19>`
1718

1819
.. _upcoming-breaking-changes:
1920

21+
.. _version-2.21:
22+
23+
What's New in 2.21
24+
------------------
25+
26+
.. warning:: Breaking changes in v2.21
27+
28+
The v2.21 driver contains breaking changes. See :ref:`<csharp-breaking-changes-2.21.0>`
29+
for more information.
30+
31+
The 2.21 driver release includes the following new features:
32+
33+
- Improvements and bug fixes to the LINQ3 integration.
34+
- Accepts options for Atlas Search sorting, tracking, and scoring.
35+
- Supports the Atlas Search :atlas:`embeddedDocument </atlas-search/embedded-document/>` operator.
36+
- Offers an API for Atlas Search index management.
37+
- Accepts anonymous types in the ``ObjectSerializer.DefaultAllowedTypes`` method.
38+
2039
.. _version-2.20:
2140

22-
What's New in 2.20
41+
What's New in 2.20
2342
------------------
2443

2544
The 2.20 driver release includes the following new features:
@@ -32,12 +51,12 @@ The 2.20 driver release includes the following new features:
3251

3352
.. _version-2.19:
3453

35-
What's New in 2.19
54+
What's New in 2.19
3655
------------------
3756

3857
The 2.19 driver release includes the following new features:
3958

40-
- The ``ObjectSerializer`` allows deserialization of only safe types, as determined by
59+
- The ``ObjectSerializer`` allows deserialization of only safe types, as determined by
4160
the configurable ``AllowedTypes`` function.
4261
- Changed the default ``LinqProvider`` to LINQ3.
4362
- Added Atlas Search (``$search``) support to builders, aggregation pipelines, and LINQ3.

0 commit comments

Comments
 (0)