MongoDB\Operation\DatabaseCommand Class Reference

Inheritance diagram for MongoDB\Operation\DatabaseCommand:

Public Member Functions
	__construct (string $databaseName, $command, array $options=[])
	Constructs a command.
	execute (Server $server)
	Execute the operation.

Constructor & Destructor Documentation

__construct()

MongoDB\Operation\DatabaseCommand::__construct	(	string	$databaseName,
			$command,
		array	$options = [] )

Constructs a command.

Supported options:

• readPreference (MongoDB::Driver::ReadPreference): The read preference to use when executing the command. This may be used when issuing the command to a replica set or mongos node to ensure that the driver sets the wire protocol accordingly or adds the read preference to the command document, respectively.
• session (MongoDB::Driver::Session): Client session.
• typeMap (array): Type map for BSON deserialization. This will be applied to the returned Cursor (it is not sent to the server).

Parameters

string	$databaseName	Database name
array | object	$command	Command document
array	$options	Options for command execution

Exceptions

InvalidArgumentException

for parameter/option parsing errors

Member Function Documentation

execute()

MongoDB\Operation\DatabaseCommand::execute

(

Server

$server

)

Execute the operation.

See also

Executable::execute()

Return values

Cursor

Implements MongoDB\Operation\Executable.

---

The documentation for this class was generated from the following file:

• cache/stores/mongodb/MongoDB/Operation/DatabaseCommand.php