Internal
Should not be instantiated by the user.
Optional
Readonly
collectionThe collection the command is being run on, if applicable.
Readonly
commandThe command object. Equal to the response body of the HTTP request.
Note that this is the actual raw command object; it's not necessarily 1:1 with methods called on the collection/db.
For example, a deleteAll
method on a collection will be translated into a deleteMany
command, and a bulkWrite
method will be translated into a series of insertOne
, updateOne
, etc. commands.
{
insertOne: { document: { name: 'John' } }
}
Readonly
commandThe command name.
This is the key of the command object. For example, if the command object is
{ insertOne: { document: { name: 'John' } } }
, the command name is insertOne
.
Meaning, abstracted commands like bulkWrite
, or deleteAll
will be shown as their actual command equivalents.
Readonly
namespaceThe namespace the command is being run in.
Readonly
timeoutThe timeout for the command, in milliseconds.
Readonly
urlThe URL the command is being sent to.
Emitted when a command is started, before the initial HTTP request is made.
Note that these emit real commands, not any abstracted commands like "bulkWrite", "insertMany", or "deleteAll", which have to be translated into appropriate Data API commands.
See CommandEvent for more information about all the common properties available on this event.