Skip to content

Commit ab0a465

Browse files
authored
DOCSP-31467 - Node driver FLE requirements (#11704)
1 parent 55700ef commit ab0a465

File tree

3 files changed

+28
-29
lines changed

3 files changed

+28
-29
lines changed

source/core/queryable-encryption/reference/compatibility.txt

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.. _qe-csfle-compatibility:
66

77
=============
8-
Compatibility
8+
Compatibility
99
=============
1010

1111
.. meta::
@@ -17,7 +17,7 @@ Compatibility
1717
:depth: 2
1818
:class: singlecol
1919

20-
This page describes the MongoDB editions and driver versions compatible
20+
This page describes the MongoDB editions and driver versions compatible
2121
with {+qe+} and {+csfle+} to help you determine whether your deployment
2222
supports each in-use encryption feature.
2323

@@ -87,31 +87,28 @@ compatible MongoDB drivers:
8787

8888
.. include:: /includes/installation/libmongocrypt-csharp.txt
8989

90-
* - :driver:`Go </go>`
90+
* - :driver:`Go </go>`
9191
- 1.12
9292
- :ref:`libmongocrypt <qe-reference-libmongocrypt>` version 1.8.0
9393
or later.
94-
94+
9595
* - :driver:`Java Sync </java/sync>` and `Java Reactive
9696
Streams <https://www.mongodb.com/docs/languages/java/reactive-streams-driver/current/>`__
9797
- 4.10.0
9898
- `mongodb-crypt <https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__ version 1.8.0 or later
99-
99+
100100
* - :driver:`Node.js </node>`
101101
- 5.5.0
102102
- `mongodb-client-encryption <https://www.npmjs.com/package/mongodb-client-encryption/>`__
103103
version 2.8.0 or later.
104104

105-
Node 6.0.0 or later requires ``mongodb-client-encryption`` with the
106-
same major version number as the Node.js driver. For example,
107-
Node.js driver v6.x.x requires ``mongodb-client-encryption``
108-
v6.x.x.
109-
110-
* - :driver:`PHP </php>`
105+
.. include:: /includes/installation/libmongocrypt-node.txt
106+
107+
* - :driver:`PHP </php>`
111108
- 1.16
112109
- No additional dependency.
113110

114-
* - :driver:`PyMongo </python>`
111+
* - :driver:`PyMongo </python>`
115112
- 4.4
116113
- `pymongocrypt <https://pypi.org/project/pymongocrypt/>`__ version
117114
1.6 or later.
@@ -124,7 +121,7 @@ compatible MongoDB drivers:
124121
- 2.4.0
125122
- :ref:`libmongocrypt <qe-reference-libmongocrypt>` version 1.8.0
126123
or later.
127-
124+
128125
* - :driver:`Scala </scala>`
129126
- 4.10.0
130127
- `mongodb-crypt <https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__ version 1.8.0 or later
@@ -135,12 +132,12 @@ MongoDB Support Limitations
135132
.. include:: /includes/queryable-encryption/qe-supportability.rst
136133

137134
.. _csfle-compatibility-reference:
138-
135+
139136
{+csfle+} Compatibility
140137
------------------------------------------------------------------------
141138

142-
You can use {+csfle+} ({+csfle-abbrev+}) replica set or sharded cluster, but not
143-
a standalone instance. The following table shows which MongoDB server products
139+
You can use {+csfle+} ({+csfle-abbrev+}) replica set or sharded cluster, but not
140+
a standalone instance. The following table shows which MongoDB server products
144141
support which {+csfle+} mechanisms:
145142

146143
.. list-table::
@@ -153,11 +150,11 @@ support which {+csfle+} mechanisms:
153150
- Supports {+csfle-abbrev+} with {+manual-enc-title+}
154151

155152
* - MongoDB Atlas
156-
- :atlas:`All supported MongoDB versions </reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use->`
153+
- :atlas:`All supported MongoDB versions </reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use->`
157154
- Yes
158155
- Yes
159156

160-
* - MongoDB Enterprise Advanced
157+
* - MongoDB Enterprise Advanced
161158
- 4.2
162159
- Yes
163160
- Yes
@@ -175,7 +172,7 @@ support which {+csfle+} mechanisms:
175172
compatible MongoDB drivers.
176173

177174
.. important:: Key Rotation Support
178-
175+
179176
To use the Key Rotation API, you must use specific versions
180177
of either your driver's binding package or ``libmongocrypt``.
181178

@@ -197,7 +194,7 @@ compatible MongoDB drivers.
197194
- 3.6.0
198195
- No additional requirements.
199196

200-
* - :driver:`C#/.NET </csharp>`
197+
* - :driver:`C#/.NET </csharp>`
201198
- 2.10.0
202199
- Driver version 2.17.1 or later.
203200

@@ -211,25 +208,25 @@ compatible MongoDB drivers.
211208
- 3.11.0
212209
- ``mongodb-crypt`` version {+mongodb-crypt-version+} or later.
213210

214-
* - `Java Reactive Streams <https://www.mongodb.com/docs/languages/java/reactive-streams-driver/current/>`__
211+
* - `Java Reactive Streams <https://www.mongodb.com/docs/languages/java/reactive-streams-driver/current/>`__
215212
- 1.12.0
216213
- ``mongodb-crypt`` version {+mongodb-crypt-version+} or later.
217214

218-
* - :driver:`Node.js </node>`
215+
* - :driver:`Node.js </node>`
219216
- 3.4.0
220-
- For driver version 6.0 or later, use the same ``mongodb-client-encryption``
221-
major version as the driver.
222-
Otherwise, use ``mongodb-client-encryption`` 2.2.0 - 2.x.
217+
- ``mongodb-client-encryption`` version 2.2.0 - 2.x.
218+
219+
.. include:: /includes/installation/libmongocrypt-node.txt
223220

224221
* - :driver:`PHP </php>`
225222
- 1.6.0
226223
- No additional requirements.
227224

228-
* - :driver:`Python (PyMongo) </pymongo>`
225+
* - :driver:`Python (PyMongo) </pymongo>`
229226
- 3.10.0
230227
- ``pymongocrypt`` version 1.3.1 or later.
231228

232-
* - `Ruby <https://docs.mongodb.com/ruby-driver/current/>`__
229+
* - `Ruby <https://docs.mongodb.com/ruby-driver/current/>`__
233230
- 2.12.1
234231
- No additional requirements.
235232

@@ -238,6 +235,6 @@ compatible MongoDB drivers.
238235
- :ref:`libmongocrypt <csfle-reference-libmongocrypt>` version 1.8.0
239236
or later.
240237

241-
* - :driver:`Scala </scala>`
238+
* - :driver:`Scala </scala>`
242239
- 2.7.0
243240
- No additional requirements.

source/includes/installation/libmongocrypt-csharp.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
If you are using driver version C#/.NET 3.0 or later, perform the following
1+
If you are using C#/.NET driver version 3.0 or later, perform the following
22
steps:
33

44
- Install the `MongoDB.Driver.Encryption <https://www.nuget.org/packages/MongoDB.Driver.Encryption>`_
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
If you're using version 6.0 or later of the Node.js driver, you must also use version
2+
6.0 or later of ``mongodb-client-encryption``.

0 commit comments

Comments
 (0)