Skip to content

Commit f097f29

Browse files
DOCSP-17051 document ability to guarantee correct collStats and dbStats (#166)
* DOCSP-17051 document ability to guarantee correct collStats and dbStats * DOCSP-17051 updates for feedback
1 parent dd16053 commit f097f29

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

source/supported-unsupported/mql-support.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,26 @@ Diagnostic Commands
181181
...
182182
}
183183

184+
{+adl+} introduces an optional boolean parameter, ``sync``, to
185+
bypass the cache and fetch the most recent storage statistics
186+
for a given collection. The following values are valid for the
187+
``sync`` parameter:
188+
189+
- ``true`` - to bypass the cache and return the most recent
190+
storage statistics
191+
- ``false`` - to return cached data
192+
193+
If the ``sync`` parameter is omitted, defaults to ``false``.
194+
195+
.. example::
196+
197+
.. code-block:: shell
198+
199+
db.runCommand( {collStats: "<string>", sync: true|false} )
200+
201+
To learn more about the parameters supported by this
202+
command, see :manual:`collStats </reference/command/collStats>`.
203+
184204
* - :manual:`connectionStatus </reference/command/connectionStatus>`
185205

186206
- Returns information about the current connection, specifically
@@ -198,6 +218,26 @@ Diagnostic Commands
198218
* ``fsUsedSize``
199219
* ``fsTotalSize``
200220

221+
{+adl+} introduces an optional boolean parameter, ``sync``, to
222+
bypass the cache and fetch the most recent storage statistics
223+
for a given database. The following values are valid for the
224+
``sync`` parameter:
225+
226+
- ``true`` - to bypass the cache and return the most recent
227+
storage statistics
228+
- ``false`` - to use the cached data also
229+
230+
If the ``sync`` parameter is omitted, defaults to ``false``.
231+
232+
.. example::
233+
234+
.. code-block:: shell
235+
236+
db.runCommand( {dbStats: 1, sync: true|false} )
237+
238+
To learn more about the parameters supported by this
239+
command, see :manual:`dbStats </reference/command/dbStats>`.
240+
201241
* - :manual:`explain </reference/command/explain>`
202242

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

0 commit comments

Comments
 (0)