PHP Manual
Function Reference
Database Extensions
Vendor Specific Database Extensions
MongoDB
Installing/Configuring
Predefined Constants
Tutorials
Driver Architecture and Internals
Security
MongoDB\Driver
MongoDB\BSON
MongoDB\Driver\Monitoring
MongoDB\Driver\Exception
Script Injection Attacks
MongoDB\Driver\Manager
MongoDB
PHP Manual
MongoDB Extension Classes
Table of Contents
MongoDB\Driver\Manager
— The MongoDB\Driver\Manager class
MongoDB\Driver\Manager::addSubscriber
— Registers a monitoring event subscriber with this Manager
MongoDB\Driver\Manager::__construct
— Create new MongoDB Manager
MongoDB\Driver\Manager::createClientEncryption
— Create a new ClientEncryption object
MongoDB\Driver\Manager::executeBulkWrite
— Execute one or more write operations
MongoDB\Driver\Manager::executeCommand
— Execute a database command
MongoDB\Driver\Manager::executeQuery
— Execute a database query
MongoDB\Driver\Manager::executeReadCommand
— Execute a database command that reads
MongoDB\Driver\Manager::executeReadWriteCommand
— Execute a database command that reads and writes
MongoDB\Driver\Manager::executeWriteCommand
— Execute a database command that writes
MongoDB\Driver\Manager::getEncryptedFieldsMap
— Return the encryptedFieldsMap auto encryption option for the Manager
MongoDB\Driver\Manager::getReadConcern
— Return the ReadConcern for the Manager
MongoDB\Driver\Manager::getReadPreference
— Return the ReadPreference for the Manager
MongoDB\Driver\Manager::getServers
— Return the servers to which this manager is connected
MongoDB\Driver\Manager::getWriteConcern
— Return the WriteConcern for the Manager
MongoDB\Driver\Manager::removeSubscriber
— Unregisters a monitoring event subscriber with this Manager
MongoDB\Driver\Manager::selectServer
— Select a server matching a read preference
MongoDB\Driver\Manager::startSession
— Start a new client session for use with this client
MongoDB\Driver\Command
— The MongoDB\Driver\Command class
MongoDB\Driver\Command::__construct
— Create a new Command
MongoDB\Driver\Query
— The MongoDB\Driver\Query class
MongoDB\Driver\Query::__construct
— Create a new Query
MongoDB\Driver\BulkWrite
— The MongoDB\Driver\BulkWrite class
MongoDB\Driver\BulkWrite::__construct
— Create a new BulkWrite
MongoDB\Driver\BulkWrite::count
— Count number of write operations in the bulk
MongoDB\Driver\BulkWrite::delete
— Add a delete operation to the bulk
MongoDB\Driver\BulkWrite::insert
— Add an insert operation to the bulk
MongoDB\Driver\BulkWrite::update
— Add an update operation to the bulk
MongoDB\Driver\Session
— The MongoDB\Driver\Session class
MongoDB\Driver\Session::abortTransaction
— Aborts a transaction
MongoDB\Driver\Session::advanceClusterTime
— Advances the cluster time for this session
MongoDB\Driver\Session::advanceOperationTime
— Advances the operation time for this session
MongoDB\Driver\Session::commitTransaction
— Commits a transaction
MongoDB\Driver\Session::__construct
— Create a new Session (not used)
MongoDB\Driver\Session::endSession
— Terminates a session
MongoDB\Driver\Session::getClusterTime
— Returns the cluster time for this session
MongoDB\Driver\Session::getLogicalSessionId
— Returns the logical session ID for this session
MongoDB\Driver\Session::getOperationTime
— Returns the operation time for this session
MongoDB\Driver\Session::getServer
— Returns the server to which this session is pinned
MongoDB\Driver\Session::getTransactionOptions
— Returns options for the currently running transaction
MongoDB\Driver\Session::getTransactionState
— Returns the current transaction state for this session
MongoDB\Driver\Session::isDirty
— Returns whether the session has been marked as dirty
MongoDB\Driver\Session::isInTransaction
— Returns whether a multi-document transaction is in progress
MongoDB\Driver\Session::startTransaction
— Starts a transaction
MongoDB\Driver\ClientEncryption
— The MongoDB\Driver\ClientEncryption class
MongoDB\Driver\ClientEncryption::addKeyAltName
— Adds an alternate name to a key document
MongoDB\Driver\ClientEncryption::__construct
— Create a new ClientEncryption object
MongoDB\Driver\ClientEncryption::createDataKey
— Creates a key document
MongoDB\Driver\ClientEncryption::decrypt
— Decrypt a value
MongoDB\Driver\ClientEncryption::deleteKey
— Deletes a key document
MongoDB\Driver\ClientEncryption::encrypt
— Encrypt a value
MongoDB\Driver\ClientEncryption::encryptExpression
— Encrypts a match or aggregate expression
MongoDB\Driver\ClientEncryption::getKey
— Gets a key document
MongoDB\Driver\ClientEncryption::getKeyByAltName
— Gets a key document by an alternate name
MongoDB\Driver\ClientEncryption::getKeys
— Gets all key documents
MongoDB\Driver\ClientEncryption::removeKeyAltName
— Removes an alternate name from a key document
MongoDB\Driver\ClientEncryption::rewrapManyDataKey
— Rewraps data keys
MongoDB\Driver\ServerApi
— The MongoDB\Driver\ServerApi class
MongoDB\Driver\ServerApi::bsonSerialize
— Returns an object for BSON serialization
MongoDB\Driver\ServerApi::__construct
— Create a new ServerApi instance
MongoDB\Driver\ServerApi::serialize
— Serialize a ServerApi
MongoDB\Driver\ServerApi::unserialize
— Unserialize a ServerApi
MongoDB\Driver\WriteConcern
— The MongoDB\Driver\WriteConcern class
MongoDB\Driver\WriteConcern::bsonSerialize
— Returns an object for BSON serialization
MongoDB\Driver\WriteConcern::__construct
— Create a new WriteConcern
MongoDB\Driver\WriteConcern::getJournal
— Returns the WriteConcern's "journal" option
MongoDB\Driver\WriteConcern::getW
— Returns the WriteConcern's "w" option
MongoDB\Driver\WriteConcern::getWtimeout
— Returns the WriteConcern's "wtimeout" option
MongoDB\Driver\WriteConcern::isDefault
— Checks if this is the default write concern
MongoDB\Driver\WriteConcern::serialize
— Serialize a WriteConcern
MongoDB\Driver\WriteConcern::unserialize
— Unserialize a WriteConcern
MongoDB\Driver\ReadPreference
— The MongoDB\Driver\ReadPreference class
MongoDB\Driver\ReadPreference::bsonSerialize
— Returns an object for BSON serialization
MongoDB\Driver\ReadPreference::__construct
— Create a new ReadPreference
MongoDB\Driver\ReadPreference::getHedge
— Returns the ReadPreference's "hedge" option
MongoDB\Driver\ReadPreference::getMaxStalenessSeconds
— Returns the ReadPreference's "maxStalenessSeconds" option
MongoDB\Driver\ReadPreference::getMode
— Returns the ReadPreference's "mode" option
MongoDB\Driver\ReadPreference::getModeString
— Returns the ReadPreference's "mode" option
MongoDB\Driver\ReadPreference::getTagSets
— Returns the ReadPreference's "tagSets" option
MongoDB\Driver\ReadPreference::serialize
— Serialize a ReadPreference
MongoDB\Driver\ReadPreference::unserialize
— Unserialize a ReadPreference
MongoDB\Driver\ReadConcern
— The MongoDB\Driver\ReadConcern class
MongoDB\Driver\ReadConcern::bsonSerialize
— Returns an object for BSON serialization
MongoDB\Driver\ReadConcern::__construct
— Create a new ReadConcern
MongoDB\Driver\ReadConcern::getLevel
— Returns the ReadConcern's "level" option
MongoDB\Driver\ReadConcern::isDefault
— Checks if this is the default read concern
MongoDB\Driver\ReadConcern::serialize
— Serialize a ReadConcern
MongoDB\Driver\ReadConcern::unserialize
— Unserialize a ReadConcern
MongoDB\Driver\Cursor
— The MongoDB\Driver\Cursor class
MongoDB\Driver\Cursor::__construct
— Create a new Cursor (not used)
MongoDB\Driver\Cursor::current
— Returns the current element
MongoDB\Driver\Cursor::getId
— Returns the ID for this cursor
MongoDB\Driver\Cursor::getServer
— Returns the server associated with this cursor
MongoDB\Driver\Cursor::isDead
— Checks if the cursor is exhausted or may have additional results
MongoDB\Driver\Cursor::key
— Returns the current result's index within the cursor
MongoDB\Driver\Cursor::next
— Advances the cursor to the next result
MongoDB\Driver\Cursor::rewind
— Rewind the cursor to the first result
MongoDB\Driver\Cursor::setTypeMap
— Sets a type map to use for BSON unserialization
MongoDB\Driver\Cursor::toArray
— Returns an array containing all results for this cursor
MongoDB\Driver\Cursor::valid
— Checks if the current position in the cursor is valid
MongoDB\Driver\CursorId
— The MongoDB\Driver\CursorId class
MongoDB\Driver\CursorId::__construct
— Create a new CursorId (not used)
MongoDB\Driver\CursorId::serialize
— Serialize a CursorId
MongoDB\Driver\CursorId::__toString
— String representation of the cursor ID
MongoDB\Driver\CursorId::unserialize
— Unserialize a CursorId
MongoDB\Driver\CursorInterface
— The MongoDB\Driver\CursorInterface interface
MongoDB\Driver\CursorInterface::getId
— Returns the ID for this cursor
MongoDB\Driver\CursorInterface::getServer
— Returns the server associated with this cursor
MongoDB\Driver\CursorInterface::isDead
— Checks if the cursor may have additional results
MongoDB\Driver\CursorInterface::setTypeMap
— Sets a type map to use for BSON unserialization
MongoDB\Driver\CursorInterface::toArray
— Returns an array containing all results for this cursor
MongoDB\Driver\Server
— The MongoDB\Driver\Server class
MongoDB\Driver\Server::__construct
— Create a new Server (not used)
MongoDB\Driver\Server::executeBulkWrite
— Execute one or more write operations on this server
MongoDB\Driver\Server::executeCommand
— Execute a database command on this server
MongoDB\Driver\Server::executeQuery
— Execute a database query on this server
MongoDB\Driver\Server::executeReadCommand
— Execute a database command that reads on this server
MongoDB\Driver\Server::executeReadWriteCommand
— Execute a database command that reads and writes on this server
MongoDB\Driver\Server::executeWriteCommand
— Execute a database command that writes on this server
MongoDB\Driver\Server::getHost
— Returns the hostname of this server
MongoDB\Driver\Server::getInfo
— Returns an array of information describing this server
MongoDB\Driver\Server::getLatency
— Returns the latency of this server in milliseconds
MongoDB\Driver\Server::getPort
— Returns the port on which this server is listening
MongoDB\Driver\Server::getServerDescription
— Returns a ServerDescription for this server
MongoDB\Driver\Server::getTags
— Returns an array of tags describing this server in a replica set
MongoDB\Driver\Server::getType
— Returns an integer denoting the type of this server
MongoDB\Driver\Server::isArbiter
— Checks if this server is an arbiter member of a replica set
MongoDB\Driver\Server::isHidden
— Checks if this server is a hidden member of a replica set
MongoDB\Driver\Server::isPassive
— Checks if this server is a passive member of a replica set
MongoDB\Driver\Server::isPrimary
— Checks if this server is a primary member of a replica set
MongoDB\Driver\Server::isSecondary
— Checks if this server is a secondary member of a replica set
MongoDB\Driver\ServerDescription
— The MongoDB\Driver\ServerDescription class
MongoDB\Driver\ServerDescription::getHelloResponse
— Returns the server's most recent "hello" response
MongoDB\Driver\ServerDescription::getHost
— Returns the hostname of this server
MongoDB\Driver\ServerDescription::getLastUpdateTime
— Returns the server's last update time in microseconds
MongoDB\Driver\ServerDescription::getPort
— Returns the port on which this server is listening
MongoDB\Driver\ServerDescription::getRoundTripTime
— Returns the server's round trip time in milliseconds
MongoDB\Driver\ServerDescription::getType
— Returns a string denoting the type of this server
MongoDB\Driver\TopologyDescription
— The MongoDB\Driver\TopologyDescription class
MongoDB\Driver\TopologyDescription::getServers
— Returns the servers in the topology
MongoDB\Driver\TopologyDescription::getType
— Returns a string denoting the type of this topology
MongoDB\Driver\TopologyDescription::hasReadableServer
— Returns whether the topology has a readable server
MongoDB\Driver\TopologyDescription::hasWritableServer
— Returns whether the topology has a writable server
MongoDB\Driver\WriteConcernError
— The MongoDB\Driver\WriteConcernError class
MongoDB\Driver\WriteConcernError::getCode
— Returns the WriteConcernError's error code
MongoDB\Driver\WriteConcernError::getInfo
— Returns metadata document for the WriteConcernError
MongoDB\Driver\WriteConcernError::getMessage
— Returns the WriteConcernError's error message
MongoDB\Driver\WriteError
— The MongoDB\Driver\WriteError class
MongoDB\Driver\WriteError::getCode
— Returns the WriteError's error code
MongoDB\Driver\WriteError::getIndex
— Returns the index of the write operation corresponding to this WriteError
MongoDB\Driver\WriteError::getInfo
— Returns metadata document for the WriteError
MongoDB\Driver\WriteError::getMessage
— Returns the WriteError's error message
MongoDB\Driver\WriteResult
— The MongoDB\Driver\WriteResult class
MongoDB\Driver\WriteResult::getDeletedCount
— Returns the number of documents deleted
MongoDB\Driver\WriteResult::getInsertedCount
— Returns the number of documents inserted (excluding upserts)
MongoDB\Driver\WriteResult::getMatchedCount
— Returns the number of documents selected for update
MongoDB\Driver\WriteResult::getModifiedCount
— Returns the number of existing documents updated
MongoDB\Driver\WriteResult::getServer
— Returns the server associated with this write result
MongoDB\Driver\WriteResult::getUpsertedCount
— Returns the number of documents inserted by an upsert
MongoDB\Driver\WriteResult::getUpsertedIds
— Returns an array of identifiers for upserted documents
MongoDB\Driver\WriteResult::getWriteConcernError
— Returns any write concern error that occurred
MongoDB\Driver\WriteResult::getWriteErrors
— Returns any write errors that occurred
MongoDB\Driver\WriteResult::isAcknowledged
— Returns whether the write was acknowledged