From 51d232342728f904da772cc98f2553294c7deed7 Mon Sep 17 00:00:00 2001 From: Nick Larew Date: Fri, 6 Jul 2018 15:02:45 -0400 Subject: [PATCH] (DOCS-11858): clarify filter + nameOnly behavior in the listCollections dbcommand --- .../includes/apiargs-dbcommand-listCollections-field.yaml | 7 ++++++- source/reference/command/listCollections.txt | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/source/includes/apiargs-dbcommand-listCollections-field.yaml b/source/includes/apiargs-dbcommand-listCollections-field.yaml index 0dc865d7994..1ce95fca77d 100644 --- a/source/includes/apiargs-dbcommand-listCollections-field.yaml +++ b/source/includes/apiargs-dbcommand-listCollections-field.yaml @@ -21,10 +21,15 @@ description: | Returning just the name and type (``view`` or ``collection``) does not take collection-level locks whereas returning full collection information locks each collection in the database. - The default value is ``false``. + .. note:: + + When ``nameOnly`` is ``true``, your ``filter`` expression can only + filter based on a collection's name and type. No other fields are + available. + .. versionadded:: 4.0 interface: dbcommand diff --git a/source/reference/command/listCollections.txt b/source/reference/command/listCollections.txt index 2a890962519..af3b34dd6d0 100644 --- a/source/reference/command/listCollections.txt +++ b/source/reference/command/listCollections.txt @@ -98,7 +98,7 @@ Output - Type - Description - * - name + * - name - String - Name of the collection.