Skip to content

Commit 98f160b

Browse files
authored
Merge pull request #185 from davemungo/DOCSP-16267-show-collection-type
DOCSP-16267 show collection type
2 parents 98f98d7 + 85d2454 commit 98f160b

File tree

2 files changed

+39
-165
lines changed

2 files changed

+39
-165
lines changed

source/help.txt

Lines changed: 0 additions & 152 deletions
This file was deleted.

source/reference/access-mdb-shell-help.txt

Lines changed: 39 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,29 @@ To see the list of collections in the current database, use the
182182

183183
show collections
184184

185+
The ``show collections`` output indicates if a collection is a
186+
:ref:`time series collection <manual-timeseries-collection>` or a
187+
read-only :ref:`view <views-landing-page>`.
188+
189+
.. code-block:: javascript
190+
:copyable: false
191+
192+
managementFeedback [view]
193+
survey
194+
weather [time-series]
195+
system.buckets.weather
196+
system.views
197+
198+
In the preceding example:
199+
200+
- ``managementFeedback`` is a :ref:`view <views-landing-page>`
201+
- ``weather`` is a time series
202+
- ``survey`` is a collection
203+
- ``system.buckets.weather`` is a system generated collection
204+
that supports the ``weather`` time series
205+
- ``system.views`` is a system generated collection that supports
206+
views on other collections
207+
185208
Show Collection Methods
186209
~~~~~~~~~~~~~~~~~~~~~~~
187210

@@ -364,17 +387,17 @@ certain database commands and obtain information on your deployment:
364387
- Description
365388

366389
* - ``db.help()``
367-
- Show help for database methods.
390+
- Display help for database methods.
368391

369392
* - ``db.<collection>.help()``
370-
- Show help on collection methods. The ``<collection>`` can be the
371-
name of an existing collection or a non-existing collection.
393+
- Display help on collection methods. The ``<collection>`` can be
394+
the name of an existing collection or a non-existing collection.
372395

373396
* - ``help``
374-
- Show help.
397+
- Display help.
375398

376399
* - ``show collections``
377-
- Display a list of all collections for current database
400+
- Display a list of all collections for current database.
378401

379402
* - ``show dbs``
380403
- Display a list of all databases on the server.
@@ -388,20 +411,15 @@ certain database commands and obtain information on your deployment:
388411
logger name. If you do not specify a ``<name>``, the command
389412
defaults to ``global``.
390413

391-
.. example::
392-
393-
To show ``startupWarning`` logs, run:
414+
To show ``startupWarning`` logs, run:
394415

395-
.. code-block:: sh
416+
.. code-block:: sh
396417

397-
show log startupWarnings
418+
show log startupWarnings
398419

399420
* - ``show logs``
400421
- Display the accessible logger names. See :doc:`/logs`.
401422

402-
* - ``show users``
403-
- Display a list of users for current database.
404-
405423
* - ``show profile``
406424
- Display the five most recent operations that took 1 millisecond or
407425
more. See documentation on the
@@ -412,3 +430,11 @@ certain database commands and obtain information on your deployment:
412430
- Display a list of all roles, both user-defined and built-in, for
413431
the current database.
414432

433+
* - ``show tables``
434+
- Display a list of collections in the current database. See ``show
435+
collections``.
436+
437+
* - ``show users``
438+
- Display a list of users for current database.
439+
440+

0 commit comments

Comments
 (0)