Documentation

FindOne
in package
implements Explainable

FinalYes

Operation for finding a single document with the find command.

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

Table of Contents

Interfaces

Explainable

Properties

$find  : Find

Methods

__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:

  • codec (MongoDB\Codec\DocumentCodec): Codec used to decode documents from BSON to PHP objects.

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

  • maxTimeMS (integer): The maximum amount of time to allow the query to run.

  • min (document): The inclusive upper bound for a specific index.

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

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

execute()

Execute the operation.

public execute(Server $server) : array<string|int, mixed>|object|null
Parameters
$server : Server
Tags
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() : array<string|int, mixed>
Tags
see
Explainable::getCommandDocument()
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results