Skip to content

Commit f0cd039

Browse files
committed
PHPLIB-851: Queryable encryption support for create/drop collection helpers
1 parent 70b3ab6 commit f0cd039

4 files changed

+48
-3
lines changed

source/includes/apiargs-MongoDBCollection-method-drop-option.yaml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
source:
2-
file: apiargs-MongoDBCollection-common-option.yaml
3-
ref: typeMap
2+
file: apiargs-dropCollection-option.yaml
3+
ref: encryptedFields
44
post: |
5-
This will be used for the returned command result document.
5+
.. versionadded:: 1.13
66
---
77
source:
88
file: apiargs-common-option.yaml
99
ref: session
1010
post: |
1111
.. versionadded:: 1.3
1212
---
13+
source:
14+
file: apiargs-MongoDBCollection-common-option.yaml
15+
ref: typeMap
16+
post: |
17+
This will be used for the returned command result document.
18+
---
1319
source:
1420
file: apiargs-MongoDBCollection-common-option.yaml
1521
ref: writeConcern

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,24 @@ pre: |
6868
</reference/bson-type-comparison-order/#collation>` for the collection.
6969
---
7070
arg_name: option
71+
name: encryptedFields
72+
type: document
73+
description: |
74+
A document describing encrypted fields for queryable encryption. If omitted,
75+
the ``encryptedFieldsMap`` option within the ``autoEncryption`` driver option
76+
will be consulted. See the
77+
`Client Side Encryption specification <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst>`_
78+
for more information.
79+
80+
This option is available in MongoDB 6.0+ and will result in an exception at
81+
execution time if specified for an older server version.
82+
83+
.. versionadded:: 1.13
84+
interface: phpmethod
85+
operation: ~
86+
optional: true
87+
---
88+
arg_name: option
7189
name: expireAfterSeconds
7290
type: integer
7391
description: |

source/includes/apiargs-MongoDBDatabase-method-dropCollection-option.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
source:
2+
file: apiargs-dropCollection-option.yaml
3+
ref: encryptedFields
4+
post: |
5+
.. versionadded:: 1.13
6+
---
17
source:
28
file: apiargs-common-option.yaml
39
ref: session
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
arg_name: option
2+
name: encryptedFields
3+
type: array|object
4+
description: |
5+
A document describing encrypted fields for queryable encryption. If omitted,
6+
the ``encryptedFieldsMap`` option within the ``autoEncryption`` driver option
7+
will be consulted. If ``encryptedFieldsMap`` was defined but does not specify
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.
12+
interface: phpmethod
13+
operation: ~
14+
optional: true
15+
...

0 commit comments

Comments
 (0)