Documentation

FindOne
in package
implements Executable, Explainable

Operation for finding a single document with the find command.

Tags
see
Collection::findOne()
see
http://docs.mongodb.org/manual/tutorial/query-documents/
see
http://docs.mongodb.org/manual/reference/operator/query-modifier/

Interfaces, Classes, Traits and Enums

Executable
Explainable

Table of Contents

$find  : Find
__construct()  : mixed
Constructs a find command for finding a single document.
execute()  : array<string|int, mixed>|object|null
Execute the operation.
getCommandDocument()  : array<string|int, mixed>
Returns the command document for this operation.

Properties

Methods

__construct()

Constructs a find command for finding a single document.

public __construct(string $databaseName, string $collectionName, array<string|int, mixed>|object $filter[, array<string|int, mixed> $options = [] ]) : mixed

Supported options:

  • collation (document): Collation specification.

  • comment (string): Attaches a comment to the query. If "$comment" also exists in the modifiers document, this option will take precedence.

  • 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.

  • typeMap (array): Type map for BSON deserialization.

Parameters
$databaseName : string

Database name

$collectionName : string

Collection name

$filter : array<string|int, mixed>|object

Query by which to filter documents

$options : array<string|int, mixed> = []

Command options

Tags
throws
InvalidArgumentException

for parameter/option parsing errors

Return values
mixed —

execute()

Execute the operation.

public execute(Server $server) : array<string|int, mixed>|object|null
Parameters
$server : Server
Tags
see
Executable::execute()
throws
UnsupportedException

if collation or read concern is used and unsupported

throws
RuntimeException

for other driver errors (e.g. connection errors)

Return values
array<string|int, mixed>|object|null —

getCommandDocument()

Returns the command document for this operation.

public getCommandDocument(Server $server) : array<string|int, mixed>
Parameters
$server : Server
Tags
see
Explainable::getCommandDocument()
Return values
array<string|int, mixed> —

Search results