- Reference >
mongoShell Methods >- Database Methods >
- db.runCommand()
db.runCommand()¶
On this page
Definition¶
-
db.runCommand(command)¶ Provides a helper to run specified database commands. This is the preferred method to issue database commands, as it provides a consistent interface between the shell and drivers.
Parameter Type Description commanddocument or string “A database command, specified either in document form or as a string. If specified as a string, db.runCommand()transforms the string into a document.”To specify a time limit in milliseconds, see Terminate Running Operations.
Behavior¶
db.runCommand() runs the command in the context of the
current database. Some commands are only applicable in the context of
the admin database, and you must change your db object to
before running these commands or use db.adminCommand().
Response¶
The method returns a response document that contains the following fields:
| Field | Description |
|---|---|
| Result fields specific to the command | |
ok |
A number that indicates whether the command has succeeded
(1) or failed (0). |
operationTime |
The logical time of the performed operation, represented in MongoDB by the timestamp from the oplog entry. Only for replica sets and sharded clusters If the command does not generate an oplog entry, e.g. a read
operation, then the operation does not advance the logical
clock. In this case,
For operations associated with causally consistent sessions, MongoDB drivers use this time to automatically set the Read Operations and afterClusterTime. New in version 3.6. |
$clusterTime |
A document that returns the signed cluster time. Cluster time is a logical time used for ordering of operations. Only for replica sets and sharded clusters. For internal use only. The document contains the following fields:
New in version 3.6. |