@@ -8,9 +8,12 @@ name: scale
8
8
type : number
9
9
position : 1
10
10
description : |
11
- Identical to the scalar parameter of the same name.
11
+ The scale used in the output to display the sizes of items. By
12
+ default, output displays sizes in bytes. To display kilobytes rather
13
+ than bytes, specify a ``scale`` value of ``1024``.
12
14
13
15
.. versionadded:: 2.8
16
+
14
17
---
15
18
object :
16
19
name : db.collection.stats
@@ -22,11 +25,13 @@ name: indexDetails
22
25
type : boolean
23
26
position : 2
24
27
description : |
25
- Specifies whether to display index details.
28
+ When ``true`` :method:`db.collection.stats()`` returns index details
29
+ in addition to the collection stats.
26
30
27
31
Defaults to ``false``.
28
32
29
33
.. versionadded:: 2.8
34
+
30
35
---
31
36
object :
32
37
name : db.collection.stats
@@ -38,10 +43,10 @@ name: indexDetailsField
38
43
type : document
39
44
position : 3
40
45
description : |
41
- Provided that ``indexDetails`` is set to ``true``, allows filtering of
42
- index details by specifying the index ``key``, as returned by
43
- :method:`~db.collection.getIndexes()`. Mutually exclusive with
44
- `` indexDetailsName``
46
+ If ``indexDetails`` is ``true``, use ``indexDetailsField`` to filter
47
+ index details by specifying the index ``key``. Use
48
+ :method:`~db.collection.getIndexes()` to discover index keys. You
49
+ cannot use ``indexDetailsField`` with `` indexDetailsName``.
45
50
46
51
.. versionadded:: 2.8
47
52
@@ -56,10 +61,10 @@ name: indexDetailsName
56
61
type : string
57
62
position : 4
58
63
description : |
59
- Provided that ``indexDetails`` is set to ``true``, allows filtering of
60
- index details by specifying the index ``name``, as returned by
61
- :method:`~db.collection.getIndexes()`. Mutually exclusive with
62
- ``indexDetailsKey``
64
+ If ``indexDetails`` is ``true``, use ``indexDetailsName`` to filter
65
+ index details by specifying the index ``name``. Use
66
+ :method:`~db.collection.getIndexes()` to discover index names. You
67
+ cannot use ``indexDetailsName`` with ``indexDetailsField``.
63
68
64
69
.. versionadded:: 2.8
65
70
0 commit comments