Skip to content

Commit 1daf912

Browse files
DOCSP-17773 Add computedTime and cacheRefreshing (#180)
* DOCSP-17773 Add computedTime and cacheRefreshing * DOCSP-17773 updates for review feedback * DOCSP-17773 updates for copy review feedback * DOCSP-17773 updates for spacing issues
1 parent 5b539ef commit 1daf912

File tree

1 file changed

+49
-16
lines changed

1 file changed

+49
-16
lines changed

source/supported-unsupported/mql-support.txt

Lines changed: 49 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Diagnostic Commands
8888

8989
* - :manual:`buildInfo </reference/command/buildInfo>`
9090

91-
- The response returns the following fields:
91+
- The response contains the following fields:
9292

9393
**ok**
9494
Returns ``1`` for success or ``0`` for failure.
@@ -132,7 +132,7 @@ Diagnostic Commands
132132

133133
* - :manual:`collStats </reference/command/collStats>`
134134

135-
- The following fields are omitted from the response:
135+
- The command omits the following fields in the response:
136136

137137
* ``avgObjSize``
138138
* ``capped``
@@ -143,9 +143,10 @@ Diagnostic Commands
143143
* ``totalIndexSize``
144144
* ``indexSizes``
145145

146-
The following fields are added to the response. You can use
147-
these fields to verify what partitions are being used to
148-
populate a collection.
146+
The command adds the following fields in the response. You can
147+
use these fields to verify what partitions are being used to
148+
populate a collection and understand how recently the stats were
149+
computed.
149150

150151
**partitions.format**
151152
The file format of the partition.
@@ -169,22 +170,38 @@ Diagnostic Commands
169170
**avgPartitionSize**
170171
The average size of all partitions.
171172

173+
**cacheMetadata**
174+
Contains information on how recently the stats were computed.
175+
176+
**cacheMetadata.computeTime**
177+
The time in :manual:`ISODate
178+
</reference/glossary/#term-isodate>` format when the
179+
computation for the stats started.
180+
181+
**cacheMetadata.automaticRefreshInProgress**
182+
The flag that indicates if a background job is running now to
183+
refresh the cache.
184+
172185
.. example::
173186

174187
.. code-block:: json
175188

176189
{
177190
...
191+
"partitionCount": <number of partitions>,
192+
"avgPartitionSize": <average size of all partitions>,
178193
"partitions": [{
179194
"format": <file format>,
180195
"attributes": <filtering attributes>,
181196
"count": <number of documents in partition>,
182197
"source": <S3 url or Atlas cluster name>,
183198
"size": <size, in bytes, of the partition>
184199
}, ...],
185-
"partitionCount": <number of partitions>,
186-
"avgPartitionSize": <average size of all partitions>
187-
...
200+
"cacheMetadata": {
201+
computeTime: ISODate("2021-07-25T15:10:33.513Z"),
202+
automaticRefreshInProgress: false
203+
},
204+
...
188205
}
189206

190207
{+adl+} introduces an optional boolean parameter, ``sync``, to
@@ -217,14 +234,7 @@ Diagnostic Commands
217234

218235
* - :manual:`dbStats </reference/command/dbStats>`
219236

220-
- The following fields are omitted from the response:
221-
222-
* ``object``
223-
* ``avgObjSize``
224-
* ``fsUsedSize``
225-
* ``fsTotalSize``
226-
227-
{+adl+} introduces an optional boolean parameter, ``sync``, to
237+
- {+adl+} introduces an optional boolean parameter, ``sync``, to
228238
bypass the cache and fetch the most recent storage statistics
229239
for a given database. The following values are valid for the
230240
``sync`` parameter:
@@ -244,6 +254,29 @@ Diagnostic Commands
244254
To learn more about the parameters supported by this
245255
command, see :manual:`dbStats </reference/command/dbStats>`.
246256

257+
The command omits the followig fields in the response:
258+
259+
* ``object``
260+
* ``avgObjSize``
261+
* ``fsUsedSize``
262+
* ``fsTotalSize``
263+
264+
The commands adds the following fields in the response. You can
265+
use these fields to determine whether the command returned
266+
stale data.
267+
268+
**cacheMetadata**
269+
Contains information on how recently the stats were computed.
270+
271+
**cacheMetadata.computeTime**
272+
The time in :manual:`ISODate
273+
</reference/glossary/#term-isodate>` format when the
274+
computation for the stats started.
275+
276+
**cacheMetadata.automaticRefreshInProgress**
277+
The flag that indicates if a background job is running now to
278+
refresh the cache.
279+
247280
* - :manual:`explain </reference/command/explain>`
248281

249282
- The data returned by ``explain`` documents the |data-lake| query

0 commit comments

Comments
 (0)