Skip to content

Commit 0b511a0

Browse files
committed
Update docs for ListCollections filter option
1 parent e7790d8 commit 0b511a0

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ type: array|object
44
description: |
55
A query expression to filter the list of collections.
66
7-
You can specify a query expression on the collection ``name`` and ``options``.
7+
You can specify a query expression for collection fields (e.g. ``name``,
8+
``options``).
9+
10+
For server versions < 3.0, the filter can only be used to match the ``name``
11+
field with a string value. More complex filters will result in an exception at
12+
execution time if used.
813
interface: phpmethod
914
operation: ~
1015
optional: true

src/Operation/ListCollections.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ class ListCollections implements Executable
4949
*
5050
* * filter (document): Query by which to filter collections.
5151
*
52+
* For server versions < 3.0, the filter can only be used to match the
53+
* "name" field with a string value. More complex filters will result in
54+
* an exception at execution time if used.
55+
*
5256
* * maxTimeMS (integer): The maximum amount of time to allow the query to
5357
* run.
5458
*

0 commit comments

Comments
 (0)