Skip to content

DOCS-8977: include filter param for db.getCollectionInfos() #3214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 1, 2018
Merged

DOCS-8977: include filter param for db.getCollectionInfos() #3214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/includes/apiargs-dbcommand-listCollections-field.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: |
A query expression to filter the list of collections.

You can specify a query expression on any of the :ref:`fields
returned <list-collection-output>` by :dbcommand:`listCollections`.
returned <list-collection-output>` by {{role}}.

interface: dbcommand
name: filter
Expand Down
11 changes: 11 additions & 0 deletions source/includes/apiargs-method-db.getCollectionInfos-param.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
arg_name: param
inherit:
file: apiargs-dbcommand-listCollections-field.yaml
ref: filter
name: filter
operation: db.getCollectionInfos
interface: method
optional: true
position: 1
type: document
...
9 changes: 7 additions & 2 deletions source/reference/method/db.getCollectionInfos.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ db.getCollectionInfos()
Definition
----------

.. method:: db.getCollectionInfos()
.. method:: db.getCollectionInfos(filter)

.. versionadded:: 3.0.0
.. versionadded:: 3.0

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

The :method:`db.getCollectionInfos()` method has the following
optional parameter:

.. include:: /includes/apiargs/method-db.getCollectionInfos-param.rst

.. versionchanged:: 3.2

MongoDB 3.2 added support for :doc:`document validation
Expand Down