MongoDB\Operation\Explain Class Reference

Inheritance diagram for MongoDB\Operation\Explain:

Public Member Functions
	__construct (string $databaseName, Explainable $explainable, array $options=[])
	Constructs an explain command for explainable operations.
	execute (Server $server)
	Execute the operation.

Public Attributes
const	VERBOSITY_ALL_PLANS = 'allPlansExecution'
const	VERBOSITY_EXEC_STATS = 'executionStats'
const	VERBOSITY_QUERY = 'queryPlanner'

Constructor & Destructor Documentation

__construct()

MongoDB\Operation\Explain::__construct	(	string	$databaseName,
		Explainable	$explainable,
		array	$options = [] )

Constructs an explain command for explainable operations.

Supported options:

• comment (mixed): BSON value to attach as a comment to this command.

  This is not supported for servers versions < 4.4.

• readPreference (MongoDB\Driver\ReadPreference): Read preference.
• session (MongoDB\Driver\Session): Client session.
• typeMap (array): Type map for BSON deserialization. This will be used used for the returned command result document.
• verbosity (string): The mode in which the explain command will be run.

Parameters

string	$databaseName	Database name
Explainable	$explainable	Operation to explain
array	$options	Command options

Exceptions

InvalidArgumentException

for parameter/option parsing errors

Member Function Documentation

execute()

MongoDB\Operation\Explain::execute

(

Server

$server

)

Execute the operation.

See also

Executable\execute()

Return values

array|object

Exceptions

UnsupportedException	if the server does not support explaining the operation
DriverRuntimeException	for other driver errors (e.g. connection errors)

Implements MongoDB\Operation\Executable.

---

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

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