Skip to content

Commit 94e8b16

Browse files
authored
Update docs for encryptedFields create/drop collection option (#1054)
The MongoDB manual reference is more helpful than the CSFLE specification. Additionally, clarify how the option is used by the drop collection helpers.
1 parent ea3a1a7 commit 94e8b16

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

docs/includes/apiargs-MongoDBDatabase-method-createCollection-option.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ type: document
8282
description: |
8383
A document describing encrypted fields for queryable encryption. If omitted,
8484
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.
8888
8989
This option is available in MongoDB 6.0+ and will result in an exception at
9090
execution time if specified for an older server version.

docs/includes/apiargs-dropCollection-option.yaml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,15 @@ description: |
66
the ``encryptedFieldsMap`` option within the ``autoEncryption`` driver option
77
will be consulted. If ``encryptedFieldsMap`` was defined but does not specify
88
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.
1218
1319
.. note::
1420

0 commit comments

Comments
 (0)