MongoDB\Operation\FindOne Class Reference

Inheritance diagram for MongoDB\Operation\FindOne:

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

Constructor & Destructor Documentation

__construct()

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

Constructs a find command for finding a single document.

Supported options:

• collation (document): Collation specification.

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

  Only string values are supported for server versions < 4.4.

• hint (string|document): The index to use. Specify either the index name as a string or the index key pattern as a document. If specified, then the query system will only consider plans using the hinted index.
• max (document): The exclusive upper bound for a specific index.

• maxScan (integer): Maximum number of documents or index keys to scan when executing the query.

  This option has been deprecated since version 1.4.

• maxTimeMS (integer): The maximum amount of time to allow the query to run. If "$maxTimeMS" also exists in the modifiers document, this option will take precedence.
• min (document): The inclusive upper bound for a specific index.
• modifiers (document): Meta-operators modifying the output or behavior of a query.
• projection (document): Limits the fields to return for the matching document.
• readConcern (MongoDB\Driver\ReadConcern): Read concern.
• readPreference (MongoDB\Driver\ReadPreference): Read preference.
• returnKey (boolean): If true, returns only the index keys in the resulting documents.
• session (MongoDB\Driver\Session): Client session.
• showRecordId (boolean): Determines whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.
• skip (integer): The number of documents to skip before returning.
• sort (document): The order in which to return matching documents. If "$orderby" also exists in the modifiers document, this option will take precedence.
• let (document): Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. "$$var").
• typeMap (array): Type map for BSON deserialization.

Parameters

string	$databaseName	Database name
string	$collectionName	Collection name
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\FindOne::execute

(

Server

$server

)

Execute the operation.

See also

Executable\execute()

Return values

array|object|null

Exceptions

UnsupportedException	if collation or read concern is used and unsupported
DriverRuntimeException	for other driver errors (e.g. connection errors)

Implements MongoDB\Operation\Executable.

getCommandDocument()

MongoDB\Operation\FindOne::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/FindOne.php