You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update docs for encryptedFields create/drop collection option (mongodb#1054)
The MongoDB manual reference is more helpful than the CSFLE specification. Additionally, clarify how the option is used by the drop collection helpers.
Copy file name to clipboardExpand all lines: docs/includes/apiargs-MongoDBDatabase-method-createCollection-option.yaml
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -82,9 +82,9 @@ type: document
82
82
description: |
83
83
A document describing encrypted fields for queryable encryption. If omitted,
84
84
the ``encryptedFieldsMap`` option within the ``autoEncryption`` driver option
85
-
will be consulted. See the
86
-
`Client Side Encryption specification <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst>`_
87
-
for more information.
85
+
will be consulted. See
86
+
`Field Encryption and Queryability <https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/encrypt-and-query/>`_
87
+
in the MongoDB manual for more information.
88
88
89
89
This option is available in MongoDB 6.0+ and will result in an exception at
90
90
execution time if specified for an older server version.
Copy file name to clipboardExpand all lines: docs/includes/apiargs-dropCollection-option.yaml
+9-3Lines changed: 9 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,15 @@ description: |
6
6
the ``encryptedFieldsMap`` option within the ``autoEncryption`` driver option
7
7
will be consulted. If ``encryptedFieldsMap`` was defined but does not specify
8
8
this collection, the library will make a final attempt to consult the
9
-
server-side value for ``encryptedFields``. See the
10
-
`Client Side Encryption specification <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst>`_
11
-
for more information.
9
+
server-side value for ``encryptedFields``. See
10
+
`Field Encryption and Queryability <https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/encrypt-and-query/>`_
11
+
in the MongoDB manual for more information.
12
+
13
+
.. note::
14
+
15
+
This option is not passed to the :manual:`drop </reference/command/drop>`
16
+
command. The library uses it to determine related metadata collections that
17
+
should be dropped in addition to an encrypted collection.
0 commit comments