Skip to content

Commit b286c10

Browse files
schmallisokay-kim
authored andcommitted
DOCS-8977: include filter param for db.getCollectionInfos()
1 parent 04c9ebd commit b286c10

File tree

3 files changed

+19
-3
lines changed

3 files changed

+19
-3
lines changed

source/includes/apiargs-dbcommand-listCollections-field.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: |
33
A query expression to filter the list of collections.
44
55
You can specify a query expression on any of the :ref:`fields
6-
returned <list-collection-output>` by :dbcommand:`listCollections`.
6+
returned <list-collection-output>` by {{role}}.
77
88
interface: dbcommand
99
name: filter
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
arg_name: param
2+
inherit:
3+
file: apiargs-dbcommand-listCollections-field.yaml
4+
ref: filter
5+
name: filter
6+
operation: db.getCollectionInfos
7+
interface: method
8+
optional: true
9+
position: 1
10+
type: document
11+
...

source/reference/method/db.getCollectionInfos.txt

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ db.getCollectionInfos()
1313
Definition
1414
----------
1515

16-
.. method:: db.getCollectionInfos()
16+
.. method:: db.getCollectionInfos(filter)
1717

18-
.. versionadded:: 3.0.0
18+
.. versionadded:: 3.0
1919

2020
Returns an array of documents with collection or :doc:`view
2121
</core/views>` information, such as name and options, for
@@ -24,6 +24,11 @@ Definition
2424
The :method:`db.getCollectionInfos()` helper wraps the
2525
:dbcommand:`listCollections` command.
2626

27+
The :method:`db.getCollectionInfos()` method has the following
28+
optional parameter:
29+
30+
.. include:: /includes/apiargs/method-db.getCollectionInfos-param.rst
31+
2732
.. versionchanged:: 3.2
2833

2934
MongoDB 3.2 added support for :doc:`document validation

0 commit comments

Comments
 (0)