MongoDB\Operation\Distinct Class Reference

Inheritance diagram for MongoDB\Operation\Distinct:

Public Member Functions
	__construct (string $databaseName, string $collectionName, string $fieldName, $filter=[], array $options=[])
	Constructs a distinct command.
	execute (Server $server)
	Execute the operation.
	getCommandDocument (Server $server)
	Returns the command document for this operation.

Constructor & Destructor Documentation

__construct()

MongoDB\Operation\Distinct::__construct	(	string	$databaseName,
		string	$collectionName,
		string	$fieldName,
			$filter = [],
		array	$options = [] )

Constructs a distinct command.

Supported options:

• collation (document): Collation specification.

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

  This is not supported for servers versions < 4.4.

• maxTimeMS (integer): The maximum amount of time to allow the query to run.
• readConcern (MongoDB::Driver::ReadConcern): Read concern.
• readPreference (MongoDB::Driver::ReadPreference): Read preference.
• session (MongoDB::Driver::Session): Client session.
• typeMap (array): Type map for BSON deserialization.

Parameters

string	$databaseName	Database name
string	$collectionName	Collection name
string	$fieldName	Field for which to return distinct values
array | object	$filter	Query by which to filter documents
array	$options	Command options

Exceptions

InvalidArgumentException

for parameter/option parsing errors

Member Function Documentation

execute()

MongoDB\Operation\Distinct::execute

(

Server

$server

)

Execute the operation.

See also

Executable::execute()

Return values

array

Exceptions

UnexpectedValueException	if the command response was malformed
UnsupportedException	if read concern is used and unsupported
DriverRuntimeException	for other driver errors (e.g. connection errors)

Implements MongoDB\Operation\Executable.

getCommandDocument()

MongoDB\Operation\Distinct::getCommandDocument

(

Server

$server

)

Returns the command document for this operation.

See also

Explainable::getCommandDocument()

Return values

array

Implements MongoDB\Operation\Explainable.

---

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

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