diff --git a/docs/faq.txt b/docs/faq.txt index 9cdd9a250..fef322646 100644 --- a/docs/faq.txt +++ b/docs/faq.txt @@ -124,7 +124,7 @@ The following are all examples of [TLS handshake failed: certificate verify failed (64): IP address mismatch calling hello on 'b.example.com:27017'] These errors typically manifest as a -:php:`MongoDB\\Driver\\Exception\\ConnectionTimeoutException ` +:php:`MongoDB\Driver\Exception\ConnectionTimeoutException ` exception from the driver. The actual exception messages originate from libmongoc, which is the underlying library used by the PHP driver. Since these messages can take many forms, it's helpful to break down the structure of the diff --git a/docs/includes/extracts-bulkwriteexception.yaml b/docs/includes/extracts-bulkwriteexception.yaml index f002063f0..6276458e7 100644 --- a/docs/includes/extracts-bulkwriteexception.yaml +++ b/docs/includes/extracts-bulkwriteexception.yaml @@ -1,9 +1,9 @@ ref: bulkwriteexception-result content: | - If a :php:`MongoDB\\Driver\\Exception\\BulkWriteException + If a :php:`MongoDB\Driver\Exception\BulkWriteException ` is thrown, users should call :php:`getWriteResult() ` and - inspect the returned :php:`MongoDB\\Driver\\WriteResult + inspect the returned :php:`MongoDB\Driver\WriteResult ` object to determine the nature of the error. For example, a write operation may have been successfully applied to the diff --git a/docs/includes/extracts-error.yaml b/docs/includes/extracts-error.yaml index cfada049a..1a41843ad 100644 --- a/docs/includes/extracts-error.yaml +++ b/docs/includes/extracts-error.yaml @@ -1,6 +1,6 @@ ref: error-driver-bulkwriteexception content: | - :php:`MongoDB\\Driver\\Exception\\BulkWriteException + :php:`MongoDB\Driver\Exception\BulkWriteException ` for errors related to the write operation. Users should inspect the value returned by :php:`getWriteResult() ` to determine the nature of the @@ -8,45 +8,45 @@ content: | --- ref: error-driver-invalidargumentexception content: | - :php:`MongoDB\\Driver\\Exception\\InvalidArgumentException + :php:`MongoDB\Driver\Exception\InvalidArgumentException ` for errors related to the parsing of parameters or options at the driver level. --- ref: error-driver-runtimeexception content: | - :php:`MongoDB\\Driver\\Exception\\RuntimeException + :php:`MongoDB\Driver\Exception\RuntimeException ` for other errors at the driver level (e.g. connection errors). --- ref: error-badmethodcallexception-write-result content: | - :phpclass:`MongoDB\\Exception\\BadMethodCallException` if this method is + :phpclass:`MongoDB\Exception\BadMethodCallException` if this method is called and the write operation used an unacknowledged :manual:`write concern `. --- ref: error-invalidargumentexception content: | - :phpclass:`MongoDB\\Exception\\InvalidArgumentException` for errors related to + :phpclass:`MongoDB\Exception\InvalidArgumentException` for errors related to the parsing of parameters or options. --- ref: error-unexpectedvalueexception content: | - :phpclass:`MongoDB\\Exception\\UnexpectedValueException` if the command + :phpclass:`MongoDB\Exception\UnexpectedValueException` if the command response from the server was malformed. --- ref: error-unsupportedexception content: | - :phpclass:`MongoDB\\Exception\\UnsupportedException` if options are used and + :phpclass:`MongoDB\Exception\UnsupportedException` if options are used and not supported by the selected server (e.g. ``collation``, ``readConcern``, ``writeConcern``). --- ref: error-gridfs-filenotfoundexception content: | - :phpclass:`MongoDB\\GridFS\\Exception\\FileNotFoundException` if no file was + :phpclass:`MongoDB\GridFS\Exception\FileNotFoundException` if no file was found for the selection criteria. --- ref: error-gridfs-corruptfileexception content: | - :phpclass:`MongoDB\\GridFS\\Exception\\CorruptFileException` if the file's + :phpclass:`MongoDB\GridFS\Exception\CorruptFileException` if the file's metadata or chunk documents contain unexpected or invalid data. ... diff --git a/docs/includes/extracts-note.yaml b/docs/includes/extracts-note.yaml index 7790f0c32..6b4e033ca 100644 --- a/docs/includes/extracts-note.yaml +++ b/docs/includes/extracts-note.yaml @@ -7,6 +7,6 @@ content: | ` rules. When matching a special BSON type the query criteria should use the respective :php:`BSON class ` in the driver (e.g. use - :php:`MongoDB\\BSON\\ObjectId ` to match an + :php:`MongoDB\BSON\ObjectId ` to match an :manual:`ObjectId `). ... diff --git a/docs/index.txt b/docs/index.txt index 5cbf328a4..7e76323fd 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -12,7 +12,7 @@ The ``mongodb`` extension provides a limited API to connect to the database and execute generic commands, queries, and write operations. In contrast, the |php-library| provides a full-featured API and models client, database, and collection objects. Each of those classes provide various helper methods for -performing operations in context. For example, :phpclass:`MongoDB\\Collection` +performing operations in context. For example, :phpclass:`MongoDB\Collection` implements methods for executing CRUD operations and managing indexes on the collection, among other things. diff --git a/docs/reference/bson.txt b/docs/reference/bson.txt index b9fbbaa2c..307532472 100644 --- a/docs/reference/bson.txt +++ b/docs/reference/bson.txt @@ -18,18 +18,18 @@ of JSON documents, though it contains more data types than JSON. For the BSON spec, see `bsonspec.org `_. By default, the |php-library| returns BSON documents as -:phpclass:`MongoDB\\Model\\BSONDocument` objects and BSON arrays as -:phpclass:`MongoDB\\Model\\BSONArray` objects, respectively. +:phpclass:`MongoDB\Model\BSONDocument` objects and BSON arrays as +:phpclass:`MongoDB\Model\BSONArray` objects, respectively. Classes ------- -.. phpclass:: MongoDB\\Model\\BSONArray +.. phpclass:: MongoDB\Model\BSONArray This class extends PHP's :php:`ArrayObject ` class. It also implements PHP's :php:`JsonSerializable ` interface and the - driver's :php:`MongoDB\\BSON\\Serializable ` and - :php:`MongoDB\\BSON\\Unserializable ` + driver's :php:`MongoDB\BSON\Serializable ` and + :php:`MongoDB\BSON\Unserializable ` interfaces. By default, the library will deserialize BSON arrays as instances of this @@ -37,12 +37,12 @@ Classes serialize as an array type (:php:`array_values() ` is used internally to numerically reindex the array). -.. phpclass:: MongoDB\\Model\\BSONDocument +.. phpclass:: MongoDB\Model\BSONDocument This class extends PHP's :php:`ArrayObject ` class. It also implements PHP's :php:`JsonSerializable ` interface and the - driver's :php:`MongoDB\\BSON\\Serializable ` and - :php:`MongoDB\\BSON\\Unserializable ` + driver's :php:`MongoDB\BSON\Serializable ` and + :php:`MongoDB\BSON\Unserializable ` interfaces. By default, the library will deserialize BSON documents as instances of this diff --git a/docs/reference/class/MongoDBBulkWriteResult.txt b/docs/reference/class/MongoDBBulkWriteResult.txt index f33b036d6..2e8c78cfe 100644 --- a/docs/reference/class/MongoDBBulkWriteResult.txt +++ b/docs/reference/class/MongoDBBulkWriteResult.txt @@ -5,12 +5,11 @@ MongoDB\\BulkWriteResult Class Definition ---------- -.. phpclass:: MongoDB\\BulkWriteResult +.. phpclass:: MongoDB\BulkWriteResult This class contains information about an executed bulk write operation. It - encapsulates a :php:`MongoDB\\Driver\\WriteResult - ` object and is returned from - :phpmethod:`MongoDB\\Collection::bulkWrite()`. + encapsulates a :php:`MongoDB\Driver\WriteResult ` + object and is returned from :phpmethod:`MongoDB\Collection::bulkWrite()`. Methods ------- @@ -27,11 +26,11 @@ Methods getUpsertedIds() isAcknowledged() -- :phpmethod:`MongoDB\\BulkWriteResult::getDeletedCount()` -- :phpmethod:`MongoDB\\BulkWriteResult::getInsertedCount()` -- :phpmethod:`MongoDB\\BulkWriteResult::getInsertedIds()` -- :phpmethod:`MongoDB\\BulkWriteResult::getMatchedCount()` -- :phpmethod:`MongoDB\\BulkWriteResult::getModifiedCount()` -- :phpmethod:`MongoDB\\BulkWriteResult::getUpsertedCount()` -- :phpmethod:`MongoDB\\BulkWriteResult::getUpsertedIds()` -- :phpmethod:`MongoDB\\BulkWriteResult::isAcknowledged()` \ No newline at end of file +- :phpmethod:`MongoDB\BulkWriteResult::getDeletedCount()` +- :phpmethod:`MongoDB\BulkWriteResult::getInsertedCount()` +- :phpmethod:`MongoDB\BulkWriteResult::getInsertedIds()` +- :phpmethod:`MongoDB\BulkWriteResult::getMatchedCount()` +- :phpmethod:`MongoDB\BulkWriteResult::getModifiedCount()` +- :phpmethod:`MongoDB\BulkWriteResult::getUpsertedCount()` +- :phpmethod:`MongoDB\BulkWriteResult::getUpsertedIds()` +- :phpmethod:`MongoDB\BulkWriteResult::isAcknowledged()` \ No newline at end of file diff --git a/docs/reference/class/MongoDBChangeStream.txt b/docs/reference/class/MongoDBChangeStream.txt index 3142aeece..bd82c5e0d 100644 --- a/docs/reference/class/MongoDBChangeStream.txt +++ b/docs/reference/class/MongoDBChangeStream.txt @@ -7,13 +7,13 @@ MongoDB\\ChangeStream Class Definition ---------- -.. phpclass:: MongoDB\\ChangeStream +.. phpclass:: MongoDB\ChangeStream This class extends PHP's :php:`Iterator ` interface. An instance of this class is returned by - :phpmethod:`MongoDB\\Client::watch()`, - :phpmethod:`MongoDB\\Database::watch()`, and - :phpmethod:`MongoDB\\Collection::watch()`. + :phpmethod:`MongoDB\Client::watch()`, + :phpmethod:`MongoDB\Database::watch()`, and + :phpmethod:`MongoDB\Collection::watch()`. This class allows for iteration of events in a change stream. It also allows iteration to automatically resume after certain errors, such as a replica set @@ -33,10 +33,10 @@ Methods rewind() valid() -- :phpmethod:`MongoDB\\ChangeStream::current()` -- :phpmethod:`MongoDB\\ChangeStream::getCursorId()` -- :phpmethod:`MongoDB\\ChangeStream::getResumeToken()` -- :phpmethod:`MongoDB\\ChangeStream::key()` -- :phpmethod:`MongoDB\\ChangeStream::next()` -- :phpmethod:`MongoDB\\ChangeStream::rewind()` -- :phpmethod:`MongoDB\\ChangeStream::valid()` \ No newline at end of file +- :phpmethod:`MongoDB\ChangeStream::current()` +- :phpmethod:`MongoDB\ChangeStream::getCursorId()` +- :phpmethod:`MongoDB\ChangeStream::getResumeToken()` +- :phpmethod:`MongoDB\ChangeStream::key()` +- :phpmethod:`MongoDB\ChangeStream::next()` +- :phpmethod:`MongoDB\ChangeStream::rewind()` +- :phpmethod:`MongoDB\ChangeStream::valid()` \ No newline at end of file diff --git a/docs/reference/class/MongoDBClient.txt b/docs/reference/class/MongoDBClient.txt index 757392528..b17105077 100644 --- a/docs/reference/class/MongoDBClient.txt +++ b/docs/reference/class/MongoDBClient.txt @@ -13,13 +13,13 @@ MongoDB\\Client Class Definition ---------- -.. phpclass:: MongoDB\\Client +.. phpclass:: MongoDB\Client This class serves as an entry point for the |php-library|. It is the preferred class for connecting to a MongoDB server or cluster of servers and acts as a gateway for accessing individual databases and collections. - :phpclass:`MongoDB\\Client` is analogous to the driver's - :php:`MongoDB\\Driver\\Manager ` class, which it + :phpclass:`MongoDB\Client` is analogous to the driver's + :php:`MongoDB\Driver\Manager ` class, which it `composes `_. Methods @@ -44,18 +44,18 @@ Methods startSession() watch() -- :phpmethod:`MongoDB\\Client::__construct()` -- :phpmethod:`MongoDB\\Client::__get()` -- :phpmethod:`MongoDB\\Client::createClientEncryption()` -- :phpmethod:`MongoDB\\Client::dropDatabase()` -- :phpmethod:`MongoDB\\Client::getManager()` -- :phpmethod:`MongoDB\\Client::getReadConcern()` -- :phpmethod:`MongoDB\\Client::getReadPreference()` -- :phpmethod:`MongoDB\\Client::getTypeMap()` -- :phpmethod:`MongoDB\\Client::getWriteConcern()` -- :phpmethod:`MongoDB\\Client::listDatabaseNames()` -- :phpmethod:`MongoDB\\Client::listDatabases()` -- :phpmethod:`MongoDB\\Client::selectCollection()` -- :phpmethod:`MongoDB\\Client::selectDatabase()` -- :phpmethod:`MongoDB\\Client::startSession()` -- :phpmethod:`MongoDB\\Client::watch()` +- :phpmethod:`MongoDB\Client::__construct()` +- :phpmethod:`MongoDB\Client::__get()` +- :phpmethod:`MongoDB\Client::createClientEncryption()` +- :phpmethod:`MongoDB\Client::dropDatabase()` +- :phpmethod:`MongoDB\Client::getManager()` +- :phpmethod:`MongoDB\Client::getReadConcern()` +- :phpmethod:`MongoDB\Client::getReadPreference()` +- :phpmethod:`MongoDB\Client::getTypeMap()` +- :phpmethod:`MongoDB\Client::getWriteConcern()` +- :phpmethod:`MongoDB\Client::listDatabaseNames()` +- :phpmethod:`MongoDB\Client::listDatabases()` +- :phpmethod:`MongoDB\Client::selectCollection()` +- :phpmethod:`MongoDB\Client::selectDatabase()` +- :phpmethod:`MongoDB\Client::startSession()` +- :phpmethod:`MongoDB\Client::watch()` diff --git a/docs/reference/class/MongoDBCollection.txt b/docs/reference/class/MongoDBCollection.txt index e303643b3..43346a38e 100644 --- a/docs/reference/class/MongoDBCollection.txt +++ b/docs/reference/class/MongoDBCollection.txt @@ -13,29 +13,28 @@ MongoDB\\Collection Class Definition ---------- -.. phpclass:: MongoDB\\Collection +.. phpclass:: MongoDB\Collection Provides methods for common operations on collections and documents, including CRUD operations and index management. You can construct collections directly using the driver's - :php:`MongoDB\\Driver\\Manager ` class or - select a collection from the library's :phpclass:`MongoDB\\Client` or - :phpclass:`MongoDB\\Database` classes. A collection may also be cloned from - an existing :phpclass:`MongoDB\\Collection` object via the - :phpmethod:`withOptions() ` method. + :php:`MongoDB\Driver\Manager ` class or + select a collection from the library's :phpclass:`MongoDB\Client` or + :phpclass:`MongoDB\Database` classes. A collection may also be cloned from + an existing :phpclass:`MongoDB\Collection` object via the + :phpmethod:`withOptions() ` method. - :phpclass:`MongoDB\\Collection` supports the :php:`readConcern + :phpclass:`MongoDB\Collection` supports the :php:`readConcern `, :php:`readPreference `, :php:`typeMap `, and :php:`writeConcern ` options. If you omit an option, the collection inherits the value from the :php:`Manager - ` constructor argument or the :phpclass:`Client - ` or :phpclass:`Database ` object used to - select the collection. + ` constructor argument or the :phpclass:`Client ` + or :phpclass:`Database ` object used to select the collection. - Operations within the :phpclass:`MongoDB\\Collection` class inherit the + Operations within the :phpclass:`MongoDB\Collection` class inherit the collection's options. Type Map Limitations @@ -45,11 +44,11 @@ The :manual:`aggregate ` (when not using a cursor), :manual:`distinct `, and :manual:`findAndModify ` helpers do not support a ``typeMap`` option due to a driver limitation. The -:phpmethod:`aggregate() `, -:phpmethod:`distinct() `, -:phpmethod:`findOneAndReplace() `, -:phpmethod:`findOneAndUpdate() `, and -:phpmethod:`findOneAndDelete() ` +:phpmethod:`aggregate() `, +:phpmethod:`distinct() `, +:phpmethod:`findOneAndReplace() `, +:phpmethod:`findOneAndUpdate() `, and +:phpmethod:`findOneAndDelete() ` methods return BSON documents as ``stdClass`` objects and BSON arrays as arrays. Methods @@ -97,41 +96,41 @@ Methods watch() withOptions() -- :phpmethod:`MongoDB\\Collection::__construct()` -- :phpmethod:`MongoDB\\Collection::aggregate()` -- :phpmethod:`MongoDB\\Collection::bulkWrite()` -- :phpmethod:`MongoDB\\Collection::count()` -- :phpmethod:`MongoDB\\Collection::countDocuments()` -- :phpmethod:`MongoDB\\Collection::createIndex()` -- :phpmethod:`MongoDB\\Collection::createIndexes()` -- :phpmethod:`MongoDB\\Collection::deleteMany()` -- :phpmethod:`MongoDB\\Collection::deleteOne()` -- :phpmethod:`MongoDB\\Collection::distinct()` -- :phpmethod:`MongoDB\\Collection::drop()` -- :phpmethod:`MongoDB\\Collection::dropIndex()` -- :phpmethod:`MongoDB\\Collection::dropIndexes()` -- :phpmethod:`MongoDB\\Collection::estimatedDocumentCount()` -- :phpmethod:`MongoDB\\Collection::explain()` -- :phpmethod:`MongoDB\\Collection::find()` -- :phpmethod:`MongoDB\\Collection::findOne()` -- :phpmethod:`MongoDB\\Collection::findOneAndDelete()` -- :phpmethod:`MongoDB\\Collection::findOneAndReplace()` -- :phpmethod:`MongoDB\\Collection::findOneAndUpdate()` -- :phpmethod:`MongoDB\\Collection::getCollectionName()` -- :phpmethod:`MongoDB\\Collection::getDatabaseName()` -- :phpmethod:`MongoDB\\Collection::getManager()` -- :phpmethod:`MongoDB\\Collection::getNamespace()` -- :phpmethod:`MongoDB\\Collection::getReadConcern()` -- :phpmethod:`MongoDB\\Collection::getReadPreference()` -- :phpmethod:`MongoDB\\Collection::getTypeMap()` -- :phpmethod:`MongoDB\\Collection::getWriteConcern()` -- :phpmethod:`MongoDB\\Collection::insertMany()` -- :phpmethod:`MongoDB\\Collection::insertOne()` -- :phpmethod:`MongoDB\\Collection::listIndexes()` -- :phpmethod:`MongoDB\\Collection::mapReduce()` -- :phpmethod:`MongoDB\\Collection::rename()` -- :phpmethod:`MongoDB\\Collection::replaceOne()` -- :phpmethod:`MongoDB\\Collection::updateMany()` -- :phpmethod:`MongoDB\\Collection::updateOne()` -- :phpmethod:`MongoDB\\Collection::watch()` -- :phpmethod:`MongoDB\\Collection::withOptions()` +- :phpmethod:`MongoDB\Collection::__construct()` +- :phpmethod:`MongoDB\Collection::aggregate()` +- :phpmethod:`MongoDB\Collection::bulkWrite()` +- :phpmethod:`MongoDB\Collection::count()` +- :phpmethod:`MongoDB\Collection::countDocuments()` +- :phpmethod:`MongoDB\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::createIndexes()` +- :phpmethod:`MongoDB\Collection::deleteMany()` +- :phpmethod:`MongoDB\Collection::deleteOne()` +- :phpmethod:`MongoDB\Collection::distinct()` +- :phpmethod:`MongoDB\Collection::drop()` +- :phpmethod:`MongoDB\Collection::dropIndex()` +- :phpmethod:`MongoDB\Collection::dropIndexes()` +- :phpmethod:`MongoDB\Collection::estimatedDocumentCount()` +- :phpmethod:`MongoDB\Collection::explain()` +- :phpmethod:`MongoDB\Collection::find()` +- :phpmethod:`MongoDB\Collection::findOne()` +- :phpmethod:`MongoDB\Collection::findOneAndDelete()` +- :phpmethod:`MongoDB\Collection::findOneAndReplace()` +- :phpmethod:`MongoDB\Collection::findOneAndUpdate()` +- :phpmethod:`MongoDB\Collection::getCollectionName()` +- :phpmethod:`MongoDB\Collection::getDatabaseName()` +- :phpmethod:`MongoDB\Collection::getManager()` +- :phpmethod:`MongoDB\Collection::getNamespace()` +- :phpmethod:`MongoDB\Collection::getReadConcern()` +- :phpmethod:`MongoDB\Collection::getReadPreference()` +- :phpmethod:`MongoDB\Collection::getTypeMap()` +- :phpmethod:`MongoDB\Collection::getWriteConcern()` +- :phpmethod:`MongoDB\Collection::insertMany()` +- :phpmethod:`MongoDB\Collection::insertOne()` +- :phpmethod:`MongoDB\Collection::listIndexes()` +- :phpmethod:`MongoDB\Collection::mapReduce()` +- :phpmethod:`MongoDB\Collection::rename()` +- :phpmethod:`MongoDB\Collection::replaceOne()` +- :phpmethod:`MongoDB\Collection::updateMany()` +- :phpmethod:`MongoDB\Collection::updateOne()` +- :phpmethod:`MongoDB\Collection::watch()` +- :phpmethod:`MongoDB\Collection::withOptions()` diff --git a/docs/reference/class/MongoDBDatabase.txt b/docs/reference/class/MongoDBDatabase.txt index f92d23145..c5a5b3a58 100644 --- a/docs/reference/class/MongoDBDatabase.txt +++ b/docs/reference/class/MongoDBDatabase.txt @@ -13,28 +13,28 @@ MongoDB\\Database Class Definition ---------- -.. phpclass:: MongoDB\\Database +.. phpclass:: MongoDB\Database Provides methods for common operations on a database, such as executing database commands and managing collections. You can construct a database directly using the driver's - :php:`MongoDB\\Driver\\Manager ` class or - select a database from the library's :phpclass:`MongoDB\\Client` class. A - database may also be cloned from an existing :phpclass:`MongoDB\\Database` - object via the :phpmethod:`withOptions() ` + :php:`MongoDB\Driver\Manager ` class or + select a database from the library's :phpclass:`MongoDB\Client` class. A + database may also be cloned from an existing :phpclass:`MongoDB\Database` + object via the :phpmethod:`withOptions() ` method. - :phpclass:`MongoDB\\Database` supports the :php:`readConcern + :phpclass:`MongoDB\Database` supports the :php:`readConcern `, :php:`readPreference `, :php:`typeMap `, and :php:`writeConcern ` options. If you omit an option, the database inherits the value from the :php:`Manager - ` constructor argument or the :phpclass:`Client - ` object used to select the database. + ` constructor argument or the :phpclass:`Client ` + object used to select the database. - Operations within the :phpclass:`MongoDB\\Database` class inherit the + Operations within the :phpclass:`MongoDB\Database` class inherit the Database's options. Methods @@ -66,25 +66,25 @@ Methods watch() withOptions() -- :phpmethod:`MongoDB\\Database::__construct()` -- :phpmethod:`MongoDB\\Database::__get()` -- :phpmethod:`MongoDB\\Database::aggregate()` -- :phpmethod:`MongoDB\\Database::command()` -- :phpmethod:`MongoDB\\Database::createCollection()` -- :phpmethod:`MongoDB\\Database::createEncryptedCollection()` -- :phpmethod:`MongoDB\\Database::drop()` -- :phpmethod:`MongoDB\\Database::dropCollection()` -- :phpmethod:`MongoDB\\Database::getDatabaseName()` -- :phpmethod:`MongoDB\\Database::getManager()` -- :phpmethod:`MongoDB\\Database::getReadConcern()` -- :phpmethod:`MongoDB\\Database::getReadPreference()` -- :phpmethod:`MongoDB\\Database::getTypeMap()` -- :phpmethod:`MongoDB\\Database::getWriteConcern()` -- :phpmethod:`MongoDB\\Database::listCollectionNames()` -- :phpmethod:`MongoDB\\Database::listCollections()` -- :phpmethod:`MongoDB\\Database::modifyCollection()` -- :phpmethod:`MongoDB\\Database::renameCollection()` -- :phpmethod:`MongoDB\\Database::selectCollection()` -- :phpmethod:`MongoDB\\Database::selectGridFSBucket()` -- :phpmethod:`MongoDB\\Database::watch()` -- :phpmethod:`MongoDB\\Database::withOptions()` \ No newline at end of file +- :phpmethod:`MongoDB\Database::__construct()` +- :phpmethod:`MongoDB\Database::__get()` +- :phpmethod:`MongoDB\Database::aggregate()` +- :phpmethod:`MongoDB\Database::command()` +- :phpmethod:`MongoDB\Database::createCollection()` +- :phpmethod:`MongoDB\Database::createEncryptedCollection()` +- :phpmethod:`MongoDB\Database::drop()` +- :phpmethod:`MongoDB\Database::dropCollection()` +- :phpmethod:`MongoDB\Database::getDatabaseName()` +- :phpmethod:`MongoDB\Database::getManager()` +- :phpmethod:`MongoDB\Database::getReadConcern()` +- :phpmethod:`MongoDB\Database::getReadPreference()` +- :phpmethod:`MongoDB\Database::getTypeMap()` +- :phpmethod:`MongoDB\Database::getWriteConcern()` +- :phpmethod:`MongoDB\Database::listCollectionNames()` +- :phpmethod:`MongoDB\Database::listCollections()` +- :phpmethod:`MongoDB\Database::modifyCollection()` +- :phpmethod:`MongoDB\Database::renameCollection()` +- :phpmethod:`MongoDB\Database::selectCollection()` +- :phpmethod:`MongoDB\Database::selectGridFSBucket()` +- :phpmethod:`MongoDB\Database::watch()` +- :phpmethod:`MongoDB\Database::withOptions()` \ No newline at end of file diff --git a/docs/reference/class/MongoDBDeleteResult.txt b/docs/reference/class/MongoDBDeleteResult.txt index 02c2c8c17..cd4aa2bc6 100644 --- a/docs/reference/class/MongoDBDeleteResult.txt +++ b/docs/reference/class/MongoDBDeleteResult.txt @@ -5,13 +5,12 @@ MongoDB\\DeleteResult Class Definition ---------- -.. phpclass:: MongoDB\\DeleteResult +.. phpclass:: MongoDB\DeleteResult This class contains information about an executed delete operation. It - encapsulates a :php:`MongoDB\\Driver\\WriteResult - ` object and is returned from - :phpmethod:`MongoDB\\Collection::deleteMany()` or - :phpmethod:`MongoDB\\Collection::deleteOne()`. + encapsulates a :php:`MongoDB\Driver\WriteResult ` + object and is returned from :phpmethod:`MongoDB\Collection::deleteMany()` or + :phpmethod:`MongoDB\Collection::deleteOne()`. Methods ------- @@ -22,5 +21,5 @@ Methods getDeletedCount() isAcknowledged() -- :phpmethod:`MongoDB\\DeleteResult::getDeletedCount()` -- :phpmethod:`MongoDB\\DeleteResult::isAcknowledged()` +- :phpmethod:`MongoDB\DeleteResult::getDeletedCount()` +- :phpmethod:`MongoDB\DeleteResult::isAcknowledged()` diff --git a/docs/reference/class/MongoDBGridFSBucket.txt b/docs/reference/class/MongoDBGridFSBucket.txt index 7703a678c..0a83a32ee 100644 --- a/docs/reference/class/MongoDBGridFSBucket.txt +++ b/docs/reference/class/MongoDBGridFSBucket.txt @@ -13,19 +13,19 @@ MongoDB\\GridFS\\Bucket Class Definition ---------- -.. phpclass:: MongoDB\\GridFS\\Bucket +.. phpclass:: MongoDB\GridFS\Bucket :manual:`GridFS ` is a specification for storing and retrieving files in MongoDB. GridFS uses two collections to store files. One collection stores the file chunks (e.g. ``fs.chunks``), and the other stores file - metadata (e.g. ``fs.files``). The :phpclass:`MongoDB\\GridFS\\Bucket` class + metadata (e.g. ``fs.files``). The :phpclass:`MongoDB\GridFS\Bucket` class provides an interface around these collections for working with the files as PHP :php:`Streams `. You can construct a GridFS bucket using the driver's :php:`Manager ` class, or select a bucket from - the library's :phpclass:`MongoDB\\Database` class via the - :phpmethod:`selectGridFSBucket() ` + the library's :phpclass:`MongoDB\Database` class via the + :phpmethod:`selectGridFSBucket() ` method. Methods @@ -58,25 +58,25 @@ Methods rename() uploadFromStream() -- :phpmethod:`MongoDB\\GridFS\\Bucket::__construct()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::delete()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStream()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::drop()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::find()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::findOne()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getBucketName()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getChunksCollection()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getChunkSizeBytes()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getDatabaseName()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getFileDocumentForStream()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getFileIdForStream()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getFilesCollection()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::openDownloadStream()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::openDownloadStreamByName()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::openUploadStream()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::rename()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::uploadFromStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::__construct()` +- :phpmethod:`MongoDB\GridFS\Bucket::delete()` +- :phpmethod:`MongoDB\GridFS\Bucket::downloadToStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::drop()` +- :phpmethod:`MongoDB\GridFS\Bucket::find()` +- :phpmethod:`MongoDB\GridFS\Bucket::findOne()` +- :phpmethod:`MongoDB\GridFS\Bucket::getBucketName()` +- :phpmethod:`MongoDB\GridFS\Bucket::getChunksCollection()` +- :phpmethod:`MongoDB\GridFS\Bucket::getChunkSizeBytes()` +- :phpmethod:`MongoDB\GridFS\Bucket::getDatabaseName()` +- :phpmethod:`MongoDB\GridFS\Bucket::getFileDocumentForStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::getFileIdForStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::getFilesCollection()` +- :phpmethod:`MongoDB\GridFS\Bucket::getReadConcern()` +- :phpmethod:`MongoDB\GridFS\Bucket::getReadPreference()` +- :phpmethod:`MongoDB\GridFS\Bucket::getTypeMap()` +- :phpmethod:`MongoDB\GridFS\Bucket::getWriteConcern()` +- :phpmethod:`MongoDB\GridFS\Bucket::openDownloadStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::openDownloadStreamByName()` +- :phpmethod:`MongoDB\GridFS\Bucket::openUploadStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::rename()` +- :phpmethod:`MongoDB\GridFS\Bucket::uploadFromStream()` diff --git a/docs/reference/class/MongoDBInsertManyResult.txt b/docs/reference/class/MongoDBInsertManyResult.txt index 16d9b4827..f7f79c8cd 100644 --- a/docs/reference/class/MongoDBInsertManyResult.txt +++ b/docs/reference/class/MongoDBInsertManyResult.txt @@ -5,12 +5,11 @@ MongoDB\\InsertManyResult Class Definition ---------- -.. phpclass:: MongoDB\\InsertManyResult +.. phpclass:: MongoDB\InsertManyResult This class contains information about an executed bulk insert operation. It - encapsulates a :php:`MongoDB\\Driver\\WriteResult - ` object and is returned from - :phpmethod:`MongoDB\\Collection::insertMany()`. + encapsulates a :php:`MongoDB\Driver\WriteResult ` + object and is returned from :phpmethod:`MongoDB\Collection::insertMany()`. Methods ------- @@ -22,6 +21,6 @@ Methods getInsertedIds() isAcknowledged() -- :phpmethod:`MongoDB\\InsertManyResult::getInsertedCount()` -- :phpmethod:`MongoDB\\InsertManyResult::getInsertedIds()` -- :phpmethod:`MongoDB\\InsertManyResult::isAcknowledged()` \ No newline at end of file +- :phpmethod:`MongoDB\InsertManyResult::getInsertedCount()` +- :phpmethod:`MongoDB\InsertManyResult::getInsertedIds()` +- :phpmethod:`MongoDB\InsertManyResult::isAcknowledged()` \ No newline at end of file diff --git a/docs/reference/class/MongoDBInsertOneResult.txt b/docs/reference/class/MongoDBInsertOneResult.txt index 19454d221..09e0a35b4 100644 --- a/docs/reference/class/MongoDBInsertOneResult.txt +++ b/docs/reference/class/MongoDBInsertOneResult.txt @@ -5,12 +5,11 @@ MongoDB\\InsertOneResult Class Definition ---------- -.. phpclass:: MongoDB\\InsertOneResult +.. phpclass:: MongoDB\InsertOneResult This class contains information about an executed insert operation. It - encapsulates a :php:`MongoDB\\Driver\\WriteResult - ` object and is returned from - :phpmethod:`MongoDB\\Collection::insertOne()`. + encapsulates a :php:`MongoDB\Driver\WriteResult ` + object and is returned from :phpmethod:`MongoDB\Collection::insertOne()`. Methods ------- @@ -22,6 +21,6 @@ Methods getInsertedId() isAcknowledged() -- :phpmethod:`MongoDB\\InsertOneResult::getInsertedCount()` -- :phpmethod:`MongoDB\\InsertOneResult::getInsertedId()` -- :phpmethod:`MongoDB\\InsertOneResult::isAcknowledged()` \ No newline at end of file +- :phpmethod:`MongoDB\InsertOneResult::getInsertedCount()` +- :phpmethod:`MongoDB\InsertOneResult::getInsertedId()` +- :phpmethod:`MongoDB\InsertOneResult::isAcknowledged()` \ No newline at end of file diff --git a/docs/reference/class/MongoDBMapReduceResult.txt b/docs/reference/class/MongoDBMapReduceResult.txt index 601f6f82a..8f27cce90 100644 --- a/docs/reference/class/MongoDBMapReduceResult.txt +++ b/docs/reference/class/MongoDBMapReduceResult.txt @@ -7,11 +7,11 @@ MongoDB\\MapReduceResult Class Definition ---------- -.. phpclass:: MongoDB\\MapReduceResult +.. phpclass:: MongoDB\MapReduceResult This class extends PHP's :php:`IteratorAggregate ` interface. An instance of this class is returned by - :phpmethod:`MongoDB\\Collection::mapReduce()`. + :phpmethod:`MongoDB\Collection::mapReduce()`. This class allows for iteration of map-reduce results irrespective of the output method (e.g. inline, collection). It also provides access to command @@ -28,7 +28,7 @@ Methods getIterator() getTiming() -- :phpmethod:`MongoDB\\MapReduceResult::getCounts()` -- :phpmethod:`MongoDB\\MapReduceResult::getExecutionTimeMS()` -- :phpmethod:`MongoDB\\MapReduceResult::getIterator()` -- :phpmethod:`MongoDB\\MapReduceResult::getTiming()` \ No newline at end of file +- :phpmethod:`MongoDB\MapReduceResult::getCounts()` +- :phpmethod:`MongoDB\MapReduceResult::getExecutionTimeMS()` +- :phpmethod:`MongoDB\MapReduceResult::getIterator()` +- :phpmethod:`MongoDB\MapReduceResult::getTiming()` \ No newline at end of file diff --git a/docs/reference/class/MongoDBModelCollectionInfo.txt b/docs/reference/class/MongoDBModelCollectionInfo.txt index 178070952..76b9af35a 100644 --- a/docs/reference/class/MongoDBModelCollectionInfo.txt +++ b/docs/reference/class/MongoDBModelCollectionInfo.txt @@ -5,11 +5,11 @@ MongoDB\\Model\\CollectionInfo Class Definition ---------- -.. phpclass:: MongoDB\\Model\\CollectionInfo +.. phpclass:: MongoDB\Model\CollectionInfo This class models information about a collection. Instances of this class are - returned by traversing a :phpclass:`MongoDB\\Model\\CollectionInfoIterator`, - which is returned by :phpmethod:`MongoDB\\Database::listCollections()`. + returned by traversing a :phpclass:`MongoDB\Model\CollectionInfoIterator`, + which is returned by :phpmethod:`MongoDB\Database::listCollections()`. .. versionchanged:: 1.4 @@ -20,9 +20,9 @@ Definition .. note:: - The :phpclass:`MongoDB\\Model\\CollectionInfo` class is immutable. Attempting + The :phpclass:`MongoDB\Model\CollectionInfo` class is immutable. Attempting to modify it via the :php:`ArrayAccess ` interface will - result in a :phpclass:`MongoDB\\Exception\\BadMethodCallException`. + result in a :phpclass:`MongoDB\Exception\BadMethodCallException`. Methods ------- @@ -39,11 +39,11 @@ Methods getType() isCapped() -- :phpmethod:`MongoDB\\Model\\CollectionInfo::getCappedMax()` -- :phpmethod:`MongoDB\\Model\\CollectionInfo::getCappedSize()` -- :phpmethod:`MongoDB\\Model\\CollectionInfo::getIdIndex()` -- :phpmethod:`MongoDB\\Model\\CollectionInfo::getInfo()` -- :phpmethod:`MongoDB\\Model\\CollectionInfo::getName()` -- :phpmethod:`MongoDB\\Model\\CollectionInfo::getOptions()` -- :phpmethod:`MongoDB\\Model\\CollectionInfo::getType()` -- :phpmethod:`MongoDB\\Model\\CollectionInfo::isCapped()` \ No newline at end of file +- :phpmethod:`MongoDB\Model\CollectionInfo::getCappedMax()` +- :phpmethod:`MongoDB\Model\CollectionInfo::getCappedSize()` +- :phpmethod:`MongoDB\Model\CollectionInfo::getIdIndex()` +- :phpmethod:`MongoDB\Model\CollectionInfo::getInfo()` +- :phpmethod:`MongoDB\Model\CollectionInfo::getName()` +- :phpmethod:`MongoDB\Model\CollectionInfo::getOptions()` +- :phpmethod:`MongoDB\Model\CollectionInfo::getType()` +- :phpmethod:`MongoDB\Model\CollectionInfo::isCapped()` \ No newline at end of file diff --git a/docs/reference/class/MongoDBModelCollectionInfoIterator.txt b/docs/reference/class/MongoDBModelCollectionInfoIterator.txt index 5358f2137..fca6da62f 100644 --- a/docs/reference/class/MongoDBModelCollectionInfoIterator.txt +++ b/docs/reference/class/MongoDBModelCollectionInfoIterator.txt @@ -5,11 +5,11 @@ MongoDB\\Model\\CollectionInfoIterator Class Definition ---------- -.. phpclass:: MongoDB\\Model\\CollectionInfoIterator +.. phpclass:: MongoDB\Model\CollectionInfoIterator This interface extends PHP's :php:`Iterator ` interface. An instance of this interface is returned by - :phpmethod:`MongoDB\\Database::listCollections()`. + :phpmethod:`MongoDB\Database::listCollections()`. Methods ------- @@ -17,4 +17,4 @@ Methods This interface adds no new methods to :php:`Iterator `, but specifies that :php:`current() ` will return an instance of -:phpclass:`MongoDB\\Model\\CollectionInfo`. \ No newline at end of file +:phpclass:`MongoDB\Model\CollectionInfo`. \ No newline at end of file diff --git a/docs/reference/class/MongoDBModelDatabaseInfo.txt b/docs/reference/class/MongoDBModelDatabaseInfo.txt index e0f45852d..a8d18cd64 100644 --- a/docs/reference/class/MongoDBModelDatabaseInfo.txt +++ b/docs/reference/class/MongoDBModelDatabaseInfo.txt @@ -5,11 +5,11 @@ MongoDB\\Model\\DatabaseInfo Class Definition ---------- -.. phpclass:: MongoDB\\Model\\DatabaseInfo +.. phpclass:: MongoDB\Model\DatabaseInfo This class models information about a database. Instances of this class are - returned by traversing a :phpclass:`MongoDB\\Model\\DatabaseInfoIterator`, - which is returned by :phpmethod:`MongoDB\\Client::listDatabases()`. + returned by traversing a :phpclass:`MongoDB\Model\DatabaseInfoIterator`, + which is returned by :phpmethod:`MongoDB\Client::listDatabases()`. .. versionchanged:: 1.4 @@ -20,9 +20,9 @@ Definition .. note:: - The :phpclass:`MongoDB\\Model\\DatabaseInfo` class is immutable. Attempting + The :phpclass:`MongoDB\Model\DatabaseInfo` class is immutable. Attempting to modify it via the :php:`ArrayAccess ` interface will - result in a :phpclass:`MongoDB\\Exception\\BadMethodCallException`. + result in a :phpclass:`MongoDB\Exception\BadMethodCallException`. Methods ------- @@ -34,6 +34,6 @@ Methods getSizeOnDisk() isEmpty() -- :phpmethod:`MongoDB\\Model\\DatabaseInfo::getName()` -- :phpmethod:`MongoDB\\Model\\DatabaseInfo::getSizeOnDisk()` -- :phpmethod:`MongoDB\\Model\\DatabaseInfo::isEmpty()` \ No newline at end of file +- :phpmethod:`MongoDB\Model\DatabaseInfo::getName()` +- :phpmethod:`MongoDB\Model\DatabaseInfo::getSizeOnDisk()` +- :phpmethod:`MongoDB\Model\DatabaseInfo::isEmpty()` \ No newline at end of file diff --git a/docs/reference/class/MongoDBModelDatabaseInfoIterator.txt b/docs/reference/class/MongoDBModelDatabaseInfoIterator.txt index 960ca2562..ba36ef2e4 100644 --- a/docs/reference/class/MongoDBModelDatabaseInfoIterator.txt +++ b/docs/reference/class/MongoDBModelDatabaseInfoIterator.txt @@ -5,11 +5,11 @@ MongoDB\\Model\\DatabaseInfoIterator Class Definition ---------- -.. phpclass:: MongoDB\\Model\\DatabaseInfoIterator +.. phpclass:: MongoDB\Model\DatabaseInfoIterator This interface extends PHP's :php:`Iterator ` interface. An instance of this interface is returned by - :phpmethod:`MongoDB\\Client::listDatabases()`. + :phpmethod:`MongoDB\Client::listDatabases()`. Methods ------- @@ -17,4 +17,4 @@ Methods This interface adds no new methods to :php:`Iterator `, but specifies that :php:`current() ` will return an instance of -:phpclass:`MongoDB\\Model\\DatabaseInfo`. \ No newline at end of file +:phpclass:`MongoDB\Model\DatabaseInfo`. \ No newline at end of file diff --git a/docs/reference/class/MongoDBModelIndexInfo.txt b/docs/reference/class/MongoDBModelIndexInfo.txt index 8b9c42c85..4d017e5d8 100644 --- a/docs/reference/class/MongoDBModelIndexInfo.txt +++ b/docs/reference/class/MongoDBModelIndexInfo.txt @@ -5,11 +5,11 @@ MongoDB\\Model\\IndexInfo Class Definition ---------- -.. phpclass:: MongoDB\\Model\\IndexInfo +.. phpclass:: MongoDB\Model\IndexInfo This class models information about an index. Instances of this class are - returned by traversing a :phpclass:`MongoDB\\Model\\IndexInfoIterator`, - which is returned by :phpmethod:`MongoDB\\Collection::listIndexes()`. + returned by traversing a :phpclass:`MongoDB\Model\IndexInfoIterator`, + which is returned by :phpmethod:`MongoDB\Collection::listIndexes()`. This class implements PHP's :php:`ArrayAccess ` interface. This provides a mechanism for accessing index fields for which there exists no @@ -18,9 +18,9 @@ Definition .. note:: - The :phpclass:`MongoDB\\Model\\IndexInfo` class is immutable. Attempting + The :phpclass:`MongoDB\Model\IndexInfo` class is immutable. Attempting to modify it via the :php:`ArrayAccess ` interface will - result in a :phpclass:`MongoDB\\Exception\\BadMethodCallException`. + result in a :phpclass:`MongoDB\Exception\BadMethodCallException`. Methods ------- @@ -39,13 +39,13 @@ Methods isTtl() isUnique() -- :phpmethod:`MongoDB\\Model\\IndexInfo::getKey()` -- :phpmethod:`MongoDB\\Model\\IndexInfo::getName()` -- :phpmethod:`MongoDB\\Model\\IndexInfo::getNamespace()` -- :phpmethod:`MongoDB\\Model\\IndexInfo::getVersion()` -- :phpmethod:`MongoDB\\Model\\IndexInfo::is2dSphere()` -- :phpmethod:`MongoDB\\Model\\IndexInfo::isGeoHaystack()` -- :phpmethod:`MongoDB\\Model\\IndexInfo::isSparse()` -- :phpmethod:`MongoDB\\Model\\IndexInfo::isText()` -- :phpmethod:`MongoDB\\Model\\IndexInfo::isTtl()` -- :phpmethod:`MongoDB\\Model\\IndexInfo::isUnique()` \ No newline at end of file +- :phpmethod:`MongoDB\Model\IndexInfo::getKey()` +- :phpmethod:`MongoDB\Model\IndexInfo::getName()` +- :phpmethod:`MongoDB\Model\IndexInfo::getNamespace()` +- :phpmethod:`MongoDB\Model\IndexInfo::getVersion()` +- :phpmethod:`MongoDB\Model\IndexInfo::is2dSphere()` +- :phpmethod:`MongoDB\Model\IndexInfo::isGeoHaystack()` +- :phpmethod:`MongoDB\Model\IndexInfo::isSparse()` +- :phpmethod:`MongoDB\Model\IndexInfo::isText()` +- :phpmethod:`MongoDB\Model\IndexInfo::isTtl()` +- :phpmethod:`MongoDB\Model\IndexInfo::isUnique()` \ No newline at end of file diff --git a/docs/reference/class/MongoDBModelIndexInfoIterator.txt b/docs/reference/class/MongoDBModelIndexInfoIterator.txt index 2b1547069..0fae59c27 100644 --- a/docs/reference/class/MongoDBModelIndexInfoIterator.txt +++ b/docs/reference/class/MongoDBModelIndexInfoIterator.txt @@ -5,11 +5,11 @@ MongoDB\\Model\\IndexInfoIterator Class Definition ---------- -.. phpclass:: MongoDB\\Model\\IndexInfoIterator +.. phpclass:: MongoDB\Model\IndexInfoIterator This interface extends PHP's :php:`Iterator ` interface. An instance of this interface is returned by - :phpmethod:`MongoDB\\Collection::listIndexes()`. + :phpmethod:`MongoDB\Collection::listIndexes()`. Methods ------- @@ -17,4 +17,4 @@ Methods This interface adds no new methods to :php:`Iterator `, but specifies that :php:`current() ` will return an instance of -:phpclass:`MongoDB\\Model\\IndexInfo`. \ No newline at end of file +:phpclass:`MongoDB\Model\IndexInfo`. \ No newline at end of file diff --git a/docs/reference/class/MongoDBUpdateResult.txt b/docs/reference/class/MongoDBUpdateResult.txt index 0534980df..52561e59f 100644 --- a/docs/reference/class/MongoDBUpdateResult.txt +++ b/docs/reference/class/MongoDBUpdateResult.txt @@ -5,14 +5,14 @@ MongoDB\\UpdateResult Class Definition ---------- -.. phpclass:: MongoDB\\UpdateResult +.. phpclass:: MongoDB\UpdateResult This class contains information about an executed update or replace - operation. It encapsulates a :php:`MongoDB\\Driver\\WriteResult + operation. It encapsulates a :php:`MongoDB\Driver\WriteResult ` object and is returned from - :phpmethod:`MongoDB\\Collection::replaceOne()`, - :phpmethod:`MongoDB\\Collection::updateMany()`, or - :phpmethod:`MongoDB\\Collection::updateOne()`. + :phpmethod:`MongoDB\Collection::replaceOne()`, + :phpmethod:`MongoDB\Collection::updateMany()`, or + :phpmethod:`MongoDB\Collection::updateOne()`. Methods ------- @@ -26,8 +26,8 @@ Methods getUpsertedId() isAcknowledged() -- :phpmethod:`MongoDB\\UpdateResult::getMatchedCount()` -- :phpmethod:`MongoDB\\UpdateResult::getModifiedCount()` -- :phpmethod:`MongoDB\\UpdateResult::getUpsertedCount()` -- :phpmethod:`MongoDB\\UpdateResult::getUpsertedId()` -- :phpmethod:`MongoDB\\UpdateResult::isAcknowledged()` \ No newline at end of file +- :phpmethod:`MongoDB\UpdateResult::getMatchedCount()` +- :phpmethod:`MongoDB\UpdateResult::getModifiedCount()` +- :phpmethod:`MongoDB\UpdateResult::getUpsertedCount()` +- :phpmethod:`MongoDB\UpdateResult::getUpsertedId()` +- :phpmethod:`MongoDB\UpdateResult::isAcknowledged()` \ No newline at end of file diff --git a/docs/reference/exception-classes.txt b/docs/reference/exception-classes.txt index 20ae7067e..584c55d53 100644 --- a/docs/reference/exception-classes.txt +++ b/docs/reference/exception-classes.txt @@ -13,56 +13,56 @@ Exception Classes MongoDB\\Exception\\BadMethodCallException ------------------------------------------ -.. phpclass:: MongoDB\\Exception\\BadMethodCallException +.. phpclass:: MongoDB\Exception\BadMethodCallException This exception is thrown when an unsupported method is invoked on an object. For example, using an unacknowledged write concern with - :phpmethod:`MongoDB\\Collection::insertMany()` will return a - :phpclass:`MongoDB\\InsertManyResult` object. It is a logical error to call - :phpmethod:`MongoDB\\InsertManyResult::getInsertedCount()`, since the number + :phpmethod:`MongoDB\Collection::insertMany()` will return a + :phpclass:`MongoDB\InsertManyResult` object. It is a logical error to call + :phpmethod:`MongoDB\InsertManyResult::getInsertedCount()`, since the number of inserted documents can only be determined from the response of an acknowledged write operation. This class extends PHP's :php:`BadMethodCallException ` class and implements the library's - :phpclass:`Exception ` interface. + :phpclass:`Exception ` interface. ---- MongoDB\\Exception\\CreateEncryptedCollectionException ------------------------------------------------------ -.. phpclass:: MongoDB\\Exception\\CreateEncryptedCollectionException +.. phpclass:: MongoDB\Exception\CreateEncryptedCollectionException - Thrown by :phpmethod:`MongoDB\\Database::createEncryptedCollection()` if any + Thrown by :phpmethod:`MongoDB\Database::createEncryptedCollection()` if any error is encountered while creating data keys or creating the collection. The original exception and modified ``encryptedFields`` option can be accessed via the ``getPrevious()`` and ``getEncryptedFields()`` methods, respectively. This class extends the library's :phpclass:`RuntimeException - ` class. + ` class. ---- MongoDB\\Exception\\InvalidArgumentException -------------------------------------------- -.. phpclass:: MongoDB\\Exception\\InvalidArgumentException +.. phpclass:: MongoDB\Exception\InvalidArgumentException Thrown for errors related to the parsing of parameters or options within the library. This class extends the driver's :php:`InvalidArgumentException ` class and implements the - library's :phpclass:`Exception ` interface. + library's :phpclass:`Exception ` interface. ---- MongoDB\\Exception\\UnexpectedValueException -------------------------------------------- -.. phpclass:: MongoDB\\Exception\\UnexpectedValueException +.. phpclass:: MongoDB\Exception\UnexpectedValueException This exception is thrown when a command response from the server is malformed or not what the library expected. This exception means that an @@ -72,26 +72,26 @@ MongoDB\\Exception\\UnexpectedValueException This class extends the driver's :php:`UnexpectedValueException ` class and implements the - library's :phpclass:`Exception ` interface. + library's :phpclass:`Exception ` interface. ---- MongoDB\\Exception\\UnsupportedException ---------------------------------------- -.. phpclass:: MongoDB\\Exception\\UnsupportedException +.. phpclass:: MongoDB\Exception\UnsupportedException This exception is thrown if an option is used and not supported by the selected server. It is used sparingly in cases where silently ignoring the unsupported option might otherwise lead to unexpected behavior. This class extends the library's :phpclass:`RuntimeException - ` class. + ` class. .. note:: Unlike :phpclass:`InvalidArgumentException - `, which may be thrown when + `, which may be thrown when an operation's parameters and options are parsed during construction, the selected server is not known until an operation is executed. @@ -100,7 +100,7 @@ MongoDB\\Exception\\UnsupportedException MongoDB\\GridFS\\Exception\\CorruptFileException ------------------------------------------------ -.. phpclass:: MongoDB\\GridFS\\Exception\\CorruptFileException +.. phpclass:: MongoDB\GridFS\Exception\CorruptFileException This exception is thrown if a GridFS file's metadata or chunk documents contain unexpected or invalid data. @@ -111,27 +111,27 @@ MongoDB\\GridFS\\Exception\\CorruptFileException sequence or its binary data's length out of range. This class extends the library's :phpclass:`RuntimeException - ` class. + ` class. ---- MongoDB\\GridFS\\Exception\\FileNotFoundException ------------------------------------------------- -.. phpclass:: MongoDB\\GridFS\\Exception\\FileNotFoundException +.. phpclass:: MongoDB\GridFS\Exception\FileNotFoundException This exception is thrown if no GridFS file was found for the selection criteria (e.g. ``id``, ``filename``). This class extends the library's :phpclass:`RuntimeException - ` class. + ` class. ---- MongoDB\\Exception\\Exception ----------------------------- -.. phpclass:: MongoDB\\Exception\\Exception +.. phpclass:: MongoDB\Exception\Exception This interface extends the driver's :php:`Exception ` interface and is implemented by all @@ -142,7 +142,7 @@ MongoDB\\Exception\\Exception MongoDB\\Exception\\RuntimeException ------------------------------------ -.. phpclass:: MongoDB\\Exception\\RuntimeException +.. phpclass:: MongoDB\Exception\RuntimeException This class extends the driver's :php:`RuntimeException ` class, which in turn extends diff --git a/docs/reference/function/with_transaction.txt b/docs/reference/function/with_transaction.txt index 438ea7a13..b759025ef 100644 --- a/docs/reference/function/with_transaction.txt +++ b/docs/reference/function/with_transaction.txt @@ -15,7 +15,7 @@ MongoDB\\with_transaction() Definition ---------- -.. phpmethod:: MongoDB\\with_transaction() +.. phpmethod:: MongoDB\with_transaction() Execute a callback within a transaction using the given client session @@ -30,17 +30,17 @@ Definition Parameters ---------- -``$session`` : :php:`MongoDB\\Driver\\Session ` +``$session`` : :php:`MongoDB\Driver\Session ` A client session used to execute the transaction. ``$callback`` : :php:`callable ` A callback that will be run inside the transaction. The callback must accept a - :php:`MongoDB\\Driver\\Session ` object as its first + :php:`MongoDB\Driver\Session ` object as its first argument. ``$transactionOptions`` : array Transaction options, which will be passed to - :php:`MongoDB\\Driver\\Session::startTransaction `. + :php:`MongoDB\Driver\Session::startTransaction `. See the extension documentation for a list of supported options. Behavior @@ -50,7 +50,7 @@ This function is responsible for starting a transaction, invoking a callback, and committing a transaction. It also applies logic to retry this process after certain errors within a preset time limit. The callback is expected to execute one or more operations within the transactionby passing the callback's -:php:`MongoDB\\Driver\\Session ` argument as an option to +:php:`MongoDB\Driver\Session ` argument as an option to those operations; however, that is not enforced. .. note:: @@ -89,7 +89,7 @@ Errors/Exceptions See Also -------- -- :php:`MongoDB\\Driver\\Session::startTransaction ` -- :php:`MongoDB\\Driver\\Session::commitTransaction ` +- :php:`MongoDB\Driver\Session::startTransaction ` +- :php:`MongoDB\Driver\Session::commitTransaction ` - :manual:`Transactions: Drivers API ` documentation in the MongoDB manual - `Convenient API for Transactions `_ specification diff --git a/docs/reference/functions.txt b/docs/reference/functions.txt index ca1aadf33..0ee5966e6 100644 --- a/docs/reference/functions.txt +++ b/docs/reference/functions.txt @@ -15,4 +15,4 @@ Functions with_transaction() -- :phpmethod:`MongoDB\\with_transaction()` +- :phpmethod:`MongoDB\with_transaction()` diff --git a/docs/reference/method/MongoDBBulkWriteResult-getDeletedCount.txt b/docs/reference/method/MongoDBBulkWriteResult-getDeletedCount.txt index d0501d3f5..8dbe98d5f 100644 --- a/docs/reference/method/MongoDBBulkWriteResult-getDeletedCount.txt +++ b/docs/reference/method/MongoDBBulkWriteResult-getDeletedCount.txt @@ -13,7 +13,7 @@ MongoDB\\BulkWriteResult::getDeletedCount() Definition ---------- -.. phpmethod:: MongoDB\\BulkWriteResult::getDeletedCount() +.. phpmethod:: MongoDB\BulkWriteResult::getDeletedCount() Return the total number of documents that were deleted by all delete operations in the bulk write. @@ -38,5 +38,5 @@ Errors/Exceptions See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::getDeletedCount() +- :php:`MongoDB\Driver\WriteResult::getDeletedCount() ` diff --git a/docs/reference/method/MongoDBBulkWriteResult-getInsertedCount.txt b/docs/reference/method/MongoDBBulkWriteResult-getInsertedCount.txt index 6eb1b5de1..8d9a4ed8f 100644 --- a/docs/reference/method/MongoDBBulkWriteResult-getInsertedCount.txt +++ b/docs/reference/method/MongoDBBulkWriteResult-getInsertedCount.txt @@ -13,7 +13,7 @@ MongoDB\\BulkWriteResult::getInsertedCount() Definition ---------- -.. phpmethod:: MongoDB\\BulkWriteResult::getInsertedCount() +.. phpmethod:: MongoDB\BulkWriteResult::getInsertedCount() Return the total number of documents that were inserted by all insert operations in the bulk write. @@ -38,5 +38,5 @@ Errors/Exceptions See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::getInsertedCount() +- :php:`MongoDB\Driver\WriteResult::getInsertedCount() ` diff --git a/docs/reference/method/MongoDBBulkWriteResult-getInsertedIds.txt b/docs/reference/method/MongoDBBulkWriteResult-getInsertedIds.txt index bcbcd536d..bb6752ff0 100644 --- a/docs/reference/method/MongoDBBulkWriteResult-getInsertedIds.txt +++ b/docs/reference/method/MongoDBBulkWriteResult-getInsertedIds.txt @@ -13,7 +13,7 @@ MongoDB\\BulkWriteResult::getInsertedIds() Definition ---------- -.. phpmethod:: MongoDB\\BulkWriteResult::getInsertedIds() +.. phpmethod:: MongoDB\BulkWriteResult::getInsertedIds() Return a map of IDs (i.e. ``_id`` field values) for documents that were inserted by all insert operations in the bulk write. @@ -34,5 +34,5 @@ insert operations in the bulk write. The index of each ID in the map corresponds to each document's position in the bulk operation. If a document had an ID prior to inserting (i.e. the driver did not generate an ID), the index will contain its ``_id`` field value. Any -driver-generated ID will be a :php:`MongoDB\\BSON\\ObjectId +driver-generated ID will be a :php:`MongoDB\BSON\ObjectId ` instance. diff --git a/docs/reference/method/MongoDBBulkWriteResult-getMatchedCount.txt b/docs/reference/method/MongoDBBulkWriteResult-getMatchedCount.txt index af1ad98f6..02341bedf 100644 --- a/docs/reference/method/MongoDBBulkWriteResult-getMatchedCount.txt +++ b/docs/reference/method/MongoDBBulkWriteResult-getMatchedCount.txt @@ -13,7 +13,7 @@ MongoDB\\BulkWriteResult::getMatchedCount() Definition ---------- -.. phpmethod:: MongoDB\\BulkWriteResult::getMatchedCount() +.. phpmethod:: MongoDB\BulkWriteResult::getMatchedCount() Return the total number of documents that were matched by all update and replace operations in the bulk write. @@ -30,7 +30,7 @@ Definition (e.g. setting the value of a field to its current value), the matched count may be greater than the value returned by :phpmethod:`getModifiedCount() - `. + `. Return Values ------------- @@ -46,6 +46,6 @@ Errors/Exceptions See Also -------- -- :phpmethod:`MongoDB\\BulkWriteResult::getModifiedCount()` -- :php:`MongoDB\\Driver\\WriteResult::getMatchedCount() +- :phpmethod:`MongoDB\BulkWriteResult::getModifiedCount()` +- :php:`MongoDB\Driver\WriteResult::getMatchedCount() ` diff --git a/docs/reference/method/MongoDBBulkWriteResult-getModifiedCount.txt b/docs/reference/method/MongoDBBulkWriteResult-getModifiedCount.txt index da115c5ff..6f179bd88 100644 --- a/docs/reference/method/MongoDBBulkWriteResult-getModifiedCount.txt +++ b/docs/reference/method/MongoDBBulkWriteResult-getModifiedCount.txt @@ -13,7 +13,7 @@ MongoDB\\BulkWriteResult::getModifiedCount() Definition ---------- -.. phpmethod:: MongoDB\\BulkWriteResult::getModifiedCount() +.. phpmethod:: MongoDB\BulkWriteResult::getModifiedCount() Return the total number of documents that were modified by all update and replace operations in the bulk write. @@ -29,7 +29,7 @@ Definition If an update/replace operation results in no change to the document (e.g. setting the value of a field to its current value), the modified count may be less than the value returned by :phpmethod:`getMatchedCount() - `. + `. Return Values ------------- @@ -45,6 +45,6 @@ Errors/Exceptions See Also -------- -- :phpmethod:`MongoDB\\BulkWriteResult::getMatchedCount()` -- :php:`MongoDB\\Driver\\WriteResult::getModifiedCount() +- :phpmethod:`MongoDB\BulkWriteResult::getMatchedCount()` +- :php:`MongoDB\Driver\WriteResult::getModifiedCount() ` diff --git a/docs/reference/method/MongoDBBulkWriteResult-getUpsertedCount.txt b/docs/reference/method/MongoDBBulkWriteResult-getUpsertedCount.txt index 1f0dff2b9..00f1ff1fc 100644 --- a/docs/reference/method/MongoDBBulkWriteResult-getUpsertedCount.txt +++ b/docs/reference/method/MongoDBBulkWriteResult-getUpsertedCount.txt @@ -13,7 +13,7 @@ MongoDB\\BulkWriteResult::getUpsertedCount() Definition ---------- -.. phpmethod:: MongoDB\\BulkWriteResult::getUpsertedCount() +.. phpmethod:: MongoDB\BulkWriteResult::getUpsertedCount() Return the total number of documents that were upserted by all update and replace operations in the bulk write. @@ -38,5 +38,5 @@ Errors/Exceptions See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::getUpsertedCount() +- :php:`MongoDB\Driver\WriteResult::getUpsertedCount() ` diff --git a/docs/reference/method/MongoDBBulkWriteResult-getUpsertedIds.txt b/docs/reference/method/MongoDBBulkWriteResult-getUpsertedIds.txt index 6abad98f2..df0b1fbbe 100644 --- a/docs/reference/method/MongoDBBulkWriteResult-getUpsertedIds.txt +++ b/docs/reference/method/MongoDBBulkWriteResult-getUpsertedIds.txt @@ -13,7 +13,7 @@ MongoDB\\BulkWriteResult::getUpsertedIds() Definition ---------- -.. phpmethod:: MongoDB\\BulkWriteResult::getUpsertedIds() +.. phpmethod:: MongoDB\BulkWriteResult::getUpsertedIds() Return a map of IDs (i.e. ``_id`` field values) for documents that were upserted by all update and replace operations in the bulk write. @@ -31,7 +31,7 @@ update and replace operations in the bulk write. The index of each ID in the map corresponds to each document's position in the bulk operation. If a document had an ID prior to upserting (i.e. the server did not generate an ID), the index will contain its ``_id`` field value. Any -server-generated ID will be a :php:`MongoDB\\BSON\\ObjectId +server-generated ID will be a :php:`MongoDB\BSON\ObjectId ` instance. Errors/Exceptions @@ -42,5 +42,5 @@ Errors/Exceptions See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::getUpsertedIds() +- :php:`MongoDB\Driver\WriteResult::getUpsertedIds() ` diff --git a/docs/reference/method/MongoDBBulkWriteResult-isAcknowledged.txt b/docs/reference/method/MongoDBBulkWriteResult-isAcknowledged.txt index 1a857caaa..611f9fa78 100644 --- a/docs/reference/method/MongoDBBulkWriteResult-isAcknowledged.txt +++ b/docs/reference/method/MongoDBBulkWriteResult-isAcknowledged.txt @@ -13,7 +13,7 @@ MongoDB\\BulkWriteResult::isAcknowledged() Definition ---------- -.. phpmethod:: MongoDB\\BulkWriteResult::isAcknowledged() +.. phpmethod:: MongoDB\BulkWriteResult::isAcknowledged() Return whether the write was acknowledged. @@ -29,6 +29,6 @@ A boolean indicating whether the write was acknowledged. See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::isAcknowledged() +- :php:`MongoDB\Driver\WriteResult::isAcknowledged() ` - :manual:`Write Concern ` in the MongoDB manual diff --git a/docs/reference/method/MongoDBChangeStream-current.txt b/docs/reference/method/MongoDBChangeStream-current.txt index a85786073..ccff68e05 100644 --- a/docs/reference/method/MongoDBChangeStream-current.txt +++ b/docs/reference/method/MongoDBChangeStream-current.txt @@ -13,7 +13,7 @@ MongoDB\\ChangeStream::current() Definition ---------- -.. phpmethod:: MongoDB\\ChangeStream::current() +.. phpmethod:: MongoDB\ChangeStream::current() Returns the current event in the change stream. @@ -29,9 +29,9 @@ Return Values ------------- An array or object for the current event in the change stream, or ``null`` if -there is no current event (i.e. :phpmethod:`MongoDB\\ChangeStream::valid()` +there is no current event (i.e. :phpmethod:`MongoDB\ChangeStream::valid()` returns ``false``). The return type will depend on the ``typeMap`` option for -:phpmethod:`MongoDB\\Collection::watch()`. +:phpmethod:`MongoDB\Collection::watch()`. Examples -------- @@ -96,9 +96,9 @@ script was iterating the change stream, the output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Client::watch()` -- :phpmethod:`MongoDB\\Collection::watch()` -- :phpmethod:`MongoDB\\Database::watch()` +- :phpmethod:`MongoDB\Client::watch()` +- :phpmethod:`MongoDB\Collection::watch()` +- :phpmethod:`MongoDB\Database::watch()` - :php:`Iterator::current() ` - :ref:`Tailable Cursor Iteration ` - :manual:`Change Streams ` documentation in the MongoDB manual diff --git a/docs/reference/method/MongoDBChangeStream-getCursorId.txt b/docs/reference/method/MongoDBChangeStream-getCursorId.txt index e7004f441..066930e10 100644 --- a/docs/reference/method/MongoDBChangeStream-getCursorId.txt +++ b/docs/reference/method/MongoDBChangeStream-getCursorId.txt @@ -13,7 +13,7 @@ MongoDB\\ChangeStream::getCursorId() Definition ---------- -.. phpmethod:: MongoDB\\ChangeStream::getCursorId() +.. phpmethod:: MongoDB\ChangeStream::getCursorId() Returns the change stream cursor's ID. @@ -24,7 +24,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\CursorId ` object. +A :php:`MongoDB\Driver\CursorId ` object. Examples -------- @@ -55,8 +55,8 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Client::watch()` -- :phpmethod:`MongoDB\\Collection::watch()` -- :phpmethod:`MongoDB\\Database::watch()` -- :php:`MongoDB\\Driver\\CursorId ` -- :php:`MongoDB\\Driver\\Cursor::getId() ` +- :phpmethod:`MongoDB\Client::watch()` +- :phpmethod:`MongoDB\Collection::watch()` +- :phpmethod:`MongoDB\Database::watch()` +- :php:`MongoDB\Driver\CursorId ` +- :php:`MongoDB\Driver\Cursor::getId() ` diff --git a/docs/reference/method/MongoDBChangeStream-getResumeToken.txt b/docs/reference/method/MongoDBChangeStream-getResumeToken.txt index 0930d45cf..873e29bb8 100644 --- a/docs/reference/method/MongoDBChangeStream-getResumeToken.txt +++ b/docs/reference/method/MongoDBChangeStream-getResumeToken.txt @@ -15,7 +15,7 @@ MongoDB\\ChangeStream::getResumeToken() Definition ---------- -.. phpmethod:: MongoDB\\ChangeStream::getResumeToken() +.. phpmethod:: MongoDB\ChangeStream::getResumeToken() Returns the cached resume token that will be used to resume the change stream. @@ -68,8 +68,8 @@ the ``startAfter`` option. See Also -------- -- :phpmethod:`MongoDB\\Client::watch()` -- :phpmethod:`MongoDB\\Collection::watch()` -- :phpmethod:`MongoDB\\Database::watch()` +- :phpmethod:`MongoDB\Client::watch()` +- :phpmethod:`MongoDB\Collection::watch()` +- :phpmethod:`MongoDB\Database::watch()` - :manual:`Resume a Change Stream ` documentation in the MongoDB manual diff --git a/docs/reference/method/MongoDBChangeStream-key.txt b/docs/reference/method/MongoDBChangeStream-key.txt index de4754b4f..8b35616fd 100644 --- a/docs/reference/method/MongoDBChangeStream-key.txt +++ b/docs/reference/method/MongoDBChangeStream-key.txt @@ -13,7 +13,7 @@ MongoDB\\ChangeStream::key() Definition ---------- -.. phpmethod:: MongoDB\\ChangeStream::key() +.. phpmethod:: MongoDB\ChangeStream::key() Returns the index of the current event in the change stream. @@ -28,7 +28,7 @@ Return Values ------------- The index of the current event in the change stream, or ``null`` if there is no -current event (i.e. :phpmethod:`MongoDB\\ChangeStream::valid()` returns +current event (i.e. :phpmethod:`MongoDB\ChangeStream::valid()` returns ``false``). Examples @@ -68,9 +68,9 @@ script was iterating the change stream, the output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Client::watch()` -- :phpmethod:`MongoDB\\Collection::watch()` -- :phpmethod:`MongoDB\\Database::watch()` +- :phpmethod:`MongoDB\Client::watch()` +- :phpmethod:`MongoDB\Collection::watch()` +- :phpmethod:`MongoDB\Database::watch()` - :php:`Iterator::key() ` - :ref:`Tailable Cursor Iteration ` - :manual:`Change Streams ` documentation in the MongoDB manual diff --git a/docs/reference/method/MongoDBChangeStream-next.txt b/docs/reference/method/MongoDBChangeStream-next.txt index c25f039b3..559ae4cb1 100644 --- a/docs/reference/method/MongoDBChangeStream-next.txt +++ b/docs/reference/method/MongoDBChangeStream-next.txt @@ -13,7 +13,7 @@ MongoDB\\ChangeStream::next() Definition ---------- -.. phpmethod:: MongoDB\\ChangeStream::next() +.. phpmethod:: MongoDB\ChangeStream::next() Advances the change stream and attempts to load the next event. @@ -25,7 +25,7 @@ Definition Advancing the change stream does not guarantee that there will be a current event to access. You should still call - :phpmethod:`MongoDB\\ChangeStream::valid()` to check for a current event + :phpmethod:`MongoDB\ChangeStream::valid()` to check for a current event at each step of iteration. Errors/Exceptions @@ -36,9 +36,9 @@ Errors/Exceptions See Also -------- -- :phpmethod:`MongoDB\\Client::watch()` -- :phpmethod:`MongoDB\\Collection::watch()` -- :phpmethod:`MongoDB\\Database::watch()` +- :phpmethod:`MongoDB\Client::watch()` +- :phpmethod:`MongoDB\Collection::watch()` +- :phpmethod:`MongoDB\Database::watch()` - :php:`Iterator::next() ` - :ref:`Tailable Cursor Iteration ` - :manual:`Change Streams ` documentation in the MongoDB manual diff --git a/docs/reference/method/MongoDBChangeStream-rewind.txt b/docs/reference/method/MongoDBChangeStream-rewind.txt index e59a1399b..066e99aaf 100644 --- a/docs/reference/method/MongoDBChangeStream-rewind.txt +++ b/docs/reference/method/MongoDBChangeStream-rewind.txt @@ -13,7 +13,7 @@ MongoDB\\ChangeStream::rewind() Definition ---------- -.. phpmethod:: MongoDB\\ChangeStream::rewind() +.. phpmethod:: MongoDB\ChangeStream::rewind() Rewinds the change stream and attempts to load the first event. @@ -27,18 +27,18 @@ Definition Rewinding the change stream does not guarantee that there will be a current event to access. You should still call - :phpmethod:`MongoDB\\ChangeStream::valid()` to check for a current event + :phpmethod:`MongoDB\ChangeStream::valid()` to check for a current event at each step of iteration. After initially rewinding the change stream, - :phpmethod:`MongoDB\\ChangeStream::next()` should be used to iterate + :phpmethod:`MongoDB\ChangeStream::next()` should be used to iterate further. Errors/Exceptions ----------------- -:php:`MongoDB\\Driver\\Exception\\LogicException +:php:`MongoDB\Driver\Exception\LogicException ` if this method is called after a call -to :phpmethod:`MongoDB\\ChangeStream::next()` (i.e. the underlying -:php:`MongoDB\\Driver\\Cursor ` has already been +to :phpmethod:`MongoDB\ChangeStream::next()` (i.e. the underlying +:php:`MongoDB\Driver\Cursor ` has already been advanced). .. include:: /includes/extracts/error-driver-runtimeexception.rst @@ -46,9 +46,9 @@ advanced). See Also -------- -- :phpmethod:`MongoDB\\Client::watch()` -- :phpmethod:`MongoDB\\Collection::watch()` -- :phpmethod:`MongoDB\\Database::watch()` +- :phpmethod:`MongoDB\Client::watch()` +- :phpmethod:`MongoDB\Collection::watch()` +- :phpmethod:`MongoDB\Database::watch()` - :php:`Iterator::rewind() ` - :ref:`Tailable Cursor Iteration ` - :manual:`Change Streams ` documentation in the MongoDB manual diff --git a/docs/reference/method/MongoDBChangeStream-valid.txt b/docs/reference/method/MongoDBChangeStream-valid.txt index 69ea1cd68..bab45f1fc 100644 --- a/docs/reference/method/MongoDBChangeStream-valid.txt +++ b/docs/reference/method/MongoDBChangeStream-valid.txt @@ -13,7 +13,7 @@ MongoDB\\ChangeStream::valid() Definition ---------- -.. phpmethod:: MongoDB\\ChangeStream::valid() +.. phpmethod:: MongoDB\ChangeStream::valid() Returns whether there is a current event in the change stream. @@ -23,8 +23,8 @@ Definition When manually iterating the change stream using :php:`Iterator ` methods, this method should - be used to determine if :phpmethod:`MongoDB\\ChangeStream::current()` and - :phpmethod:`MongoDB\\ChangeStream::key()` can be called. + be used to determine if :phpmethod:`MongoDB\ChangeStream::current()` and + :phpmethod:`MongoDB\ChangeStream::key()` can be called. Return Values ------------- @@ -34,9 +34,9 @@ A boolean indicating whether there is a current event in the change stream. See Also -------- -- :phpmethod:`MongoDB\\Client::watch()` -- :phpmethod:`MongoDB\\Collection::watch()` -- :phpmethod:`MongoDB\\Database::watch()` +- :phpmethod:`MongoDB\Client::watch()` +- :phpmethod:`MongoDB\Collection::watch()` +- :phpmethod:`MongoDB\Database::watch()` - :php:`Iterator::valid() ` - :ref:`Tailable Cursor Iteration ` - :manual:`Change Streams ` documentation in the MongoDB manual diff --git a/docs/reference/method/MongoDBClient-createClientEncryption.txt b/docs/reference/method/MongoDBClient-createClientEncryption.txt index 0dd925cd1..ef0d2529e 100644 --- a/docs/reference/method/MongoDBClient-createClientEncryption.txt +++ b/docs/reference/method/MongoDBClient-createClientEncryption.txt @@ -13,9 +13,9 @@ MongoDB\\Client::createClientEncryption() Definition ---------- -.. phpmethod:: MongoDB\\Client::createClientEncryption() +.. phpmethod:: MongoDB\Client::createClientEncryption() - Returns a :php:`MongoDB\\Driver\\ClientEncryption ` + Returns a :php:`MongoDB\Driver\ClientEncryption ` object for manual encryption and decryption of values. .. code-block:: php @@ -27,18 +27,18 @@ Parameters ``$options`` : array An array specifying the desired options. Refer to the - :php:`MongoDB\\Driver\\Manager::createClientEncryption() ` + :php:`MongoDB\Driver\Manager::createClientEncryption() ` extension documentation for a list of supported options. - If a :phpclass:`MongoDB\\Client` is provided for the ``keyVaultClient`` + If a :phpclass:`MongoDB\Client` is provided for the ``keyVaultClient`` option, it will be unwrapped into a - :php:`MongoDB\\Driver\\Manager ` for the + :php:`MongoDB\Driver\Manager ` for the extension. Return Values ------------- -A :php:`MongoDB\\Driver\\ClientEncryption ` +A :php:`MongoDB\Driver\ClientEncryption ` instance which can be used to encrypt and decrypt values. Errors/Exceptions @@ -50,5 +50,5 @@ Errors/Exceptions See Also -------- -- :php:`MongoDB\\Driver\\Manager::createClientEncryption() +- :php:`MongoDB\Driver\Manager::createClientEncryption() ` diff --git a/docs/reference/method/MongoDBClient-dropDatabase.txt b/docs/reference/method/MongoDBClient-dropDatabase.txt index 5a2687651..9545ed496 100644 --- a/docs/reference/method/MongoDBClient-dropDatabase.txt +++ b/docs/reference/method/MongoDBClient-dropDatabase.txt @@ -13,7 +13,7 @@ MongoDB\\Client::dropDatabase() Definition ---------- -.. phpmethod:: MongoDB\\Client::dropDatabase() +.. phpmethod:: MongoDB\Client::dropDatabase() Drop a database on the server. @@ -47,7 +47,7 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -59,7 +59,7 @@ Parameters This will be used for the returned command result document. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/client-option-writeConcern.rst Return Values @@ -108,6 +108,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Database::drop()` +- :phpmethod:`MongoDB\Database::drop()` - :manual:`dropDatabase ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBClient-getManager.txt b/docs/reference/method/MongoDBClient-getManager.txt index c320595d3..9618beca0 100644 --- a/docs/reference/method/MongoDBClient-getManager.txt +++ b/docs/reference/method/MongoDBClient-getManager.txt @@ -13,11 +13,11 @@ MongoDB\\Client::getManager() Definition ---------- -.. phpmethod:: MongoDB\\Client::getManager() +.. phpmethod:: MongoDB\Client::getManager() Accessor for the - :php:`MongoDB\\Driver\\Manager ` used by this - :phpclass:`Client `. + :php:`MongoDB\Driver\Manager ` used by this + :phpclass:`Client `. .. code-block:: php @@ -26,10 +26,10 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\Manager ` object. +A :php:`MongoDB\Driver\Manager ` object. See Also -------- -- :phpmethod:`MongoDB\\Collection::getManager()` -- :phpmethod:`MongoDB\\Database::getManager()` +- :phpmethod:`MongoDB\Collection::getManager()` +- :phpmethod:`MongoDB\Database::getManager()` diff --git a/docs/reference/method/MongoDBClient-getReadConcern.txt b/docs/reference/method/MongoDBClient-getReadConcern.txt index 64f2b3d4a..89643bd56 100644 --- a/docs/reference/method/MongoDBClient-getReadConcern.txt +++ b/docs/reference/method/MongoDBClient-getReadConcern.txt @@ -15,7 +15,7 @@ MongoDB\\Client::getReadConcern() Definition ---------- -.. phpmethod:: MongoDB\\Client::getReadConcern() +.. phpmethod:: MongoDB\Client::getReadConcern() Returns the read concern for this client. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\ReadConcern ` object. +A :php:`MongoDB\Driver\ReadConcern ` object. Example ------- @@ -54,7 +54,7 @@ See Also -------- - :manual:`Read Concern ` in the MongoDB manual -- :php:`MongoDB\\Driver\\ReadConcern::isDefault() ` -- :phpmethod:`MongoDB\\Collection::getReadConcern()` -- :phpmethod:`MongoDB\\Database::getReadConcern()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()` +- :php:`MongoDB\Driver\ReadConcern::isDefault() ` +- :phpmethod:`MongoDB\Collection::getReadConcern()` +- :phpmethod:`MongoDB\Database::getReadConcern()` +- :phpmethod:`MongoDB\GridFS\Bucket::getReadConcern()` diff --git a/docs/reference/method/MongoDBClient-getReadPreference.txt b/docs/reference/method/MongoDBClient-getReadPreference.txt index cd00f206c..564d108f7 100644 --- a/docs/reference/method/MongoDBClient-getReadPreference.txt +++ b/docs/reference/method/MongoDBClient-getReadPreference.txt @@ -15,7 +15,7 @@ MongoDB\\Client::getReadPreference() Definition ---------- -.. phpmethod:: MongoDB\\Client::getReadPreference() +.. phpmethod:: MongoDB\Client::getReadPreference() Returns the read preference for this client. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\ReadPreference ` +A :php:`MongoDB\Driver\ReadPreference ` object. Example @@ -55,6 +55,6 @@ See Also -------- - :manual:`Read Preference ` in the MongoDB manual -- :phpmethod:`MongoDB\\Collection::getReadPreference()` -- :phpmethod:`MongoDB\\Database::getReadPreference()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()` +- :phpmethod:`MongoDB\Collection::getReadPreference()` +- :phpmethod:`MongoDB\Database::getReadPreference()` +- :phpmethod:`MongoDB\GridFS\Bucket::getReadPreference()` diff --git a/docs/reference/method/MongoDBClient-getTypeMap.txt b/docs/reference/method/MongoDBClient-getTypeMap.txt index 138444f06..89c620aff 100644 --- a/docs/reference/method/MongoDBClient-getTypeMap.txt +++ b/docs/reference/method/MongoDBClient-getTypeMap.txt @@ -15,7 +15,7 @@ MongoDB\\Client::getTypeMap() Definition ---------- -.. phpmethod:: MongoDB\\Client::getTypeMap() +.. phpmethod:: MongoDB\Client::getTypeMap() Returns the type map for this client. @@ -62,6 +62,6 @@ See Also -------- - :doc:`/reference/bson` -- :phpmethod:`MongoDB\\Collection::getTypeMap()` -- :phpmethod:`MongoDB\\Database::getTypeMap()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()` +- :phpmethod:`MongoDB\Collection::getTypeMap()` +- :phpmethod:`MongoDB\Database::getTypeMap()` +- :phpmethod:`MongoDB\GridFS\Bucket::getTypeMap()` diff --git a/docs/reference/method/MongoDBClient-getWriteConcern.txt b/docs/reference/method/MongoDBClient-getWriteConcern.txt index 7a3e561c6..270707f08 100644 --- a/docs/reference/method/MongoDBClient-getWriteConcern.txt +++ b/docs/reference/method/MongoDBClient-getWriteConcern.txt @@ -15,7 +15,7 @@ MongoDB\\Client::getWriteConcern() Definition ---------- -.. phpmethod:: MongoDB\\Client::getWriteConcern() +.. phpmethod:: MongoDB\Client::getWriteConcern() Returns the write concern for this client. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\WriteConcern ` +A :php:`MongoDB\Driver\WriteConcern ` object. Example @@ -55,7 +55,7 @@ See Also -------- - :manual:`Write Concern ` in the MongoDB manual -- :php:`MongoDB\\Driver\\WriteConcern::isDefault() ` -- :phpmethod:`MongoDB\\Collection::getWriteConcern()` -- :phpmethod:`MongoDB\\Database::getWriteConcern()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()` +- :php:`MongoDB\Driver\WriteConcern::isDefault() ` +- :phpmethod:`MongoDB\Collection::getWriteConcern()` +- :phpmethod:`MongoDB\Database::getWriteConcern()` +- :phpmethod:`MongoDB\GridFS\Bucket::getWriteConcern()` diff --git a/docs/reference/method/MongoDBClient-listDatabaseNames.txt b/docs/reference/method/MongoDBClient-listDatabaseNames.txt index cac7d22c6..bdb7e095f 100644 --- a/docs/reference/method/MongoDBClient-listDatabaseNames.txt +++ b/docs/reference/method/MongoDBClient-listDatabaseNames.txt @@ -15,7 +15,7 @@ MongoDB\\Client::listDatabaseNames() Definition ---------- -.. phpmethod:: MongoDB\\Client::listDatabaseNames() +.. phpmethod:: MongoDB\Client::listDatabaseNames() Returns names for all databases on the server. @@ -69,7 +69,7 @@ Parameters - .. include:: /includes/extracts/common-option-maxTimeMS.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -112,7 +112,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Client::listDatabases()` +- :phpmethod:`MongoDB\Client::listDatabases()` - :manual:`listDatabases ` command reference in the MongoDB manual - `Enumerating Databases diff --git a/docs/reference/method/MongoDBClient-listDatabases.txt b/docs/reference/method/MongoDBClient-listDatabases.txt index dd6b2da84..93a4d65aa 100644 --- a/docs/reference/method/MongoDBClient-listDatabases.txt +++ b/docs/reference/method/MongoDBClient-listDatabases.txt @@ -13,7 +13,7 @@ MongoDB\\Client::listDatabases() Definition ---------- -.. phpmethod:: MongoDB\\Client::listDatabases() +.. phpmethod:: MongoDB\Client::listDatabases() Returns information for all databases on the server. @@ -67,7 +67,7 @@ Parameters - .. include:: /includes/extracts/common-option-maxTimeMS.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -77,8 +77,8 @@ Parameters Return Values ------------- -A traversable :phpclass:`MongoDB\\Model\\DatabaseInfoIterator`, which contains -a :phpclass:`MongoDB\\Model\\DatabaseInfo` object for each database on the +A traversable :phpclass:`MongoDB\Model\DatabaseInfoIterator`, which contains +a :phpclass:`MongoDB\Model\DatabaseInfo` object for each database on the server. Errors/Exceptions @@ -127,7 +127,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Client::listDatabaseNames()` +- :phpmethod:`MongoDB\Client::listDatabaseNames()` - :manual:`listDatabases ` command reference in the MongoDB manual - `Enumerating Databases diff --git a/docs/reference/method/MongoDBClient-selectCollection.txt b/docs/reference/method/MongoDBClient-selectCollection.txt index 6700f0233..e7e58e865 100644 --- a/docs/reference/method/MongoDBClient-selectCollection.txt +++ b/docs/reference/method/MongoDBClient-selectCollection.txt @@ -13,7 +13,7 @@ MongoDB\\Client::selectCollection() Definition ---------- -.. phpmethod:: MongoDB\\Client::selectCollection() +.. phpmethod:: MongoDB\Client::selectCollection() Selects a collection on the server. @@ -46,12 +46,12 @@ Parameters - Description * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - The default read concern to use for collection operations. Defaults to the client's read concern. * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - The default read preference to use for collection operations. Defaults to the client's read preference. @@ -61,14 +61,14 @@ Parameters client's type map. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - The default write concern to use for collection operations. Defaults to the client's write concern. Return Values ------------- -A :phpclass:`MongoDB\\Collection` object. +A :phpclass:`MongoDB\Collection` object. Errors/Exceptions ----------------- @@ -79,7 +79,7 @@ Behavior -------- The selected collection inherits options such as read preference and type -mapping from the :phpclass:`Client ` object. Options may be +mapping from the :phpclass:`Client ` object. Options may be overridden via the ``$options`` parameter. Example @@ -115,5 +115,5 @@ with a custom read preference: See Also -------- -- :phpmethod:`MongoDB\\Collection::__construct()` -- :phpmethod:`MongoDB\\Database::selectCollection()` +- :phpmethod:`MongoDB\Collection::__construct()` +- :phpmethod:`MongoDB\Database::selectCollection()` diff --git a/docs/reference/method/MongoDBClient-selectDatabase.txt b/docs/reference/method/MongoDBClient-selectDatabase.txt index b18145167..33c7ec32c 100644 --- a/docs/reference/method/MongoDBClient-selectDatabase.txt +++ b/docs/reference/method/MongoDBClient-selectDatabase.txt @@ -13,7 +13,7 @@ MongoDB\\Client::selectDatabase() Definition ---------- -.. phpmethod:: MongoDB\\Client::selectDatabase() +.. phpmethod:: MongoDB\Client::selectDatabase() Selects a database on the server. @@ -42,12 +42,12 @@ Parameters - Description * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - The default read concern to use for database operations. Defaults to the client's read concern. * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - The default read preference to use for database operations. Defaults to the client's read preference. @@ -57,14 +57,14 @@ Parameters client's type map. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - The default write concern to use for database operations. Defaults to the client's write concern. Return Values ------------- -A :phpclass:`MongoDB\\Database` object. +A :phpclass:`MongoDB\Database` object. Errors/Exceptions ----------------- @@ -75,7 +75,7 @@ Behavior -------- The selected database inherits options such as read preference and type mapping -from the :phpclass:`Client ` object. Options may be overridden +from the :phpclass:`Client ` object. Options may be overridden via the ``$options`` parameter. Example @@ -110,5 +110,5 @@ preference: See Also -------- -- :phpmethod:`MongoDB\\Client::__get()` -- :phpmethod:`MongoDB\\Database::__construct()` +- :phpmethod:`MongoDB\Client::__get()` +- :phpmethod:`MongoDB\Database::__construct()` diff --git a/docs/reference/method/MongoDBClient-startSession.txt b/docs/reference/method/MongoDBClient-startSession.txt index 8de00ee09..0e3d8eb15 100644 --- a/docs/reference/method/MongoDBClient-startSession.txt +++ b/docs/reference/method/MongoDBClient-startSession.txt @@ -15,7 +15,7 @@ MongoDB\\Client::startSession() Definition ---------- -.. phpmethod:: MongoDB\\Client::startSession() +.. phpmethod:: MongoDB\Client::startSession() Start a new client session for use with this client. @@ -28,7 +28,7 @@ Parameters ``$options`` : array An array specifying the desired options. Refer to the - :php:`MongoDB\\Driver\\Manager::startSession() ` + :php:`MongoDB\Driver\Manager::startSession() ` extension documentation for a list of supported options. Return Values @@ -83,6 +83,6 @@ The output would then resemble: See Also -------- -- :php:`MongoDB\\Driver\\Manager::startSession() +- :php:`MongoDB\Driver\Manager::startSession() ` - :ref:`Causal Consistency ` in the MongoDB manual diff --git a/docs/reference/method/MongoDBClient-watch.txt b/docs/reference/method/MongoDBClient-watch.txt index 2977475a6..1cee5f01c 100644 --- a/docs/reference/method/MongoDBClient-watch.txt +++ b/docs/reference/method/MongoDBClient-watch.txt @@ -15,7 +15,7 @@ MongoDB\\Client::watch() Definition ---------- -.. phpmethod:: MongoDB\\Client::watch() +.. phpmethod:: MongoDB\Client::watch() Executes a :manual:`change stream ` operation on the client. The change stream can be watched for cluster-level changes. @@ -73,11 +73,11 @@ Parameters - .. include:: /includes/extracts/watch-option-maxAwaitTimeMS.rst * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/client-option-readConcern.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/client-option-readPreference.rst This is used for both the initial change stream aggregation and for @@ -88,7 +88,7 @@ Parameters - .. include:: /includes/extracts/watch-option-resumeAfter.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst * - showExpandedEvents @@ -100,7 +100,7 @@ Parameters - .. include:: /includes/extracts/watch-option-startAfter.rst * - startAtOperationTime - - :php:`MongoDB\\BSON\\TimestampInterface ` + - :php:`MongoDB\BSON\TimestampInterface ` - .. include:: /includes/extracts/watch-option-startAtOperationTime.rst * - typeMap @@ -110,7 +110,7 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\ChangeStream` object, which allows for iteration of +A :phpclass:`MongoDB\ChangeStream` object, which allows for iteration of events in the change stream via the :php:`Iterator ` interface. Errors/Exceptions @@ -189,8 +189,8 @@ script was iterating the change stream, the output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::watch()` -- :phpmethod:`MongoDB\\Database::watch()` +- :phpmethod:`MongoDB\Collection::watch()` +- :phpmethod:`MongoDB\Database::watch()` - :manual:`Aggregation Pipeline ` documentation in the MongoDB Manual - :manual:`Change Streams ` documentation in the MongoDB manual diff --git a/docs/reference/method/MongoDBClient__construct.txt b/docs/reference/method/MongoDBClient__construct.txt index 1134df67b..a0f147703 100644 --- a/docs/reference/method/MongoDBClient__construct.txt +++ b/docs/reference/method/MongoDBClient__construct.txt @@ -13,9 +13,9 @@ MongoDB\\Client::__construct() Definition ---------- -.. phpmethod:: MongoDB\\Client::__construct() +.. phpmethod:: MongoDB\Client::__construct() - Constructs a new :phpclass:`Client ` instance. + Constructs a new :phpclass:`Client ` instance. .. code-block:: php @@ -49,7 +49,7 @@ Parameters over any analogous options present in the ``$uri`` string and do not need to be encoded according to `RFC 3986 `_. - Refer to the :php:`MongoDB\\Driver\\Manager::__construct() + Refer to the :php:`MongoDB\Driver\Manager::__construct() ` extension documentation for a list of supported options. @@ -75,9 +75,9 @@ Parameters :php:`extension documentation ` for a list of supported encryption options. - If a :phpclass:`MongoDB\\Client` is provided for the ``keyVaultClient`` + If a :phpclass:`MongoDB\Client` is provided for the ``keyVaultClient`` option, it will be unwrapped into a - :php:`MongoDB\\Driver\\Manager ` for the + :php:`MongoDB\Driver\Manager ` for the extension. .. versionadded:: 1.6 @@ -106,7 +106,7 @@ Parameters .. versionadded:: 1.7 * - serverApi - - :php:`MongoDB\\Driver\\ServerApi ` + - :php:`MongoDB\Driver\ServerApi ` - Used to declare an API version on the client. Refer to :manual:`Stable API tutorial ` for additional information. @@ -219,10 +219,10 @@ Errors/Exceptions Behavior -------- -A :php:`MongoDB\\Driver\\Manager ` is constructed +A :php:`MongoDB\Driver\Manager ` is constructed internally. Per the `Server Discovery and Monitoring `_ -specification, :php:`MongoDB\\Driver\\Manager::__construct() +specification, :php:`MongoDB\Driver\Manager::__construct() ` performs no I/O. Connections will be initialized on demand, when the first operation is executed. @@ -237,7 +237,7 @@ Connecting to a Standalone server If you do not specify a ``$uri`` value, the driver connects to a standalone :program:`mongod` on ``127.0.0.1`` via port ``27017``. To connect to a different server, pass the corresponding connection string as the first parameter when -creating the :phpclass:`Client ` instance: +creating the :phpclass:`Client ` instance: .. code-block:: php @@ -298,7 +298,7 @@ specified in the constructor's ``$uriOptions`` parameter: The driver supports additional :php:`SSL options `, which may be specified in the constructor's ``$driverOptions`` parameter. Those -options are covered in the :php:`MongoDB\\Driver\\Manager::__construct() +options are covered in the :php:`MongoDB\Driver\Manager::__construct() ` documentation. .. end-connecting-include @@ -307,8 +307,8 @@ Specifying a Custom Type Map ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ By default, the |php-library| deserializes BSON documents and arrays -as :phpclass:`MongoDB\\Model\\BSONDocument` and -:phpclass:`MongoDB\\Model\\BSONArray` objects, respectively. The following +as :phpclass:`MongoDB\Model\BSONDocument` and +:phpclass:`MongoDB\Model\BSONArray` objects, respectively. The following example demonstrates how to have the library unserialize everything as a PHP array, as was done in the legacy ``mongo`` extension. @@ -331,7 +331,7 @@ array, as was done in the legacy ``mongo`` extension. See Also -------- -- :php:`MongoDB\\Driver\\Manager::__construct() +- :php:`MongoDB\Driver\Manager::__construct() ` - :manual:`Connection String URI Format ` in the MongoDB manual diff --git a/docs/reference/method/MongoDBClient__get.txt b/docs/reference/method/MongoDBClient__get.txt index 88de4725f..d391b12ab 100644 --- a/docs/reference/method/MongoDBClient__get.txt +++ b/docs/reference/method/MongoDBClient__get.txt @@ -13,11 +13,11 @@ MongoDB\\Client::__get() Definition ---------- -.. phpmethod:: MongoDB\\Client::__get() +.. phpmethod:: MongoDB\Client::__get() Selects a database on the server. This :php:`magic method ` is an alias for the :phpmethod:`selectDatabase() - ` method. + ` method. .. code-block:: php @@ -32,21 +32,21 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\Database` object. +A :phpclass:`MongoDB\Database` object. Behavior -------- The selected database inherits options such as read preference and type mapping -from the :phpclass:`Client ` object. If you wish to override -any options, use the :phpmethod:`MongoDB\\Client::selectDatabase()` method. +from the :phpclass:`Client ` object. If you wish to override +any options, use the :phpmethod:`MongoDB\Client::selectDatabase()` method. .. note:: To select databases whose names contain special characters, such as ``-``, use complex syntax, as in ``$client->{'that-database'}``. - Alternatively, :phpmethod:`MongoDB\\Client::selectDatabase()` supports + Alternatively, :phpmethod:`MongoDB\Client::selectDatabase()` supports selecting databases whose names contain special characters. Examples @@ -66,6 +66,6 @@ The following example selects the ``test`` and ``another-app`` databases: See Also -------- -- :phpmethod:`MongoDB\\Client::selectDatabase()` -- :phpmethod:`MongoDB\\Database::__construct()` +- :phpmethod:`MongoDB\Client::selectDatabase()` +- :phpmethod:`MongoDB\Database::__construct()` - :php:`Property Overloading ` in the PHP Manual diff --git a/docs/reference/method/MongoDBCollection-aggregate.txt b/docs/reference/method/MongoDBCollection-aggregate.txt index ddb66889a..ef3f64117 100644 --- a/docs/reference/method/MongoDBCollection-aggregate.txt +++ b/docs/reference/method/MongoDBCollection-aggregate.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::aggregate() Definition ---------- -.. phpmethod:: MongoDB\\Collection::aggregate() +.. phpmethod:: MongoDB\Collection::aggregate() Executes an :manual:`aggregation framework pipeline ` operation on the collection. @@ -107,17 +107,17 @@ Parameters - .. include:: /includes/extracts/common-option-maxTimeMS.rst * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/collection-option-readConcern.rst .. include:: /includes/extracts/common-option-readConcern-transaction.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/collection-option-readPreference.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -127,7 +127,7 @@ Parameters - .. include:: /includes/extracts/collection-option-typeMap.rst * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -138,7 +138,7 @@ Parameters Return Values ------------- -A :php:`MongoDB\\Driver\\Cursor ` or +A :php:`MongoDB\Driver\Cursor ` or :php:`ArrayIterator ` object. In both cases, the return value will be :php:`Traversable `. @@ -155,9 +155,9 @@ Errors/Exceptions Behavior -------- -:phpmethod:`MongoDB\\Collection::aggregate()`'s return value depends on the +:phpmethod:`MongoDB\Collection::aggregate()`'s return value depends on the MongoDB server version and whether the ``useCursor`` option is specified. If -``useCursor`` is ``true``, a :php:`MongoDB\\Driver\\Cursor +``useCursor`` is ``true``, a :php:`MongoDB\Driver\Cursor ` object is returned. If ``useCursor`` is ``false``, an :php:`ArrayIterator ` is returned that wraps the ``result`` array from the command response document. In both cases, the return @@ -186,7 +186,7 @@ group, and sorts the results by name. See Also -------- -- :phpmethod:`MongoDB\\Database::aggregate()` +- :phpmethod:`MongoDB\Database::aggregate()` - :manual:`aggregate ` command reference in the MongoDB manual - :manual:`Aggregation Pipeline ` documentation in diff --git a/docs/reference/method/MongoDBCollection-bulkWrite.txt b/docs/reference/method/MongoDBCollection-bulkWrite.txt index a86e9cc6f..f76d6ca68 100644 --- a/docs/reference/method/MongoDBCollection-bulkWrite.txt +++ b/docs/reference/method/MongoDBCollection-bulkWrite.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::bulkWrite() Definition ---------- -.. phpmethod:: MongoDB\\Collection::bulkWrite() +.. phpmethod:: MongoDB\Collection::bulkWrite() Executes multiple write operations. @@ -29,13 +29,13 @@ Parameters ``$operations`` : array An array containing the write operations to perform. - :phpmethod:`MongoDB\\Collection::bulkWrite()` supports - :phpmethod:`deleteMany() `, - :phpmethod:`deleteOne() `, - :phpmethod:`insertOne() `, - :phpmethod:`replaceOne() `, - :phpmethod:`updateMany() `, and - :phpmethod:`updateOne() ` operations in the + :phpmethod:`MongoDB\Collection::bulkWrite()` supports + :phpmethod:`deleteMany() `, + :phpmethod:`deleteOne() `, + :phpmethod:`insertOne() `, + :phpmethod:`replaceOne() `, + :phpmethod:`updateMany() `, and + :phpmethod:`updateOne() ` operations in the following array structure: .. code-block:: php @@ -51,7 +51,7 @@ Parameters Arguments correspond to the respective operation methods. However, the ``writeConcern`` option is specified as a top-level option to - :phpmethod:`MongoDB\\Collection::bulkWrite()` instead of each individual + :phpmethod:`MongoDB\Collection::bulkWrite()` instead of each individual operation. ``$options`` : array @@ -95,13 +95,13 @@ Parameters The default is ``true``. * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -109,8 +109,8 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\BulkWriteResult` object, which encapsulates a -:php:`MongoDB\\Driver\\WriteResult ` object. +A :phpclass:`MongoDB\BulkWriteResult` object, which encapsulates a +:php:`MongoDB\Driver\WriteResult ` object. Errors/Exceptions ----------------- @@ -131,11 +131,11 @@ Behavior See Also -------- -- :phpmethod:`MongoDB\\Collection::deleteMany()` -- :phpmethod:`MongoDB\\Collection::deleteOne()` -- :phpmethod:`MongoDB\\Collection::insertMany()` -- :phpmethod:`MongoDB\\Collection::insertOne()` -- :phpmethod:`MongoDB\\Collection::replaceOne()` -- :phpmethod:`MongoDB\\Collection::updateMany()` -- :phpmethod:`MongoDB\\Collection::updateOne()` +- :phpmethod:`MongoDB\Collection::deleteMany()` +- :phpmethod:`MongoDB\Collection::deleteOne()` +- :phpmethod:`MongoDB\Collection::insertMany()` +- :phpmethod:`MongoDB\Collection::insertOne()` +- :phpmethod:`MongoDB\Collection::replaceOne()` +- :phpmethod:`MongoDB\Collection::updateMany()` +- :phpmethod:`MongoDB\Collection::updateOne()` - :doc:`/tutorial/crud` diff --git a/docs/reference/method/MongoDBCollection-count.txt b/docs/reference/method/MongoDBCollection-count.txt index 0048703f4..388f5bda9 100644 --- a/docs/reference/method/MongoDBCollection-count.txt +++ b/docs/reference/method/MongoDBCollection-count.txt @@ -15,7 +15,7 @@ MongoDB\\Collection::count() Definition ---------- -.. phpmethod:: MongoDB\\Collection::count() +.. phpmethod:: MongoDB\Collection::count() Count the number of documents that match the filter criteria. @@ -74,17 +74,17 @@ Parameters - .. include:: /includes/extracts/common-option-maxTimeMS.rst * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/collection-option-readConcern.rst .. include:: /includes/extracts/common-option-readConcern-transaction.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/collection-option-readPreference.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -117,7 +117,7 @@ is provided, the ``count`` command provides an estimate using collection metadata. Even when provided with a query filter the ``count`` command can return inaccurate results with a sharded cluster if orphaned documents exist or if a chunk migration is in progress. The -:phpmethod:`MongoDB\\Collection::countDocuments()` method avoids these sharded +:phpmethod:`MongoDB\Collection::countDocuments()` method avoids these sharded cluster problems entirely. .. include:: /includes/extracts/note-bson-comparison.rst @@ -127,5 +127,5 @@ See Also - :manual:`count ` command reference in the MongoDB manual -- :phpmethod:`MongoDB\\Collection::countDocuments()` -- :phpmethod:`MongoDB\\Collection::estimatedDocumentCount()` +- :phpmethod:`MongoDB\Collection::countDocuments()` +- :phpmethod:`MongoDB\Collection::estimatedDocumentCount()` diff --git a/docs/reference/method/MongoDBCollection-countDocuments.txt b/docs/reference/method/MongoDBCollection-countDocuments.txt index dc62b1d65..dc344f2dc 100644 --- a/docs/reference/method/MongoDBCollection-countDocuments.txt +++ b/docs/reference/method/MongoDBCollection-countDocuments.txt @@ -15,7 +15,7 @@ MongoDB\\Collection::countDocuments() Definition ---------- -.. phpmethod:: MongoDB\\Collection::countDocuments() +.. phpmethod:: MongoDB\Collection::countDocuments() Count the number of documents that match the filter criteria. @@ -63,17 +63,17 @@ Parameters - .. include:: /includes/extracts/common-option-maxTimeMS.rst * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/collection-option-readConcern.rst .. include:: /includes/extracts/common-option-readConcern-transaction.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/collection-option-readPreference.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst * - skip @@ -105,12 +105,12 @@ added between ``$match`` and ``group`` if present in the options. This method counts documents on the server side. To obtain an approximate total number of documents without filters, the - :phpmethod:`MongoDB\\Collection::estimatedDocumentCount()` method can be + :phpmethod:`MongoDB\Collection::estimatedDocumentCount()` method can be used. This method estimates the number of documents based on collection metadata, thus sacrificing accuracy for performance. Since this method uses an aggregation pipeline, some query operators accepted -within a :phpmethod:`MongoDB\\Collection::count()` ``filter`` cannot be used. +within a :phpmethod:`MongoDB\Collection::count()` ``filter`` cannot be used. Consider the following alternatives to these restricted operators: .. list-table:: @@ -135,4 +135,4 @@ Consider the following alternatives to these restricted operators: See Also -------- -- :phpmethod:`MongoDB\\Collection::estimatedDocumentCount()` +- :phpmethod:`MongoDB\Collection::estimatedDocumentCount()` diff --git a/docs/reference/method/MongoDBCollection-createIndex.txt b/docs/reference/method/MongoDBCollection-createIndex.txt index 7f8aca41d..6a74a5bd5 100644 --- a/docs/reference/method/MongoDBCollection-createIndex.txt +++ b/docs/reference/method/MongoDBCollection-createIndex.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::createIndex() Definition ---------- -.. phpmethod:: MongoDB\\Collection::createIndex() +.. phpmethod:: MongoDB\Collection::createIndex() Create an index for the collection. @@ -117,13 +117,13 @@ Parameters .. versionadded:: 1.3 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -200,7 +200,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndexes()` +- :phpmethod:`MongoDB\Collection::createIndexes()` - :doc:`/tutorial/indexes` - :manual:`createIndexes ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-createIndexes.txt b/docs/reference/method/MongoDBCollection-createIndexes.txt index efb740ea2..85318b2d5 100644 --- a/docs/reference/method/MongoDBCollection-createIndexes.txt +++ b/docs/reference/method/MongoDBCollection-createIndexes.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::createIndexes() Definition ---------- -.. phpmethod:: MongoDB\\Collection::createIndexes() +.. phpmethod:: MongoDB\Collection::createIndexes() Create one or more indexes for the collection. @@ -81,13 +81,13 @@ Parameters .. versionadded:: 1.3 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -113,9 +113,9 @@ Behavior The ``$indexes`` parameter is an array of index specification documents. Each element in ``$indexes`` must itself be an array or object with a ``key`` field, which corresponds to the ``$key`` parameter of :phpmethod:`createIndex() -`. The array or object may include other +`. The array or object may include other fields that correspond to index options accepted by :phpmethod:`createIndex() -`. For a full list of the supported index +`. For a full list of the supported index creation options, refer to the :manual:`createIndexes ` command reference in the MongoDB manual. @@ -166,7 +166,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::createIndex()` - :doc:`/tutorial/indexes` - :manual:`createIndexes ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-deleteMany.txt b/docs/reference/method/MongoDBCollection-deleteMany.txt index ccb5e37db..b82b1c6b0 100644 --- a/docs/reference/method/MongoDBCollection-deleteMany.txt +++ b/docs/reference/method/MongoDBCollection-deleteMany.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::deleteMany() Definition ---------- -.. phpmethod:: MongoDB\\Collection::deleteMany() +.. phpmethod:: MongoDB\Collection::deleteMany() Deletes all documents that match the filter criteria. @@ -68,13 +68,13 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -82,8 +82,8 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\DeleteResult` object, which encapsulates a -:php:`MongoDB\\Driver\\WriteResult ` object. +A :phpclass:`MongoDB\DeleteResult` object, which encapsulates a +:php:`MongoDB\Driver\WriteResult ` object. Errors/Exceptions ----------------- @@ -127,8 +127,8 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::deleteOne()` -- :phpmethod:`MongoDB\\Collection::bulkWrite()` +- :phpmethod:`MongoDB\Collection::deleteOne()` +- :phpmethod:`MongoDB\Collection::bulkWrite()` - :doc:`/tutorial/crud` - :manual:`delete ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-deleteOne.txt b/docs/reference/method/MongoDBCollection-deleteOne.txt index 0c6598914..43209ebd9 100644 --- a/docs/reference/method/MongoDBCollection-deleteOne.txt +++ b/docs/reference/method/MongoDBCollection-deleteOne.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::deleteOne() Definition ---------- -.. phpmethod:: MongoDB\\Collection::deleteOne() +.. phpmethod:: MongoDB\Collection::deleteOne() Deletes at most one document that matches the filter criteria. If multiple documents match the filter criteria, only the :term:`first ` @@ -70,13 +70,13 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -84,8 +84,8 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\DeleteResult` object, which encapsulates a -:php:`MongoDB\\Driver\\WriteResult ` object. +A :phpclass:`MongoDB\DeleteResult` object, which encapsulates a +:php:`MongoDB\Driver\WriteResult ` object. Errors/Exceptions ----------------- @@ -129,8 +129,8 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::deleteMany()` -- :phpmethod:`MongoDB\\Collection::bulkWrite()` +- :phpmethod:`MongoDB\Collection::deleteMany()` +- :phpmethod:`MongoDB\Collection::bulkWrite()` - :doc:`/tutorial/crud` - :manual:`delete ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-distinct.txt b/docs/reference/method/MongoDBCollection-distinct.txt index 42eae0681..f8bcd4b09 100644 --- a/docs/reference/method/MongoDBCollection-distinct.txt +++ b/docs/reference/method/MongoDBCollection-distinct.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::distinct() Definition ---------- -.. phpmethod:: MongoDB\\Collection::distinct() +.. phpmethod:: MongoDB\Collection::distinct() Finds the distinct values for a specified field across the collection. @@ -63,17 +63,17 @@ Parameters - .. include:: /includes/extracts/common-option-maxTimeMS.rst * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/collection-option-readConcern.rst .. include:: /includes/extracts/common-option-readConcern-transaction.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/collection-option-readPreference.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 diff --git a/docs/reference/method/MongoDBCollection-drop.txt b/docs/reference/method/MongoDBCollection-drop.txt index 0704ff6a8..93b6a17c7 100644 --- a/docs/reference/method/MongoDBCollection-drop.txt +++ b/docs/reference/method/MongoDBCollection-drop.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::drop() Definition ---------- -.. phpmethod:: MongoDB\\Collection::drop() +.. phpmethod:: MongoDB\Collection::drop() Drop the collection. @@ -64,7 +64,7 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -76,7 +76,7 @@ Parameters This will be used for the returned command result document. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -132,6 +132,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Database::dropCollection()` +- :phpmethod:`MongoDB\Database::dropCollection()` - :manual:`drop ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-dropIndex.txt b/docs/reference/method/MongoDBCollection-dropIndex.txt index 07a181458..67ba427e3 100644 --- a/docs/reference/method/MongoDBCollection-dropIndex.txt +++ b/docs/reference/method/MongoDBCollection-dropIndex.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::dropIndex() Definition ---------- -.. phpmethod:: MongoDB\\Collection::dropIndex() +.. phpmethod:: MongoDB\Collection::dropIndex() Drop an index from the collection. @@ -27,10 +27,10 @@ Definition Parameters ---------- -``$indexName`` : string| :phpclass:`MongoDB\\Model\\IndexInfo` +``$indexName`` : string| :phpclass:`MongoDB\Model\IndexInfo` The name or model object of the index to drop. View the existing indexes on the collection using the :phpmethod:`listIndexes() - ` method. + ` method. ``$options`` : array An array specifying the desired options. @@ -58,7 +58,7 @@ Parameters .. versionadded:: 1.3 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -70,7 +70,7 @@ Parameters This will be used for the returned command result document. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -122,7 +122,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::dropIndexes()` +- :phpmethod:`MongoDB\Collection::dropIndexes()` - :doc:`/tutorial/indexes` - :manual:`dropIndexes ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-dropIndexes.txt b/docs/reference/method/MongoDBCollection-dropIndexes.txt index 41fda6e40..52595c71e 100644 --- a/docs/reference/method/MongoDBCollection-dropIndexes.txt +++ b/docs/reference/method/MongoDBCollection-dropIndexes.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::dropIndexes() Definition ---------- -.. phpmethod:: MongoDB\\Collection::dropIndexes() +.. phpmethod:: MongoDB\Collection::dropIndexes() Drop all indexes in the collection, except for the required index on the ``_id`` field. @@ -25,10 +25,10 @@ Definition Parameters ---------- -``$indexName`` : string| :phpclass:`MongoDB\\Model\\IndexInfo` +``$indexName`` : string| :phpclass:`MongoDB\Model\IndexInfo` The name or model object of the index to drop. View the existing indexes on the collection using the :phpmethod:`listIndexes() - ` method. + ` method. ``$options`` : array An array specifying the desired options. @@ -56,7 +56,7 @@ Parameters .. versionadded:: 1.3 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -68,7 +68,7 @@ Parameters This will be used for the returned command result document. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -122,7 +122,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::dropIndex()` +- :phpmethod:`MongoDB\Collection::dropIndex()` - :doc:`/tutorial/indexes` - :manual:`dropIndexes ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-estimatedDocumentCount.txt b/docs/reference/method/MongoDBCollection-estimatedDocumentCount.txt index 59a7b2124..1dd1d2a60 100644 --- a/docs/reference/method/MongoDBCollection-estimatedDocumentCount.txt +++ b/docs/reference/method/MongoDBCollection-estimatedDocumentCount.txt @@ -15,7 +15,7 @@ MongoDB\\Collection::estimatedDocumentCount() Definition ---------- -.. phpmethod:: MongoDB\\Collection::estimatedDocumentCount() +.. phpmethod:: MongoDB\Collection::estimatedDocumentCount() Gets an estimated number of documents in the collection using collection metadata. @@ -50,17 +50,17 @@ Parameters - .. include:: /includes/extracts/common-option-maxTimeMS.rst * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/collection-option-readConcern.rst .. include:: /includes/extracts/common-option-readConcern-transaction.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/collection-option-readPreference.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst Return Values @@ -97,4 +97,4 @@ See Also - :manual:`count ` command reference in the MongoDB manual -- :phpmethod:`MongoDB\\Collection::countDocuments()` +- :phpmethod:`MongoDB\Collection::countDocuments()` diff --git a/docs/reference/method/MongoDBCollection-explain.txt b/docs/reference/method/MongoDBCollection-explain.txt index ad63ec56a..4c6049449 100644 --- a/docs/reference/method/MongoDBCollection-explain.txt +++ b/docs/reference/method/MongoDBCollection-explain.txt @@ -15,7 +15,7 @@ MongoDB\\Collection::explain() Definition ---------- -.. phpmethod:: MongoDB\\Collection::explain() +.. phpmethod:: MongoDB\Collection::explain() Explain the given command. @@ -29,7 +29,7 @@ Definition Parameters ---------- -``$explainable`` : :phpclass:`MongoDB\\Operation\\Explainable` +``$explainable`` : :phpclass:`MongoDB\Operation\\Explainable` The command to explain. ``$options`` : array @@ -54,7 +54,7 @@ Parameters .. versionadded:: 1.13 * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/collection-option-readPreference.rst * - typeMap diff --git a/docs/reference/method/MongoDBCollection-find.txt b/docs/reference/method/MongoDBCollection-find.txt index 8c0ce7c22..25cca0091 100644 --- a/docs/reference/method/MongoDBCollection-find.txt +++ b/docs/reference/method/MongoDBCollection-find.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::find() Definition ---------- -.. phpmethod:: MongoDB\\Collection::find() +.. phpmethod:: MongoDB\Collection::find() Finds documents matching the query. @@ -156,7 +156,7 @@ Parameters { ts: { $gte: } } - The :php:`MongoDB\\BSON\\Timestamp ` + The :php:`MongoDB\BSON\Timestamp ` class reference describes how to represent MongoDB's BSON timestamp type with PHP. @@ -171,13 +171,13 @@ Parameters the MongoDB manual. * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/collection-option-readConcern.rst .. include:: /includes/extracts/common-option-readConcern-transaction.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/collection-option-readPreference.rst * - returnKey @@ -187,7 +187,7 @@ Parameters .. versionadded:: 1.2 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -222,7 +222,7 @@ Parameters Return Values ------------- -A :php:`MongoDB\\Driver\\Cursor ` object. +A :php:`MongoDB\Driver\Cursor ` object. Errors/Exceptions ----------------- @@ -357,6 +357,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::findOne()` +- :phpmethod:`MongoDB\Collection::findOne()` - :manual:`find ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-findOne.txt b/docs/reference/method/MongoDBCollection-findOne.txt index c5230c6cf..d00c58667 100644 --- a/docs/reference/method/MongoDBCollection-findOne.txt +++ b/docs/reference/method/MongoDBCollection-findOne.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::findOne() Definition ---------- -.. phpmethod:: MongoDB\\Collection::findOne() +.. phpmethod:: MongoDB\Collection::findOne() Finds a single document matching the query. @@ -113,7 +113,7 @@ Parameters { ts: { $gte: } } - The :php:`MongoDB\\BSON\\Timestamp ` + The :php:`MongoDB\BSON\Timestamp ` class reference describes how to represent MongoDB's BSON timestamp type with PHP. @@ -128,13 +128,13 @@ Parameters the MongoDB manual. * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/collection-option-readConcern.rst .. include:: /includes/extracts/common-option-readConcern-transaction.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/collection-option-readPreference.rst * - returnKey @@ -144,7 +144,7 @@ Parameters .. versionadded:: 1.2 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -199,7 +199,7 @@ In the following example, documents in the ``restaurants`` collection use an :manual:`ObjectId ` for their identifier (the default) and documents in the ``zips`` collection use a string. Since ObjectId is a special BSON type, the query criteria for selecting a restaurant must use the -:php:`MongoDB\\BSON\\ObjectId ` class. +:php:`MongoDB\BSON\ObjectId ` class. .. code-block:: php @@ -267,6 +267,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::find()` +- :phpmethod:`MongoDB\Collection::find()` - :manual:`find ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-findOneAndDelete.txt b/docs/reference/method/MongoDBCollection-findOneAndDelete.txt index b34bd5788..9a7066b7b 100644 --- a/docs/reference/method/MongoDBCollection-findOneAndDelete.txt +++ b/docs/reference/method/MongoDBCollection-findOneAndDelete.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::findOneAndDelete() Definition ---------- -.. phpmethod:: MongoDB\\Collection::findOneAndDelete() +.. phpmethod:: MongoDB\Collection::findOneAndDelete() Finds a single document matching the query and deletes it. @@ -80,7 +80,7 @@ Parameters the MongoDB manual. * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -96,7 +96,7 @@ Parameters This will be used for the returned result document. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -169,7 +169,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::findOneAndReplace()` -- :phpmethod:`MongoDB\\Collection::findOneAndUpdate()` +- :phpmethod:`MongoDB\Collection::findOneAndReplace()` +- :phpmethod:`MongoDB\Collection::findOneAndUpdate()` - :manual:`findAndModify ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-findOneAndReplace.txt b/docs/reference/method/MongoDBCollection-findOneAndReplace.txt index 697e73710..48f6df291 100644 --- a/docs/reference/method/MongoDBCollection-findOneAndReplace.txt +++ b/docs/reference/method/MongoDBCollection-findOneAndReplace.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::findOneAndReplace() Definition ---------- -.. phpmethod:: MongoDB\\Collection::findOneAndReplace() +.. phpmethod:: MongoDB\Collection::findOneAndReplace() Finds a single document matching the query and replaces it. @@ -97,7 +97,7 @@ Parameters - ``MongoDB\Operation\FindOneAndReplace::RETURN_DOCUMENT_AFTER`` * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -119,7 +119,7 @@ Parameters new document when no match is found. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -242,7 +242,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::findOneAndDelete()` -- :phpmethod:`MongoDB\\Collection::findOneAndUpdate()` +- :phpmethod:`MongoDB\Collection::findOneAndDelete()` +- :phpmethod:`MongoDB\Collection::findOneAndUpdate()` - :manual:`findAndModify ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-findOneAndUpdate.txt b/docs/reference/method/MongoDBCollection-findOneAndUpdate.txt index cbfbad16e..f4077b344 100644 --- a/docs/reference/method/MongoDBCollection-findOneAndUpdate.txt +++ b/docs/reference/method/MongoDBCollection-findOneAndUpdate.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::findOneAndUpdate() Definition ---------- -.. phpmethod:: MongoDB\\Collection::findOneAndUpdate() +.. phpmethod:: MongoDB\Collection::findOneAndUpdate() Finds a single document matching the query and updates it. @@ -108,7 +108,7 @@ Parameters - ``MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_AFTER`` * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -130,7 +130,7 @@ Parameters new document when no match is found. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -220,7 +220,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::findOneAndDelete()` -- :phpmethod:`MongoDB\\Collection::findOneAndReplace()` +- :phpmethod:`MongoDB\Collection::findOneAndDelete()` +- :phpmethod:`MongoDB\Collection::findOneAndReplace()` - :manual:`findAndModify ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-getCollectionName.txt b/docs/reference/method/MongoDBCollection-getCollectionName.txt index 70be8a8a1..9b629232e 100644 --- a/docs/reference/method/MongoDBCollection-getCollectionName.txt +++ b/docs/reference/method/MongoDBCollection-getCollectionName.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::getCollectionName() Definition ---------- -.. phpmethod:: MongoDB\\Collection::getCollectionName() +.. phpmethod:: MongoDB\Collection::getCollectionName() Returns the name of this collection. @@ -49,5 +49,5 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::getDatabaseName()` -- :phpmethod:`MongoDB\\Collection::getNamespace()` +- :phpmethod:`MongoDB\Collection::getDatabaseName()` +- :phpmethod:`MongoDB\Collection::getNamespace()` diff --git a/docs/reference/method/MongoDBCollection-getDatabaseName.txt b/docs/reference/method/MongoDBCollection-getDatabaseName.txt index f83632bac..5cb4902c9 100644 --- a/docs/reference/method/MongoDBCollection-getDatabaseName.txt +++ b/docs/reference/method/MongoDBCollection-getDatabaseName.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::getDatabaseName() Definition ---------- -.. phpmethod:: MongoDB\\Collection::getDatabaseName() +.. phpmethod:: MongoDB\Collection::getDatabaseName() Returns the name of the database containing this collection. @@ -49,6 +49,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::getCollectionName()` -- :phpmethod:`MongoDB\\Collection::getNamespace()` +- :phpmethod:`MongoDB\Collection::getCollectionName()` +- :phpmethod:`MongoDB\Collection::getNamespace()` diff --git a/docs/reference/method/MongoDBCollection-getManager.txt b/docs/reference/method/MongoDBCollection-getManager.txt index e0bbea088..427ed29eb 100644 --- a/docs/reference/method/MongoDBCollection-getManager.txt +++ b/docs/reference/method/MongoDBCollection-getManager.txt @@ -13,11 +13,11 @@ MongoDB\\Collection::getManager() Definition ---------- -.. phpmethod:: MongoDB\\Collection::getManager() +.. phpmethod:: MongoDB\Collection::getManager() Accessor for the - :php:`MongoDB\\Driver\\Manager ` used by this - :phpclass:`Collection `. + :php:`MongoDB\Driver\Manager ` used by this + :phpclass:`Collection `. .. code-block:: php @@ -26,10 +26,10 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\Manager ` object. +A :php:`MongoDB\Driver\Manager ` object. See Also -------- -- :phpmethod:`MongoDB\\Client::getManager()` -- :phpmethod:`MongoDB\\Database::getManager()` +- :phpmethod:`MongoDB\Client::getManager()` +- :phpmethod:`MongoDB\Database::getManager()` diff --git a/docs/reference/method/MongoDBCollection-getNamespace.txt b/docs/reference/method/MongoDBCollection-getNamespace.txt index 78e2484be..4003fbd89 100644 --- a/docs/reference/method/MongoDBCollection-getNamespace.txt +++ b/docs/reference/method/MongoDBCollection-getNamespace.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::getNamespace() Definition ---------- -.. phpmethod:: MongoDB\\Collection::getNamespace() +.. phpmethod:: MongoDB\Collection::getNamespace() Returns the :term:`namespace` of the collection. A namespace is the canonical name of an index or collection in MongoDB. @@ -50,5 +50,5 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::getCollectionName()` -- :phpmethod:`MongoDB\\Collection::getDatabaseName()` +- :phpmethod:`MongoDB\Collection::getCollectionName()` +- :phpmethod:`MongoDB\Collection::getDatabaseName()` diff --git a/docs/reference/method/MongoDBCollection-getReadConcern.txt b/docs/reference/method/MongoDBCollection-getReadConcern.txt index 37873d0f9..0ce0b4829 100644 --- a/docs/reference/method/MongoDBCollection-getReadConcern.txt +++ b/docs/reference/method/MongoDBCollection-getReadConcern.txt @@ -15,7 +15,7 @@ MongoDB\\Collection::getReadConcern() Definition ---------- -.. phpmethod:: MongoDB\\Collection::getReadConcern() +.. phpmethod:: MongoDB\Collection::getReadConcern() Returns the read concern for this collection. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\ReadConcern ` object. +A :php:`MongoDB\Driver\ReadConcern ` object. Example ------- @@ -54,7 +54,7 @@ See Also -------- - :manual:`Read Concern ` in the MongoDB manual -- :php:`MongoDB\\Driver\\ReadConcern::isDefault() ` -- :phpmethod:`MongoDB\\Client::getReadConcern()` -- :phpmethod:`MongoDB\\Database::getReadConcern()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()` +- :php:`MongoDB\Driver\ReadConcern::isDefault() ` +- :phpmethod:`MongoDB\Client::getReadConcern()` +- :phpmethod:`MongoDB\Database::getReadConcern()` +- :phpmethod:`MongoDB\GridFS\Bucket::getReadConcern()` diff --git a/docs/reference/method/MongoDBCollection-getReadPreference.txt b/docs/reference/method/MongoDBCollection-getReadPreference.txt index 622701e55..b14980ae3 100644 --- a/docs/reference/method/MongoDBCollection-getReadPreference.txt +++ b/docs/reference/method/MongoDBCollection-getReadPreference.txt @@ -15,7 +15,7 @@ MongoDB\\Collection::getReadPreference() Definition ---------- -.. phpmethod:: MongoDB\\Collection::getReadPreference() +.. phpmethod:: MongoDB\Collection::getReadPreference() Returns the read preference for this collection. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\ReadPreference ` +A :php:`MongoDB\Driver\ReadPreference ` object. Example @@ -55,6 +55,6 @@ See Also -------- - :manual:`Read Preference ` in the MongoDB manual -- :phpmethod:`MongoDB\\Client::getReadPreference()` -- :phpmethod:`MongoDB\\Database::getReadPreference()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()` +- :phpmethod:`MongoDB\Client::getReadPreference()` +- :phpmethod:`MongoDB\Database::getReadPreference()` +- :phpmethod:`MongoDB\GridFS\Bucket::getReadPreference()` diff --git a/docs/reference/method/MongoDBCollection-getTypeMap.txt b/docs/reference/method/MongoDBCollection-getTypeMap.txt index 50cd91dad..8cd9240ce 100644 --- a/docs/reference/method/MongoDBCollection-getTypeMap.txt +++ b/docs/reference/method/MongoDBCollection-getTypeMap.txt @@ -15,7 +15,7 @@ MongoDB\\Collection::getTypeMap() Definition ---------- -.. phpmethod:: MongoDB\\Collection::getTypeMap() +.. phpmethod:: MongoDB\Collection::getTypeMap() Returns the type map for this collection. @@ -62,6 +62,6 @@ See Also -------- - :doc:`/reference/bson` -- :phpmethod:`MongoDB\\Client::getTypeMap()` -- :phpmethod:`MongoDB\\Database::getTypeMap()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()` +- :phpmethod:`MongoDB\Client::getTypeMap()` +- :phpmethod:`MongoDB\Database::getTypeMap()` +- :phpmethod:`MongoDB\GridFS\Bucket::getTypeMap()` diff --git a/docs/reference/method/MongoDBCollection-getWriteConcern.txt b/docs/reference/method/MongoDBCollection-getWriteConcern.txt index a7ad354db..cc3e5d94e 100644 --- a/docs/reference/method/MongoDBCollection-getWriteConcern.txt +++ b/docs/reference/method/MongoDBCollection-getWriteConcern.txt @@ -15,7 +15,7 @@ MongoDB\\Collection::getWriteConcern() Definition ---------- -.. phpmethod:: MongoDB\\Collection::getWriteConcern() +.. phpmethod:: MongoDB\Collection::getWriteConcern() Returns the write concern for this collection. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\WriteConcern ` +A :php:`MongoDB\Driver\WriteConcern ` object. Example @@ -57,7 +57,7 @@ See Also -------- - :manual:`Write Concern ` in the MongoDB manual -- :php:`MongoDB\\Driver\\WriteConcern::isDefault() ` -- :phpmethod:`MongoDB\\Client::getWriteConcern()` -- :phpmethod:`MongoDB\\Database::getWriteConcern()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()` +- :php:`MongoDB\Driver\WriteConcern::isDefault() ` +- :phpmethod:`MongoDB\Client::getWriteConcern()` +- :phpmethod:`MongoDB\Database::getWriteConcern()` +- :phpmethod:`MongoDB\GridFS\Bucket::getWriteConcern()` diff --git a/docs/reference/method/MongoDBCollection-insertMany.txt b/docs/reference/method/MongoDBCollection-insertMany.txt index 6ff516e7e..37f7d82f6 100644 --- a/docs/reference/method/MongoDBCollection-insertMany.txt +++ b/docs/reference/method/MongoDBCollection-insertMany.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::insertMany() Definition ---------- -.. phpmethod:: MongoDB\\Collection::insertMany() +.. phpmethod:: MongoDB\Collection::insertMany() Insert multiple documents. @@ -65,13 +65,13 @@ Parameters The default is ``true``. * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -79,8 +79,8 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\InsertManyResult` object, which encapsulates a -:php:`MongoDB\\Driver\\WriteResult ` object. +A :phpclass:`MongoDB\InsertManyResult` object, which encapsulates a +:php:`MongoDB\Driver\WriteResult ` object. Errors/Exceptions ----------------- @@ -149,8 +149,8 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::insertOne()` -- :phpmethod:`MongoDB\\Collection::bulkWrite()` +- :phpmethod:`MongoDB\Collection::insertOne()` +- :phpmethod:`MongoDB\Collection::bulkWrite()` - :doc:`/tutorial/crud` - :manual:`insert ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-insertOne.txt b/docs/reference/method/MongoDBCollection-insertOne.txt index ce6f04840..7a638bdcc 100644 --- a/docs/reference/method/MongoDBCollection-insertOne.txt +++ b/docs/reference/method/MongoDBCollection-insertOne.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::insertOne() Definition ---------- -.. phpmethod:: MongoDB\\Collection::insertOne() +.. phpmethod:: MongoDB\Collection::insertOne() Insert one document. @@ -55,13 +55,13 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -69,8 +69,8 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\InsertOneResult` object, which encapsulates a -:php:`MongoDB\\Driver\\WriteResult ` object. +A :phpclass:`MongoDB\InsertOneResult` object, which encapsulates a +:php:`MongoDB\Driver\WriteResult ` object. Errors/Exceptions ----------------- @@ -123,8 +123,8 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::insertMany()` -- :phpmethod:`MongoDB\\Collection::bulkWrite()` +- :phpmethod:`MongoDB\Collection::insertMany()` +- :phpmethod:`MongoDB\Collection::bulkWrite()` - :doc:`/tutorial/crud` - :manual:`insert ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-listIndexes.txt b/docs/reference/method/MongoDBCollection-listIndexes.txt index 84ee74b38..b65b228ba 100644 --- a/docs/reference/method/MongoDBCollection-listIndexes.txt +++ b/docs/reference/method/MongoDBCollection-listIndexes.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::listIndexes() Definition ---------- -.. phpmethod:: MongoDB\\Collection::listIndexes() +.. phpmethod:: MongoDB\Collection::listIndexes() Returns information for all indexes for this collection. @@ -48,7 +48,7 @@ Parameters - .. include:: /includes/extracts/common-option-maxTimeMS.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -56,8 +56,8 @@ Parameters Return Values ------------- -A traversable :phpclass:`MongoDB\\Model\\IndexInfoIterator`, which contains a -:phpclass:`MongoDB\\Model\\IndexInfo` object for each index for the collection. +A traversable :phpclass:`MongoDB\Model\IndexInfoIterator`, which contains a +:phpclass:`MongoDB\Model\IndexInfo` object for each index for the collection. Errors/Exceptions ----------------- diff --git a/docs/reference/method/MongoDBCollection-mapReduce.txt b/docs/reference/method/MongoDBCollection-mapReduce.txt index 9081c36c0..afb573733 100644 --- a/docs/reference/method/MongoDBCollection-mapReduce.txt +++ b/docs/reference/method/MongoDBCollection-mapReduce.txt @@ -17,7 +17,7 @@ MongoDB\\Collection::mapReduce() Definition ---------- -.. phpmethod:: MongoDB\\Collection::mapReduce() +.. phpmethod:: MongoDB\Collection::mapReduce() The :manual:`mapReduce ` command allows you to run map-reduce aggregation operations over a collection. @@ -34,7 +34,7 @@ Definition Parameters ---------- -``$map`` : :php:`MongoDB\\BSON\\Javascript ` +``$map`` : :php:`MongoDB\BSON\Javascript ` A JavaScript function that associates or "maps" a value with a key and emits the key and value pair. @@ -43,7 +43,7 @@ Parameters Passing a Javascript instance with a scope is deprecated. Put all scope variables in the ``scope`` option of the MapReduce operation. -``$reduce`` : :php:`MongoDB\\BSON\\Javascript ` +``$reduce`` : :php:`MongoDB\BSON\Javascript ` A JavaScript function that "reduces" to a single object all the values associated with a particular key. @@ -89,7 +89,7 @@ Parameters .. versionadded:: 1.13 * - finalize - - :php:`MongoDB\\BSON\\Javascript ` + - :php:`MongoDB\BSON\Javascript ` - Follows the reduce method and modifies the output. .. note:: @@ -117,13 +117,13 @@ Parameters the documents input to the map function. * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/collection-option-readConcern.rst .. include:: /includes/extracts/common-option-readConcern-transaction.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/collection-option-readPreference.rst This option will be ignored when results are output to a collection. @@ -134,7 +134,7 @@ Parameters finalize functions. * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -153,7 +153,7 @@ Parameters information. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -161,7 +161,7 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\MapReduceResult` object, which allows for iteration of +A :phpclass:`MongoDB\MapReduceResult` object, which allows for iteration of map-reduce results irrespective of the output method (e.g. inline, collection) via the :php:`IteratorAggregate ` interface. It also provides access to command statistics. diff --git a/docs/reference/method/MongoDBCollection-rename.txt b/docs/reference/method/MongoDBCollection-rename.txt index 2b617de94..347c205b7 100644 --- a/docs/reference/method/MongoDBCollection-rename.txt +++ b/docs/reference/method/MongoDBCollection-rename.txt @@ -15,7 +15,7 @@ MongoDB\\Collection::rename() Definition ---------- -.. phpmethod:: MongoDB\\Collection::rename() +.. phpmethod:: MongoDB\Collection::rename() Rename the collection. @@ -64,7 +64,7 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst * - typeMap @@ -74,7 +74,7 @@ Parameters This will be used for the returned command result document. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -124,6 +124,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Database::renameCollection()` +- :phpmethod:`MongoDB\Database::renameCollection()` - :manual:`renameCollection ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-replaceOne.txt b/docs/reference/method/MongoDBCollection-replaceOne.txt index 94395eff0..f9bfb1b85 100644 --- a/docs/reference/method/MongoDBCollection-replaceOne.txt +++ b/docs/reference/method/MongoDBCollection-replaceOne.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::replaceOne() Definition ---------- -.. phpmethod:: MongoDB\\Collection::replaceOne() +.. phpmethod:: MongoDB\Collection::replaceOne() Replace at most one document that matches the filter criteria. If multiple documents match the filter criteria, only the :term:`first ` @@ -79,7 +79,7 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -91,7 +91,7 @@ Parameters new document when no match is found. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -99,8 +99,8 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\UpdateResult` object, which encapsulates a -:php:`MongoDB\\Driver\\WriteResult ` object. +A :phpclass:`MongoDB\UpdateResult` object, which encapsulates a +:php:`MongoDB\Driver\WriteResult ` object. Errors/Exceptions ----------------- @@ -152,9 +152,9 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::updateMany()` -- :phpmethod:`MongoDB\\Collection::updateOne()` -- :phpmethod:`MongoDB\\Collection::bulkWrite()` +- :phpmethod:`MongoDB\Collection::updateMany()` +- :phpmethod:`MongoDB\Collection::updateOne()` +- :phpmethod:`MongoDB\Collection::bulkWrite()` - :doc:`/tutorial/crud` - :manual:`update ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-updateMany.txt b/docs/reference/method/MongoDBCollection-updateMany.txt index 07f29211e..2b0772209 100644 --- a/docs/reference/method/MongoDBCollection-updateMany.txt +++ b/docs/reference/method/MongoDBCollection-updateMany.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::updateMany() Definition ---------- -.. phpmethod:: MongoDB\\Collection::updateMany() +.. phpmethod:: MongoDB\Collection::updateMany() Update all documents that match the filter criteria. @@ -88,7 +88,7 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -100,7 +100,7 @@ Parameters new document when no match is found. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -108,8 +108,8 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\UpdateResult` object, which encapsulates a -:php:`MongoDB\\Driver\\WriteResult ` object. +A :phpclass:`MongoDB\UpdateResult` object, which encapsulates a +:php:`MongoDB\Driver\WriteResult ` object. Errors/Exceptions ----------------- @@ -155,9 +155,9 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::replaceOne()` -- :phpmethod:`MongoDB\\Collection::updateOne()` -- :phpmethod:`MongoDB\\Collection::bulkWrite()` +- :phpmethod:`MongoDB\Collection::replaceOne()` +- :phpmethod:`MongoDB\Collection::updateOne()` +- :phpmethod:`MongoDB\Collection::bulkWrite()` - :doc:`/tutorial/crud` - :manual:`update ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-updateOne.txt b/docs/reference/method/MongoDBCollection-updateOne.txt index 2a981cb2b..321103c24 100644 --- a/docs/reference/method/MongoDBCollection-updateOne.txt +++ b/docs/reference/method/MongoDBCollection-updateOne.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::updateOne() Definition ---------- -.. phpmethod:: MongoDB\\Collection::updateOne() +.. phpmethod:: MongoDB\Collection::updateOne() Update at most one document that matches the filter criteria. If multiple documents match the filter criteria, only the :term:`first ` @@ -90,7 +90,7 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -102,7 +102,7 @@ Parameters new document when no match is found. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/collection-option-writeConcern.rst .. include:: /includes/extracts/common-option-writeConcern-transaction.rst @@ -110,8 +110,8 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\UpdateResult` object, which encapsulates a -:php:`MongoDB\\Driver\\WriteResult ` object. +A :phpclass:`MongoDB\UpdateResult` object, which encapsulates a +:php:`MongoDB\Driver\WriteResult ` object. Errors/Exceptions ----------------- @@ -157,9 +157,9 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::replaceOne()` -- :phpmethod:`MongoDB\\Collection::updateMany()` -- :phpmethod:`MongoDB\\Collection::bulkWrite()` +- :phpmethod:`MongoDB\Collection::replaceOne()` +- :phpmethod:`MongoDB\Collection::updateMany()` +- :phpmethod:`MongoDB\Collection::bulkWrite()` - :doc:`/tutorial/crud` - :manual:`update ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-watch.txt b/docs/reference/method/MongoDBCollection-watch.txt index c54123bd3..0722b6d76 100644 --- a/docs/reference/method/MongoDBCollection-watch.txt +++ b/docs/reference/method/MongoDBCollection-watch.txt @@ -15,7 +15,7 @@ MongoDB\\Collection::watch() Definition ---------- -.. phpmethod:: MongoDB\\Collection::watch() +.. phpmethod:: MongoDB\Collection::watch() Executes a :manual:`change stream ` operation on the collection. The change stream can be watched for collection-level changes. @@ -77,11 +77,11 @@ Parameters - .. include:: /includes/extracts/watch-option-maxAwaitTimeMS.rst * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/collection-option-readConcern.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/collection-option-readPreference.rst This is used for both the initial change stream aggregation and for @@ -92,7 +92,7 @@ Parameters - .. include:: /includes/extracts/watch-option-resumeAfter.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst * - showExpandedEvents @@ -104,7 +104,7 @@ Parameters - .. include:: /includes/extracts/watch-option-startAfter.rst * - startAtOperationTime - - :php:`MongoDB\\BSON\\TimestampInterface ` + - :php:`MongoDB\BSON\TimestampInterface ` - .. include:: /includes/extracts/watch-option-startAtOperationTime.rst * - typeMap @@ -114,7 +114,7 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\ChangeStream` object, which allows for iteration of +A :phpclass:`MongoDB\ChangeStream` object, which allows for iteration of events in the change stream via the :php:`Iterator ` interface. Errors/Exceptions @@ -193,8 +193,8 @@ script was iterating the change stream, the output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Client::watch()` -- :phpmethod:`MongoDB\\Database::watch()` +- :phpmethod:`MongoDB\Client::watch()` +- :phpmethod:`MongoDB\Database::watch()` - :manual:`Aggregation Pipeline ` documentation in the MongoDB Manual - :manual:`Change Streams ` documentation in the MongoDB manual diff --git a/docs/reference/method/MongoDBCollection-withOptions.txt b/docs/reference/method/MongoDBCollection-withOptions.txt index 293b093ae..d942b8ccb 100644 --- a/docs/reference/method/MongoDBCollection-withOptions.txt +++ b/docs/reference/method/MongoDBCollection-withOptions.txt @@ -13,7 +13,7 @@ MongoDB\\Collection::withOptions() Definition ---------- -.. phpmethod:: MongoDB\\Collection::withOptions() +.. phpmethod:: MongoDB\Collection::withOptions() Returns a clone of the Collection object, but with different options. @@ -36,12 +36,12 @@ Parameters - Description * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - The default read concern to use for collection operations. Defaults to the original collection's read concern. * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - The default read preference to use for collection operations. Defaults to the original collection's read preference. @@ -53,14 +53,14 @@ Parameters to PHP values. Defaults to the original collection's type map. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - The default write concern to use for collection operations. Defaults to the original collection's write concern. Return Values ------------- -A :phpclass:`MongoDB\\Collection` object. +A :phpclass:`MongoDB\Collection` object. Errors/Exceptions ----------------- @@ -86,4 +86,4 @@ preference: See Also -------- -- :phpmethod:`MongoDB\\Collection::__construct()` +- :phpmethod:`MongoDB\Collection::__construct()` diff --git a/docs/reference/method/MongoDBCollection__construct.txt b/docs/reference/method/MongoDBCollection__construct.txt index 091735006..c4d2524fc 100644 --- a/docs/reference/method/MongoDBCollection__construct.txt +++ b/docs/reference/method/MongoDBCollection__construct.txt @@ -13,9 +13,9 @@ MongoDB\\Collection::__construct() Definition ---------- -.. phpmethod:: MongoDB\\Collection::__construct() +.. phpmethod:: MongoDB\Collection::__construct() - Constructs a new :phpclass:`Collection ` instance. + Constructs a new :phpclass:`Collection ` instance. .. code-block:: php @@ -28,7 +28,7 @@ Definition This constructor has the following parameters: -``$manager`` : :php:`MongoDB\\Driver\\Manager ` +``$manager`` : :php:`MongoDB\Driver\Manager ` The :php:`Manager ` instance from the driver. The manager maintains connections between the driver and your MongoDB instances. @@ -50,12 +50,12 @@ Definition - Description * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - The default read concern to use for collection operations. Defaults to the manager's read concern. * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - The default read preference to use for collection operations. Defaults to the manager's read preference. @@ -75,7 +75,7 @@ Definition ] * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - The default write concern to use for collection operations. Defaults to the manager's write concern. @@ -88,9 +88,9 @@ Behavior -------- If you construct a Collection explicitly, the Collection inherits any options -from the :php:`MongoDB\\Driver\\Manager ` object. -If you select the Collection from a :phpclass:`Client ` or -:phpclass:`Database ` object, the Collection inherits its +from the :php:`MongoDB\Driver\Manager ` object. +If you select the Collection from a :phpclass:`Client ` or +:phpclass:`Database ` object, the Collection inherits its options from that object. .. todo: add an example @@ -98,7 +98,7 @@ options from that object. See Also -------- -- :phpmethod:`MongoDB\\Collection::withOptions()` -- :phpmethod:`MongoDB\\Client::selectCollection()` -- :phpmethod:`MongoDB\\Database::selectCollection()` -- :phpmethod:`MongoDB\\Database::__get()` +- :phpmethod:`MongoDB\Collection::withOptions()` +- :phpmethod:`MongoDB\Client::selectCollection()` +- :phpmethod:`MongoDB\Database::selectCollection()` +- :phpmethod:`MongoDB\Database::__get()` diff --git a/docs/reference/method/MongoDBDatabase-aggregate.txt b/docs/reference/method/MongoDBDatabase-aggregate.txt index 96d409aea..665463154 100644 --- a/docs/reference/method/MongoDBDatabase-aggregate.txt +++ b/docs/reference/method/MongoDBDatabase-aggregate.txt @@ -15,12 +15,12 @@ MongoDB\\Database::aggregate() Definition ---------- -.. phpmethod:: MongoDB\\Database::aggregate() +.. phpmethod:: MongoDB\Database::aggregate() Runs a specified :manual:`admin/diagnostic pipeline ` which does not require an underlying collection. For aggregations on collection data, - see :phpmethod:`MongoDB\\Collection::aggregate()`. + see :phpmethod:`MongoDB\Collection::aggregate()`. .. code-block:: php @@ -105,15 +105,15 @@ Parameters - .. include:: /includes/extracts/common-option-maxTimeMS.rst * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/database-option-readConcern.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/database-option-readPreference.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst * - typeMap @@ -121,13 +121,13 @@ Parameters - .. include:: /includes/extracts/database-option-typeMap.rst * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/database-option-writeConcern.rst Return Values ------------- -A :php:`MongoDB\\Driver\\Cursor ` or +A :php:`MongoDB\Driver\Cursor ` or :php:`ArrayIterator ` object. In both cases, the return value will be :php:`Traversable `. @@ -164,7 +164,7 @@ running command operations. See Also -------- -- :phpmethod:`MongoDB\\Collection::aggregate()` +- :phpmethod:`MongoDB\Collection::aggregate()` - :manual:`aggregate ` command reference in the MongoDB manual - :manual:`Aggregation Pipeline ` documentation in diff --git a/docs/reference/method/MongoDBDatabase-command.txt b/docs/reference/method/MongoDBDatabase-command.txt index 50ebfe794..86243d738 100644 --- a/docs/reference/method/MongoDBDatabase-command.txt +++ b/docs/reference/method/MongoDBDatabase-command.txt @@ -13,7 +13,7 @@ MongoDB\\Database::command() Definition ---------- -.. phpmethod:: MongoDB\\Database::command() +.. phpmethod:: MongoDB\Database::command() Execute a :manual:`command ` on the database. This is generally used to execute commands that do not have a corresponding helper @@ -44,11 +44,11 @@ Parameters - Description * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/database-option-readPreference.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -60,7 +60,7 @@ Parameters Return Values ------------- -A :php:`MongoDB\\Driver\\Cursor ` object. +A :php:`MongoDB\Driver\Cursor ` object. Errors/Exceptions ----------------- @@ -102,7 +102,7 @@ Some database commands return a cursor with multiple results. The following example executes :manual:`listCollections `, which returns a cursor containing a result document for each collection in the ``test`` database. Note that this example is illustrative; applications would -generally use :phpmethod:`MongoDB\\Database::listCollections()` in practice. +generally use :phpmethod:`MongoDB\Database::listCollections()` in practice. .. code-block:: php @@ -168,6 +168,6 @@ See Also - :doc:`/tutorial/commands` - :manual:`Database Commands ` in the MongoDB manual -- :php:`MongoDB\\Driver\\Cursor ` -- :php:`MongoDB\\Driver\\Manager::executeCommand() +- :php:`MongoDB\Driver\Cursor ` +- :php:`MongoDB\Driver\Manager::executeCommand() ` diff --git a/docs/reference/method/MongoDBDatabase-createCollection.txt b/docs/reference/method/MongoDBDatabase-createCollection.txt index 2351f5d37..3c45debc9 100644 --- a/docs/reference/method/MongoDBDatabase-createCollection.txt +++ b/docs/reference/method/MongoDBDatabase-createCollection.txt @@ -13,7 +13,7 @@ MongoDB\\Database::createCollection() Definition ---------- -.. phpmethod:: MongoDB\\Database::createCollection() +.. phpmethod:: MongoDB\Database::createCollection() Explicitly creates a collection. @@ -27,7 +27,7 @@ Definition MongoDB creates collections implicitly when you first reference the collection in a command, such as when inserting a document into a new collection. You may also explicitly create a collection with specific options - using the :phpmethod:`MongoDB\\Database::createCollection()` method, or using + using the :phpmethod:`MongoDB\Database::createCollection()` method, or using :manual:`db.createCollection() ` in the MongoDB shell. @@ -195,7 +195,7 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -322,7 +322,7 @@ Parameters .. versionadded:: 1.13 * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/database-option-writeConcern.rst Return Values diff --git a/docs/reference/method/MongoDBDatabase-createEncryptedCollection.txt b/docs/reference/method/MongoDBDatabase-createEncryptedCollection.txt index 390f99c68..e6a266fb4 100644 --- a/docs/reference/method/MongoDBDatabase-createEncryptedCollection.txt +++ b/docs/reference/method/MongoDBDatabase-createEncryptedCollection.txt @@ -15,7 +15,7 @@ MongoDB\\Database::createEncryptedCollection() Definition ---------- -.. phpmethod:: MongoDB\\Database::createEncryptedCollection() +.. phpmethod:: MongoDB\Database::createEncryptedCollection() Explicitly creates an encrypted collection. @@ -31,13 +31,13 @@ Definition This method will automatically create data keys for any encrypted fields where ``keyId`` is ``null``. Data keys will be created using - :php:`MongoDB\\Driver\\ClientEncryption::createDataKey() ` + :php:`MongoDB\Driver\ClientEncryption::createDataKey() ` and the provided ``$kmsProvider`` and ``$masterKey`` parameters. A copy of the modified ``encryptedFields`` option will be returned in addition to the result from creating the collection. This method does not affect any auto encryption settings on existing - :phpclass:`MongoDB\\Client` objects. Users must configure auto encryption + :phpclass:`MongoDB\Client` objects. Users must configure auto encryption after creating the encrypted collection with ``createEncryptedCollection()``. Parameters @@ -46,18 +46,18 @@ Parameters ``$collectionName`` : string The name of the encrypted collection to create. -``$clientEncryption`` : :php:`MongoDB\\Driver\\ClientEncryption ` +``$clientEncryption`` : :php:`MongoDB\Driver\ClientEncryption ` The ClientEncryption object used to create data keys. ``$kmsProvider`` : string KMS provider (e.g. "local", "aws") that will be used to encrypt new data keys. This corresponds to the ``$kmsProvider`` parameter for - :php:`MongoDB\\Driver\\ClientEncryption::createDataKey() `. + :php:`MongoDB\Driver\ClientEncryption::createDataKey() `. ``$masterKey`` : array|null KMS-specific key options that will be used to encrypt new data keys. This corresponds to the ``masterKey`` option for - :php:`MongoDB\\Driver\\ClientEncryption::createDataKey() `. + :php:`MongoDB\Driver\ClientEncryption::createDataKey() `. If ``$kmsProvider`` is "local", this should be ``null``. @@ -65,7 +65,7 @@ Parameters An array specifying the desired options. The ``$options`` parameter supports the same options as - :phpmethod:`MongoDB\\Database::createCollection()`. The ``encryptedFields`` + :phpmethod:`MongoDB\Database::createCollection()`. The ``encryptedFields`` option is required. Return Values @@ -79,7 +79,7 @@ option. Errors/Exceptions ----------------- -:phpclass:`MongoDB\\Exception\\CreateEncryptedCollectionException` if any error +:phpclass:`MongoDB\Exception\CreateEncryptedCollectionException` if any error is encountered creating data keys or the collection. The original exception and modified ``encryptedFields`` option can be accessed via the ``getPrevious()`` and ``getEncryptedFields()`` methods, respectively. @@ -126,11 +126,11 @@ an encrypted string field. If the encrypted collection was successfully created, ``$result`` will contain the response document from the ``create`` command and ``$encryptedFields['fields'][0]['keyId']`` will contain a -:php:`MongoDB\\BSON\\Binary ` object with subtype 4 +:php:`MongoDB\BSON\Binary ` object with subtype 4 (i.e. UUID). The modified ``encryptedFields`` option can then be used to construct a new -:phpclass:`MongoDB\\Client` with auto encryption enabled. +:phpclass:`MongoDB\Client` with auto encryption enabled. .. code-block:: php @@ -155,8 +155,8 @@ The modified ``encryptedFields`` option can then be used to construct a new See Also -------- -- :phpmethod:`MongoDB\\Database::createCollection()` -- :phpmethod:`MongoDB\\Client::createClientEncryption()` -- :php:`MongoDB\\Driver\\ClientEncryption::createDataKey() ` +- :phpmethod:`MongoDB\Database::createCollection()` +- :phpmethod:`MongoDB\Client::createClientEncryption()` +- :php:`MongoDB\Driver\ClientEncryption::createDataKey() ` - :manual:`create ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBDatabase-drop.txt b/docs/reference/method/MongoDBDatabase-drop.txt index 457fad1ae..da1c8ba0e 100644 --- a/docs/reference/method/MongoDBDatabase-drop.txt +++ b/docs/reference/method/MongoDBDatabase-drop.txt @@ -13,7 +13,7 @@ MongoDB\\Database::drop() Definition ---------- -.. phpmethod:: MongoDB\\Database::drop() +.. phpmethod:: MongoDB\Database::drop() Drop the database. @@ -44,7 +44,7 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -56,7 +56,7 @@ Parameters This will be used for the returned command result document. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/database-option-writeConcern.rst Return Values @@ -105,6 +105,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Client::dropDatabase()` +- :phpmethod:`MongoDB\Client::dropDatabase()` - :manual:`dropDatabase ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBDatabase-dropCollection.txt b/docs/reference/method/MongoDBDatabase-dropCollection.txt index 018f3ccaf..71beda83b 100644 --- a/docs/reference/method/MongoDBDatabase-dropCollection.txt +++ b/docs/reference/method/MongoDBDatabase-dropCollection.txt @@ -13,7 +13,7 @@ MongoDB\\Database::dropCollection() Definition ---------- -.. phpmethod:: MongoDB\\Database::dropCollection() +.. phpmethod:: MongoDB\Database::dropCollection() Drop a collection within the current database. @@ -70,7 +70,7 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -82,7 +82,7 @@ Parameters This will be used for the returned command result document. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/database-option-writeConcern.rst Return Values @@ -133,6 +133,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::drop()` +- :phpmethod:`MongoDB\Collection::drop()` - :manual:`drop ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBDatabase-getDatabaseName.txt b/docs/reference/method/MongoDBDatabase-getDatabaseName.txt index 6e3abd966..fcbd0ce86 100644 --- a/docs/reference/method/MongoDBDatabase-getDatabaseName.txt +++ b/docs/reference/method/MongoDBDatabase-getDatabaseName.txt @@ -13,7 +13,7 @@ MongoDB\\Database::getDatabaseName() Definition ---------- -.. phpmethod:: MongoDB\\Database::getDatabaseName() +.. phpmethod:: MongoDB\Database::getDatabaseName() Returns the name of this database. diff --git a/docs/reference/method/MongoDBDatabase-getManager.txt b/docs/reference/method/MongoDBDatabase-getManager.txt index 72a2b0570..91e013ae9 100644 --- a/docs/reference/method/MongoDBDatabase-getManager.txt +++ b/docs/reference/method/MongoDBDatabase-getManager.txt @@ -13,11 +13,11 @@ MongoDB\\Database::getManager() Definition ---------- -.. phpmethod:: MongoDB\\Database::getManager() +.. phpmethod:: MongoDB\Database::getManager() Accessor for the - :php:`MongoDB\\Driver\\Manager ` used by this - :phpclass:`Database `. + :php:`MongoDB\Driver\Manager ` used by this + :phpclass:`Database `. .. code-block:: php @@ -26,10 +26,10 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\Manager ` object. +A :php:`MongoDB\Driver\Manager ` object. See Also -------- -- :phpmethod:`MongoDB\\Client::getManager()` -- :phpmethod:`MongoDB\\Collection::getManager()` +- :phpmethod:`MongoDB\Client::getManager()` +- :phpmethod:`MongoDB\Collection::getManager()` diff --git a/docs/reference/method/MongoDBDatabase-getReadConcern.txt b/docs/reference/method/MongoDBDatabase-getReadConcern.txt index 56568aa4b..4915fcc4b 100644 --- a/docs/reference/method/MongoDBDatabase-getReadConcern.txt +++ b/docs/reference/method/MongoDBDatabase-getReadConcern.txt @@ -15,7 +15,7 @@ MongoDB\\Database::getReadConcern() Definition ---------- -.. phpmethod:: MongoDB\\Database::getReadConcern() +.. phpmethod:: MongoDB\Database::getReadConcern() Returns the read concern for this database. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\ReadConcern ` object. +A :php:`MongoDB\Driver\ReadConcern ` object. Example ------- @@ -54,7 +54,7 @@ See Also -------- - :manual:`Read Concern ` in the MongoDB manual -- :php:`MongoDB\\Driver\\ReadConcern::isDefault() ` -- :phpmethod:`MongoDB\\Client::getReadConcern()` -- :phpmethod:`MongoDB\\Collection::getReadConcern()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()` +- :php:`MongoDB\Driver\ReadConcern::isDefault() ` +- :phpmethod:`MongoDB\Client::getReadConcern()` +- :phpmethod:`MongoDB\Collection::getReadConcern()` +- :phpmethod:`MongoDB\GridFS\Bucket::getReadConcern()` diff --git a/docs/reference/method/MongoDBDatabase-getReadPreference.txt b/docs/reference/method/MongoDBDatabase-getReadPreference.txt index 5001455c7..633633ebf 100644 --- a/docs/reference/method/MongoDBDatabase-getReadPreference.txt +++ b/docs/reference/method/MongoDBDatabase-getReadPreference.txt @@ -15,7 +15,7 @@ MongoDB\\Database::getReadPreference() Definition ---------- -.. phpmethod:: MongoDB\\Database::getReadPreference() +.. phpmethod:: MongoDB\Database::getReadPreference() Returns the read preference for this database. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\ReadPreference ` +A :php:`MongoDB\Driver\ReadPreference ` object. Example @@ -55,6 +55,6 @@ See Also -------- - :manual:`Read Preference ` in the MongoDB manual -- :phpmethod:`MongoDB\\Client::getReadPreference()` -- :phpmethod:`MongoDB\\Collection::getReadPreference()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()` +- :phpmethod:`MongoDB\Client::getReadPreference()` +- :phpmethod:`MongoDB\Collection::getReadPreference()` +- :phpmethod:`MongoDB\GridFS\Bucket::getReadPreference()` diff --git a/docs/reference/method/MongoDBDatabase-getTypeMap.txt b/docs/reference/method/MongoDBDatabase-getTypeMap.txt index d06c67779..a30f4f0d7 100644 --- a/docs/reference/method/MongoDBDatabase-getTypeMap.txt +++ b/docs/reference/method/MongoDBDatabase-getTypeMap.txt @@ -15,7 +15,7 @@ MongoDB\\Database::getTypeMap() Definition ---------- -.. phpmethod:: MongoDB\\Database::getTypeMap() +.. phpmethod:: MongoDB\Database::getTypeMap() Returns the type map for this database. @@ -62,6 +62,6 @@ See Also -------- - :doc:`/reference/bson` -- :phpmethod:`MongoDB\\Client::getTypeMap()` -- :phpmethod:`MongoDB\\Collection::getTypeMap()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()` +- :phpmethod:`MongoDB\Client::getTypeMap()` +- :phpmethod:`MongoDB\Collection::getTypeMap()` +- :phpmethod:`MongoDB\GridFS\Bucket::getTypeMap()` diff --git a/docs/reference/method/MongoDBDatabase-getWriteConcern.txt b/docs/reference/method/MongoDBDatabase-getWriteConcern.txt index 55ea09f4d..40419a4b6 100644 --- a/docs/reference/method/MongoDBDatabase-getWriteConcern.txt +++ b/docs/reference/method/MongoDBDatabase-getWriteConcern.txt @@ -15,7 +15,7 @@ MongoDB\\Database::getWriteConcern() Definition ---------- -.. phpmethod:: MongoDB\\Database::getWriteConcern() +.. phpmethod:: MongoDB\Database::getWriteConcern() Returns the write concern for this database. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\WriteConcern ` +A :php:`MongoDB\Driver\WriteConcern ` object. Example @@ -57,7 +57,7 @@ See Also -------- - :manual:`Write Concern ` in the MongoDB manual -- :php:`MongoDB\\Driver\\WriteConcern::isDefault() ` -- :phpmethod:`MongoDB\\Client::getWriteConcern()` -- :phpmethod:`MongoDB\\Collection::getWriteConcern()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()` +- :php:`MongoDB\Driver\WriteConcern::isDefault() ` +- :phpmethod:`MongoDB\Client::getWriteConcern()` +- :phpmethod:`MongoDB\Collection::getWriteConcern()` +- :phpmethod:`MongoDB\GridFS\Bucket::getWriteConcern()` diff --git a/docs/reference/method/MongoDBDatabase-listCollectionNames.txt b/docs/reference/method/MongoDBDatabase-listCollectionNames.txt index 53814f729..d094028de 100644 --- a/docs/reference/method/MongoDBDatabase-listCollectionNames.txt +++ b/docs/reference/method/MongoDBDatabase-listCollectionNames.txt @@ -15,7 +15,7 @@ MongoDB\\Database::listCollectionNames() Definition ---------- -.. phpmethod:: MongoDB\\Database::listCollectionNames() +.. phpmethod:: MongoDB\Database::listCollectionNames() Returns names for all collections in this database. @@ -68,7 +68,7 @@ Parameters - .. include:: /includes/extracts/common-option-maxTimeMS.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst Return Values @@ -134,7 +134,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Database::listCollections()` +- :phpmethod:`MongoDB\Database::listCollections()` - :manual:`listCollections ` command reference in the MongoDB manual - `Enumerating Collections diff --git a/docs/reference/method/MongoDBDatabase-listCollections.txt b/docs/reference/method/MongoDBDatabase-listCollections.txt index d66b6a5f3..511b89953 100644 --- a/docs/reference/method/MongoDBDatabase-listCollections.txt +++ b/docs/reference/method/MongoDBDatabase-listCollections.txt @@ -13,7 +13,7 @@ MongoDB\\Database::listCollections() Definition ---------- -.. phpmethod:: MongoDB\\Database::listCollections() +.. phpmethod:: MongoDB\Database::listCollections() Returns information for all collections in this database. @@ -66,7 +66,7 @@ Parameters - .. include:: /includes/extracts/common-option-maxTimeMS.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -74,8 +74,8 @@ Parameters Return Values ------------- -A traversable :phpclass:`MongoDB\\Model\\CollectionInfoIterator`, which contains -a :phpclass:`MongoDB\\Model\\CollectionInfo` object for each collection in the +A traversable :phpclass:`MongoDB\Model\CollectionInfoIterator`, which contains +a :phpclass:`MongoDB\Model\CollectionInfo` object for each collection in the database. Example @@ -160,7 +160,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Database::listCollectionNames()` +- :phpmethod:`MongoDB\Database::listCollectionNames()` - :manual:`listCollections ` command reference in the MongoDB manual - `Enumerating Collections diff --git a/docs/reference/method/MongoDBDatabase-modifyCollection.txt b/docs/reference/method/MongoDBDatabase-modifyCollection.txt index 0a756b015..6aa036ff3 100644 --- a/docs/reference/method/MongoDBDatabase-modifyCollection.txt +++ b/docs/reference/method/MongoDBDatabase-modifyCollection.txt @@ -15,7 +15,7 @@ MongoDB\\Database::modifyCollection() Definition ---------- -.. phpmethod:: MongoDB\\Database::modifyCollection() +.. phpmethod:: MongoDB\Database::modifyCollection() Modifies a collection or view according to the specified ``$collectionOptions``. @@ -57,7 +57,7 @@ Parameters .. versionadded:: 1.13 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst * - typeMap @@ -67,7 +67,7 @@ Parameters This will be used for the returned command result document. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/database-option-writeConcern.rst Return Values diff --git a/docs/reference/method/MongoDBDatabase-renameCollection.txt b/docs/reference/method/MongoDBDatabase-renameCollection.txt index 778dc10ad..8c07952d8 100644 --- a/docs/reference/method/MongoDBDatabase-renameCollection.txt +++ b/docs/reference/method/MongoDBDatabase-renameCollection.txt @@ -15,7 +15,7 @@ MongoDB\\Database::renameCollection() Definition ---------- -.. phpmethod:: MongoDB\\Database::renameCollection() +.. phpmethod:: MongoDB\Database::renameCollection() Rename a collection within the current database. @@ -68,7 +68,7 @@ Parameters collection. The default value is ``false``. * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst * - typeMap @@ -78,7 +78,7 @@ Parameters This will be used for the returned command result document. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - .. include:: /includes/extracts/database-option-writeConcern.rst Return Values @@ -126,6 +126,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::rename()` +- :phpmethod:`MongoDB\Collection::rename()` - :manual:`renameCollection ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBDatabase-selectCollection.txt b/docs/reference/method/MongoDBDatabase-selectCollection.txt index 887d4a4d7..854298e09 100644 --- a/docs/reference/method/MongoDBDatabase-selectCollection.txt +++ b/docs/reference/method/MongoDBDatabase-selectCollection.txt @@ -13,7 +13,7 @@ MongoDB\\Database::selectCollection() Definition ---------- -.. phpmethod:: MongoDB\\Database::selectCollection() +.. phpmethod:: MongoDB\Database::selectCollection() Selects a collection within the database. @@ -42,12 +42,12 @@ Parameters - Description * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - The default read concern to use for collection operations. Defaults to the database's read concern. * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - The default read preference to use for collection operations. Defaults to the database's read preference. @@ -57,14 +57,14 @@ Parameters database's type map. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - The default write concern to use for collection operations. Defaults to the database's write concern. Return Values ------------- -A :phpclass:`MongoDB\\Collection` object. +A :phpclass:`MongoDB\Collection` object. Errors/Exceptions ----------------- @@ -75,7 +75,7 @@ Behavior -------- The selected collection inherits options such as read preference and type -mapping from the :phpclass:`Database ` object. Options may be +mapping from the :phpclass:`Database ` object. Options may be overridden via the ``$options`` parameter. Example @@ -110,6 +110,6 @@ database with a custom read preference: See Also -------- -- :phpmethod:`MongoDB\\Database::__get()` -- :phpmethod:`MongoDB\\Client::selectCollection()` -- :phpmethod:`MongoDB\\Collection::__construct()` +- :phpmethod:`MongoDB\Database::__get()` +- :phpmethod:`MongoDB\Client::selectCollection()` +- :phpmethod:`MongoDB\Collection::__construct()` diff --git a/docs/reference/method/MongoDBDatabase-selectGridFSBucket.txt b/docs/reference/method/MongoDBDatabase-selectGridFSBucket.txt index 0d115d9b9..9cebd3fcf 100644 --- a/docs/reference/method/MongoDBDatabase-selectGridFSBucket.txt +++ b/docs/reference/method/MongoDBDatabase-selectGridFSBucket.txt @@ -13,7 +13,7 @@ MongoDB\\Database::selectGridFSBucket() Definition ---------- -.. phpmethod:: MongoDB\\Database::selectGridFSBucket() +.. phpmethod:: MongoDB\Database::selectGridFSBucket() Selects a GridFS bucket within the database. @@ -53,12 +53,12 @@ Parameters .. versionadded: 1.4 * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - The default read concern to use for bucket operations. Defaults to the database's read concern. * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - The default read preference to use for bucket operations. Defaults to the database's read concern. @@ -68,14 +68,14 @@ Parameters database's type map. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - The default write concern to use for bucket operations. Defaults to the database's write concern. Return Values ------------- -A :phpclass:`MongoDB\\GridFS\\Bucket` object. +A :phpclass:`MongoDB\GridFS\Bucket` object. Errors/Exceptions ----------------- @@ -86,7 +86,7 @@ Behavior -------- The selected bucket inherits options such as read preference and type -mapping from the :phpclass:`Database ` object. Options may be +mapping from the :phpclass:`Database ` object. Options may be overridden via the ``$options`` parameter. Example @@ -120,4 +120,4 @@ database with a custom read preference: See Also -------- -- :phpmethod:`MongoDB\\GridFS\\Bucket::__construct()` +- :phpmethod:`MongoDB\GridFS\Bucket::__construct()` diff --git a/docs/reference/method/MongoDBDatabase-watch.txt b/docs/reference/method/MongoDBDatabase-watch.txt index c79656ecb..396e5cfde 100644 --- a/docs/reference/method/MongoDBDatabase-watch.txt +++ b/docs/reference/method/MongoDBDatabase-watch.txt @@ -15,7 +15,7 @@ MongoDB\\Database::watch() Definition ---------- -.. phpmethod:: MongoDB\\Database::watch() +.. phpmethod:: MongoDB\Database::watch() Executes a :manual:`change stream ` operation on the database. The change stream can be watched for database-level changes. @@ -73,11 +73,11 @@ Parameters - .. include:: /includes/extracts/watch-option-maxAwaitTimeMS.rst * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/database-option-readConcern.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/database-option-readPreference.rst This is used for both the initial change stream aggregation and for @@ -88,7 +88,7 @@ Parameters - .. include:: /includes/extracts/watch-option-resumeAfter.rst * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst * - showExpandedEvents @@ -100,7 +100,7 @@ Parameters - .. include:: /includes/extracts/watch-option-startAfter.rst * - startAtOperationTime - - :php:`MongoDB\\BSON\\TimestampInterface ` + - :php:`MongoDB\BSON\TimestampInterface ` - .. include:: /includes/extracts/watch-option-startAtOperationTime.rst * - typeMap @@ -110,7 +110,7 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\ChangeStream` object, which allows for iteration of +A :phpclass:`MongoDB\ChangeStream` object, which allows for iteration of events in the change stream via the :php:`Iterator ` interface. Errors/Exceptions @@ -188,8 +188,8 @@ script was iterating the change stream, the output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::watch()` -- :phpmethod:`MongoDB\\Client::watch()` +- :phpmethod:`MongoDB\Collection::watch()` +- :phpmethod:`MongoDB\Client::watch()` - :manual:`Aggregation Pipeline ` documentation in the MongoDB Manual - :manual:`Change Streams ` documentation in the MongoDB manual diff --git a/docs/reference/method/MongoDBDatabase-withOptions.txt b/docs/reference/method/MongoDBDatabase-withOptions.txt index fc5d88ec8..f601a9772 100644 --- a/docs/reference/method/MongoDBDatabase-withOptions.txt +++ b/docs/reference/method/MongoDBDatabase-withOptions.txt @@ -13,7 +13,7 @@ MongoDB\\Database::withOptions() Definition ---------- -.. phpmethod:: MongoDB\\Database::withOptions() +.. phpmethod:: MongoDB\Database::withOptions() Returns a clone of the Database object, but with different options. @@ -36,12 +36,12 @@ Parameters - Description * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - The default read concern to use for database operations. Defaults to the original database's read concern. * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - The default read preference to use for database operations. Defaults to the original database's read preference. @@ -53,14 +53,14 @@ Parameters to PHP values. Defaults to the original database's type map. * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - The default write concern to use for database operations. Defaults to the original database's write concern. Return Values ------------- -A :phpclass:`MongoDB\\Database` object. +A :phpclass:`MongoDB\Database` object. Errors/Exceptions ----------------- @@ -86,4 +86,4 @@ preference: See Also -------- -- :phpmethod:`MongoDB\\Database::__construct()` +- :phpmethod:`MongoDB\Database::__construct()` diff --git a/docs/reference/method/MongoDBDatabase__construct.txt b/docs/reference/method/MongoDBDatabase__construct.txt index 0a715e994..cf52a134f 100644 --- a/docs/reference/method/MongoDBDatabase__construct.txt +++ b/docs/reference/method/MongoDBDatabase__construct.txt @@ -13,9 +13,9 @@ MongoDB\\Database::__construct() Definition ---------- -.. phpmethod:: MongoDB\\Database::__construct() +.. phpmethod:: MongoDB\Database::__construct() - Constructs a new :phpclass:`Database ` instance. + Constructs a new :phpclass:`Database ` instance. .. code-block:: php @@ -28,7 +28,7 @@ Definition Parameters ---------- -``$manager`` : :php:`MongoDB\\Driver\\Manager ` +``$manager`` : :php:`MongoDB\Driver\Manager ` The :php:`Manager ` instance from the driver. The manager maintains connections between the driver and your MongoDB instances. @@ -47,12 +47,12 @@ Parameters - Description * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - The default read concern to use for database operations. Defaults to the manager's read concern. * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - The default read preference to use for database operations. Defaults to the manager's read preference. @@ -72,7 +72,7 @@ Parameters ] * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - The default write concern to use for database operations. Defaults to the manager's write concern. @@ -85,13 +85,13 @@ Behavior -------- If you construct a Database explicitly, the Database inherits any options from -the :php:`MongoDB\\Driver\\Manager ` object. If -you select the Database from a :phpclass:`Client ` object, the +the :php:`MongoDB\Driver\Manager ` object. If +you select the Database from a :phpclass:`Client ` object, the Database inherits its options from that object. See Also -------- -- :phpmethod:`MongoDB\\Database::withOptions()` -- :phpmethod:`MongoDB\\Client::selectDatabase()` -- :phpmethod:`MongoDB\\Client::__get()` +- :phpmethod:`MongoDB\Database::withOptions()` +- :phpmethod:`MongoDB\Client::selectDatabase()` +- :phpmethod:`MongoDB\Client::__get()` diff --git a/docs/reference/method/MongoDBDatabase__get.txt b/docs/reference/method/MongoDBDatabase__get.txt index c888a7161..e71c42d4e 100644 --- a/docs/reference/method/MongoDBDatabase__get.txt +++ b/docs/reference/method/MongoDBDatabase__get.txt @@ -13,7 +13,7 @@ MongoDB\\Database::__get() Definition ---------- -.. phpmethod:: MongoDB\\Database::__get() +.. phpmethod:: MongoDB\Database::__get() Select a collection within the database. @@ -30,14 +30,14 @@ Parameters Return Values ------------- -A :phpclass:`MongoDB\\Collection` object. +A :phpclass:`MongoDB\Collection` object. Behavior -------- The selected collection inherits options such as read preference and type -mapping from the :phpclass:`Database ` object. If you wish to -override any options, use the :phpmethod:`MongoDB\\Database::selectCollection()` +mapping from the :phpclass:`Database ` object. If you wish to +override any options, use the :phpmethod:`MongoDB\Database::selectCollection()` method. .. note:: @@ -45,7 +45,7 @@ method. To select collections whose names contain special characters, such as ``.``, use complex syntax, as in ``$database->{'that.database'}``. - Alternatively, :phpmethod:`MongoDB\\Database::selectCollection()` supports + Alternatively, :phpmethod:`MongoDB\Database::selectCollection()` supports selecting collections whose names contain special characters. Examples @@ -66,6 +66,6 @@ collections from the ``test`` database: See Also -------- -- :phpmethod:`MongoDB\\Database::selectCollection()` -- :phpmethod:`MongoDB\\Client::selectCollection()` +- :phpmethod:`MongoDB\Database::selectCollection()` +- :phpmethod:`MongoDB\Client::selectCollection()` - :php:`Property Overloading ` in the PHP Manual diff --git a/docs/reference/method/MongoDBDeleteResult-getDeletedCount.txt b/docs/reference/method/MongoDBDeleteResult-getDeletedCount.txt index dcda25741..028105698 100644 --- a/docs/reference/method/MongoDBDeleteResult-getDeletedCount.txt +++ b/docs/reference/method/MongoDBDeleteResult-getDeletedCount.txt @@ -13,7 +13,7 @@ MongoDB\\DeleteResult::getDeletedCount() Definition ---------- -.. phpmethod:: MongoDB\\DeleteResult::getDeletedCount() +.. phpmethod:: MongoDB\DeleteResult::getDeletedCount() Return the number of documents that were deleted. @@ -36,5 +36,5 @@ Errors/Exceptions See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::getDeletedCount() +- :php:`MongoDB\Driver\WriteResult::getDeletedCount() ` diff --git a/docs/reference/method/MongoDBDeleteResult-isAcknowledged.txt b/docs/reference/method/MongoDBDeleteResult-isAcknowledged.txt index a82fa5238..5e3cbb4e7 100644 --- a/docs/reference/method/MongoDBDeleteResult-isAcknowledged.txt +++ b/docs/reference/method/MongoDBDeleteResult-isAcknowledged.txt @@ -13,7 +13,7 @@ MongoDB\\DeleteResult::isAcknowledged() Definition ---------- -.. phpmethod:: MongoDB\\DeleteResult::isAcknowledged() +.. phpmethod:: MongoDB\DeleteResult::isAcknowledged() Return whether the write was acknowledged. @@ -29,6 +29,6 @@ A boolean indicating whether the write was acknowledged. See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::isAcknowledged() +- :php:`MongoDB\Driver\WriteResult::isAcknowledged() ` - :manual:`Write Concern ` in the MongoDB manual diff --git a/docs/reference/method/MongoDBGridFSBucket-delete.txt b/docs/reference/method/MongoDBGridFSBucket-delete.txt index 731fb4e4d..9c876c601 100644 --- a/docs/reference/method/MongoDBGridFSBucket-delete.txt +++ b/docs/reference/method/MongoDBGridFSBucket-delete.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::delete() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::delete() +.. phpmethod:: MongoDB\GridFS\Bucket::delete() Delete a file and its chunks from the GridFS bucket. diff --git a/docs/reference/method/MongoDBGridFSBucket-downloadToStream.txt b/docs/reference/method/MongoDBGridFSBucket-downloadToStream.txt index 917f03b55..217fc2621 100644 --- a/docs/reference/method/MongoDBGridFSBucket-downloadToStream.txt +++ b/docs/reference/method/MongoDBGridFSBucket-downloadToStream.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::downloadToStream() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::downloadToStream() +.. phpmethod:: MongoDB\GridFS\Bucket::downloadToStream() Selects a GridFS file by its ``_id`` and copies its contents to a writable stream. @@ -68,6 +68,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStreamByName()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::openDownloadStream()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::openDownloadStreamByName()` +- :phpmethod:`MongoDB\GridFS\Bucket::downloadToStreamByName()` +- :phpmethod:`MongoDB\GridFS\Bucket::openDownloadStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::openDownloadStreamByName()` diff --git a/docs/reference/method/MongoDBGridFSBucket-downloadToStreamByName.txt b/docs/reference/method/MongoDBGridFSBucket-downloadToStreamByName.txt index 8bd4a1d65..d520793af 100644 --- a/docs/reference/method/MongoDBGridFSBucket-downloadToStreamByName.txt +++ b/docs/reference/method/MongoDBGridFSBucket-downloadToStreamByName.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::downloadToStreamByName() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::downloadToStreamByName() +.. phpmethod:: MongoDB\GridFS\Bucket::downloadToStreamByName() Selects a GridFS file by its ``filename`` and copies its contents to a writable stream. @@ -99,6 +99,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStream()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::openDownloadStream()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::openDownloadStreamByName()` +- :phpmethod:`MongoDB\GridFS\Bucket::downloadToStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::openDownloadStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::openDownloadStreamByName()` diff --git a/docs/reference/method/MongoDBGridFSBucket-drop.txt b/docs/reference/method/MongoDBGridFSBucket-drop.txt index 53a10091a..324db8547 100644 --- a/docs/reference/method/MongoDBGridFSBucket-drop.txt +++ b/docs/reference/method/MongoDBGridFSBucket-drop.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::drop() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::drop() +.. phpmethod:: MongoDB\GridFS\Bucket::drop() Drops the files and chunks collections associated with this GridFS bucket. diff --git a/docs/reference/method/MongoDBGridFSBucket-find.txt b/docs/reference/method/MongoDBGridFSBucket-find.txt index d112dd668..bfd570896 100644 --- a/docs/reference/method/MongoDBGridFSBucket-find.txt +++ b/docs/reference/method/MongoDBGridFSBucket-find.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::find() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::find() +.. phpmethod:: MongoDB\GridFS\Bucket::find() Finds documents from the GridFS bucket's files collection matching the query. @@ -156,7 +156,7 @@ Parameters { ts: { $gte: } } - The :php:`MongoDB\\BSON\\Timestamp ` + The :php:`MongoDB\BSON\Timestamp ` class reference describes how to represent MongoDB's BSON timestamp type with PHP. @@ -171,13 +171,13 @@ Parameters the MongoDB manual. * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/bucket-option-readConcern.rst .. include:: /includes/extracts/common-option-readConcern-transaction.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/bucket-option-readPreference.rst * - returnKey @@ -187,7 +187,7 @@ Parameters .. versionadded:: 1.2 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -222,7 +222,7 @@ Parameters Return Values ------------- -A :php:`MongoDB\\Driver\\Cursor ` object. +A :php:`MongoDB\Driver\Cursor ` object. Errors/Exceptions ----------------- @@ -285,5 +285,5 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::find()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::findOne()` +- :phpmethod:`MongoDB\Collection::find()` +- :phpmethod:`MongoDB\GridFS\Bucket::findOne()` diff --git a/docs/reference/method/MongoDBGridFSBucket-findOne.txt b/docs/reference/method/MongoDBGridFSBucket-findOne.txt index 1ff9f2588..89877e3a7 100644 --- a/docs/reference/method/MongoDBGridFSBucket-findOne.txt +++ b/docs/reference/method/MongoDBGridFSBucket-findOne.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::findOne() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::findOne() +.. phpmethod:: MongoDB\GridFS\Bucket::findOne() Finds a single document from the GridFS bucket's files collection matching the query. @@ -114,7 +114,7 @@ Parameters { ts: { $gte: } } - The :php:`MongoDB\\BSON\\Timestamp ` + The :php:`MongoDB\BSON\Timestamp ` class reference describes how to represent MongoDB's BSON timestamp type with PHP. @@ -129,13 +129,13 @@ Parameters the MongoDB manual. * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - .. include:: /includes/extracts/bucket-option-readConcern.rst .. include:: /includes/extracts/common-option-readConcern-transaction.rst * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - .. include:: /includes/extracts/bucket-option-readPreference.rst * - returnKey @@ -145,7 +145,7 @@ Parameters .. versionadded:: 1.2 * - session - - :php:`MongoDB\\Driver\\Session ` + - :php:`MongoDB\Driver\Session ` - .. include:: /includes/extracts/common-option-session.rst .. versionadded:: 1.3 @@ -236,5 +236,5 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::findOne()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::find()` +- :phpmethod:`MongoDB\Collection::findOne()` +- :phpmethod:`MongoDB\GridFS\Bucket::find()` diff --git a/docs/reference/method/MongoDBGridFSBucket-getBucketName.txt b/docs/reference/method/MongoDBGridFSBucket-getBucketName.txt index 52ea92497..96a61c4d6 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getBucketName.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getBucketName.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::getBucketName() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::getBucketName() +.. phpmethod:: MongoDB\GridFS\Bucket::getBucketName() Returns the name of this bucket. diff --git a/docs/reference/method/MongoDBGridFSBucket-getChunkSizeBytes.txt b/docs/reference/method/MongoDBGridFSBucket-getChunkSizeBytes.txt index 16116e562..2a9ff6dab 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getChunkSizeBytes.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getChunkSizeBytes.txt @@ -15,7 +15,7 @@ MongoDB\\GridFS\\Bucket::getChunkSizeBytes() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::getChunkSizeBytes() +.. phpmethod:: MongoDB\GridFS\Bucket::getChunkSizeBytes() Returns the chunk size of this bucket in bytes. diff --git a/docs/reference/method/MongoDBGridFSBucket-getChunksCollection.txt b/docs/reference/method/MongoDBGridFSBucket-getChunksCollection.txt index 36dbd8a59..ce1c97b92 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getChunksCollection.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getChunksCollection.txt @@ -15,7 +15,7 @@ MongoDB\\GridFS\\Bucket::getChunksCollection() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::getChunksCollection() +.. phpmethod:: MongoDB\GridFS\Bucket::getChunksCollection() Returns the chunks collection used by the bucket. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :phpclass:`MongoDB\\Collection` object for the chunks collection. +A :phpclass:`MongoDB\Collection` object for the chunks collection. Examples -------- diff --git a/docs/reference/method/MongoDBGridFSBucket-getDatabaseName.txt b/docs/reference/method/MongoDBGridFSBucket-getDatabaseName.txt index 0b6dd8e0b..22703fddd 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getDatabaseName.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getDatabaseName.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::getDatabaseName() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::getDatabaseName() +.. phpmethod:: MongoDB\GridFS\Bucket::getDatabaseName() Returns the name of the database containing this bucket. diff --git a/docs/reference/method/MongoDBGridFSBucket-getFileDocumentForStream.txt b/docs/reference/method/MongoDBGridFSBucket-getFileDocumentForStream.txt index fa8625f9d..9dc275ca2 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getFileDocumentForStream.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getFileDocumentForStream.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::getFileDocumentForStream() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::getFileDocumentForStream() +.. phpmethod:: MongoDB\GridFS\Bucket::getFileDocumentForStream() Gets the file document of the GridFS file associated with a stream. @@ -78,4 +78,4 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\GridFS\\Bucket::getFileIdForStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::getFileIdForStream()` diff --git a/docs/reference/method/MongoDBGridFSBucket-getFileIdForStream.txt b/docs/reference/method/MongoDBGridFSBucket-getFileIdForStream.txt index b42ab19b3..0107b3d8a 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getFileIdForStream.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getFileIdForStream.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::getFileIdForStream() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::getFileIdForStream() +.. phpmethod:: MongoDB\GridFS\Bucket::getFileIdForStream() Gets the file document's ID of the GridFS file associated with a stream. @@ -69,4 +69,4 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\GridFS\\Bucket::getFileDocumentForStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::getFileDocumentForStream()` diff --git a/docs/reference/method/MongoDBGridFSBucket-getFilesCollection.txt b/docs/reference/method/MongoDBGridFSBucket-getFilesCollection.txt index 57813ad6d..510cfad1b 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getFilesCollection.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getFilesCollection.txt @@ -15,7 +15,7 @@ MongoDB\\GridFS\\Bucket::getFilesCollection() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::getFilesCollection() +.. phpmethod:: MongoDB\GridFS\Bucket::getFilesCollection() Returns the files collection used by the bucket. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :phpclass:`MongoDB\\Collection` object for the files collection. +A :phpclass:`MongoDB\Collection` object for the files collection. Examples -------- diff --git a/docs/reference/method/MongoDBGridFSBucket-getReadConcern.txt b/docs/reference/method/MongoDBGridFSBucket-getReadConcern.txt index 7b12c0513..d1d4c6102 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getReadConcern.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getReadConcern.txt @@ -15,7 +15,7 @@ MongoDB\\GridFS\\Bucket::getReadConcern() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::getReadConcern() +.. phpmethod:: MongoDB\GridFS\Bucket::getReadConcern() Returns the read concern for this GridFS bucket. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\ReadConcern ` object. +A :php:`MongoDB\Driver\ReadConcern ` object. Example ------- @@ -55,7 +55,7 @@ See Also -------- - :manual:`Read Concern ` in the MongoDB manual -- :php:`MongoDB\\Driver\\ReadConcern::isDefault() ` -- :phpmethod:`MongoDB\\Client::getReadConcern()` -- :phpmethod:`MongoDB\\Collection::getReadConcern()` -- :phpmethod:`MongoDB\\Database::getReadConcern()` +- :php:`MongoDB\Driver\ReadConcern::isDefault() ` +- :phpmethod:`MongoDB\Client::getReadConcern()` +- :phpmethod:`MongoDB\Collection::getReadConcern()` +- :phpmethod:`MongoDB\Database::getReadConcern()` diff --git a/docs/reference/method/MongoDBGridFSBucket-getReadPreference.txt b/docs/reference/method/MongoDBGridFSBucket-getReadPreference.txt index 532a6e23e..6843cc93c 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getReadPreference.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getReadPreference.txt @@ -15,7 +15,7 @@ MongoDB\\GridFS\\Bucket::getReadPreference() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::getReadPreference() +.. phpmethod:: MongoDB\GridFS\Bucket::getReadPreference() Returns the read preference for this GridFS bucket. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\ReadPreference ` +A :php:`MongoDB\Driver\ReadPreference ` object. Example @@ -56,6 +56,6 @@ See Also -------- - :manual:`Read Preference ` in the MongoDB manual -- :phpmethod:`MongoDB\\Client::getReadPreference()` -- :phpmethod:`MongoDB\\Collection::getReadPreference()` -- :phpmethod:`MongoDB\\Database::getReadPreference()` +- :phpmethod:`MongoDB\Client::getReadPreference()` +- :phpmethod:`MongoDB\Collection::getReadPreference()` +- :phpmethod:`MongoDB\Database::getReadPreference()` diff --git a/docs/reference/method/MongoDBGridFSBucket-getTypeMap.txt b/docs/reference/method/MongoDBGridFSBucket-getTypeMap.txt index 7d9a309a3..1005f2a28 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getTypeMap.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getTypeMap.txt @@ -15,7 +15,7 @@ MongoDB\\GridFS\\Bucket::getTypeMap() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::getTypeMap() +.. phpmethod:: MongoDB\GridFS\Bucket::getTypeMap() Returns the type map for this GridFS bucket. @@ -63,6 +63,6 @@ See Also -------- - :doc:`/reference/bson` -- :phpmethod:`MongoDB\\Client::getTypeMap()` -- :phpmethod:`MongoDB\\Collection::getTypeMap()` -- :phpmethod:`MongoDB\\Database::getTypeMap()` +- :phpmethod:`MongoDB\Client::getTypeMap()` +- :phpmethod:`MongoDB\Collection::getTypeMap()` +- :phpmethod:`MongoDB\Database::getTypeMap()` diff --git a/docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt b/docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt index 77303b92a..21e535af6 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt @@ -15,7 +15,7 @@ MongoDB\\GridFS\\Bucket::getWriteConcern() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::getWriteConcern() +.. phpmethod:: MongoDB\GridFS\Bucket::getWriteConcern() Returns the write concern for this GridFS bucket. @@ -26,7 +26,7 @@ Definition Return Values ------------- -A :php:`MongoDB\\Driver\\WriteConcern ` +A :php:`MongoDB\Driver\WriteConcern ` object. Example @@ -58,7 +58,7 @@ See Also -------- - :manual:`Write Concern ` in the MongoDB manual -- :php:`MongoDB\\Driver\\WriteConcern::isDefault() ` -- :phpmethod:`MongoDB\\Client::getWriteConcern()` -- :phpmethod:`MongoDB\\Collection::getWriteConcern()` -- :phpmethod:`MongoDB\\Database::getWriteConcern()` +- :php:`MongoDB\Driver\WriteConcern::isDefault() ` +- :phpmethod:`MongoDB\Client::getWriteConcern()` +- :phpmethod:`MongoDB\Collection::getWriteConcern()` +- :phpmethod:`MongoDB\Database::getWriteConcern()` diff --git a/docs/reference/method/MongoDBGridFSBucket-openDownloadStream.txt b/docs/reference/method/MongoDBGridFSBucket-openDownloadStream.txt index 9118cecc7..bfabc2825 100644 --- a/docs/reference/method/MongoDBGridFSBucket-openDownloadStream.txt +++ b/docs/reference/method/MongoDBGridFSBucket-openDownloadStream.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::openDownloadStream() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::openDownloadStream() +.. phpmethod:: MongoDB\GridFS\Bucket::openDownloadStream() Selects a GridFS file by its ``_id`` and opens it as a readable stream. @@ -66,6 +66,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStream()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStreamByName()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::openDownloadStreamByName()` +- :phpmethod:`MongoDB\GridFS\Bucket::downloadToStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::downloadToStreamByName()` +- :phpmethod:`MongoDB\GridFS\Bucket::openDownloadStreamByName()` diff --git a/docs/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt b/docs/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt index 4c0b525dd..287cf4b52 100644 --- a/docs/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt +++ b/docs/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::openDownloadStreamByName() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::openDownloadStreamByName() +.. phpmethod:: MongoDB\GridFS\Bucket::openDownloadStreamByName() Selects a GridFS file by its ``filename`` and opens it as a readable stream. @@ -94,6 +94,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStream()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStreamByName()` -- :phpmethod:`MongoDB\\GridFS\\Bucket::openDownloadStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::downloadToStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::downloadToStreamByName()` +- :phpmethod:`MongoDB\GridFS\Bucket::openDownloadStream()` diff --git a/docs/reference/method/MongoDBGridFSBucket-openUploadStream.txt b/docs/reference/method/MongoDBGridFSBucket-openUploadStream.txt index 2870b5445..24baebdef 100644 --- a/docs/reference/method/MongoDBGridFSBucket-openUploadStream.txt +++ b/docs/reference/method/MongoDBGridFSBucket-openUploadStream.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::openUploadStream() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::openUploadStream() +.. phpmethod:: MongoDB\GridFS\Bucket::openUploadStream() Opens a writable stream for a new GridFS file. @@ -44,7 +44,7 @@ Parameters * - _id - mixed - Value to use as the file document identifier. Defaults to a new - :php:`MongoDB\\BSON\\ObjectId ` object. + :php:`MongoDB\BSON\ObjectId ` object. * - chunkSizeBytes - integer @@ -100,4 +100,4 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\GridFS\\Bucket::uploadFromStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::uploadFromStream()` diff --git a/docs/reference/method/MongoDBGridFSBucket-rename.txt b/docs/reference/method/MongoDBGridFSBucket-rename.txt index 20d9c1d7f..75545a8a3 100644 --- a/docs/reference/method/MongoDBGridFSBucket-rename.txt +++ b/docs/reference/method/MongoDBGridFSBucket-rename.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::rename() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::rename() +.. phpmethod:: MongoDB\GridFS\Bucket::rename() Selects a GridFS file by its ``_id`` and alters its ``filename``. diff --git a/docs/reference/method/MongoDBGridFSBucket-uploadFromStream.txt b/docs/reference/method/MongoDBGridFSBucket-uploadFromStream.txt index 89cb8d2f3..0ba54e9f6 100644 --- a/docs/reference/method/MongoDBGridFSBucket-uploadFromStream.txt +++ b/docs/reference/method/MongoDBGridFSBucket-uploadFromStream.txt @@ -13,7 +13,7 @@ MongoDB\\GridFS\\Bucket::uploadFromStream() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::uploadFromStream() +.. phpmethod:: MongoDB\GridFS\Bucket::uploadFromStream() Creates a new GridFS file and copies the contents of a readable stream to it. @@ -48,7 +48,7 @@ Parameters * - _id - mixed - Value to use as the file document identifier. Defaults to a new - :php:`MongoDB\\BSON\\ObjectId ` object. + :php:`MongoDB\BSON\ObjectId ` object. * - chunkSizeBytes - integer @@ -73,7 +73,7 @@ Return Values The ``_id`` field of the metadata document associated with the newly created GridFS file. If the ``_id`` option is not specified, a new -:php:`MongoDB\\BSON\\ObjectId ` object will be used +:php:`MongoDB\BSON\ObjectId ` object will be used by default. Errors/Exceptions @@ -111,4 +111,4 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\GridFS\\Bucket::openUploadStream()` +- :phpmethod:`MongoDB\GridFS\Bucket::openUploadStream()` diff --git a/docs/reference/method/MongoDBGridFSBucket__construct.txt b/docs/reference/method/MongoDBGridFSBucket__construct.txt index 25271e0cb..766e8650d 100644 --- a/docs/reference/method/MongoDBGridFSBucket__construct.txt +++ b/docs/reference/method/MongoDBGridFSBucket__construct.txt @@ -13,9 +13,9 @@ MongoDB\\GridFS\\Bucket::__construct() Definition ---------- -.. phpmethod:: MongoDB\\GridFS\\Bucket::__construct() +.. phpmethod:: MongoDB\GridFS\Bucket::__construct() - Constructs a new :phpclass:`Bucket ` instance. + Constructs a new :phpclass:`Bucket ` instance. .. code-block:: php @@ -28,7 +28,7 @@ Definition Parameters ---------- -``$manager`` : :php:`MongoDB\\Driver\\Manager ` +``$manager`` : :php:`MongoDB\Driver\Manager ` The :php:`Manager ` instance from the driver. The manager maintains connections between the driver and your MongoDB instances. @@ -64,12 +64,12 @@ Parameters .. versionadded: 1.4 * - readConcern - - :php:`MongoDB\\Driver\\ReadConcern ` + - :php:`MongoDB\Driver\ReadConcern ` - The default read concern to use for bucket operations. Defaults to the manager's read concern. * - readPreference - - :php:`MongoDB\\Driver\\ReadPreference ` + - :php:`MongoDB\Driver\ReadPreference ` - The default read preference to use for bucket operations. Defaults to the manager's read preference. @@ -89,7 +89,7 @@ Parameters ] * - writeConcern - - :php:`MongoDB\\Driver\\WriteConcern ` + - :php:`MongoDB\Driver\WriteConcern ` - The default write concern to use for bucket operations. Defaults to the manager's write concern. @@ -102,8 +102,8 @@ Behavior -------- If you construct a Bucket explicitly, the Bucket inherits any options -from the :php:`MongoDB\\Driver\\Manager ` object. -If you select the Bucket from a :phpclass:`Database ` object, +from the :php:`MongoDB\Driver\Manager ` object. +If you select the Bucket from a :phpclass:`Database ` object, the Bucket inherits its options from that object. Examples @@ -131,4 +131,4 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Database::selectGridFSBucket()` +- :phpmethod:`MongoDB\Database::selectGridFSBucket()` diff --git a/docs/reference/method/MongoDBInsertManyResult-getInsertedCount.txt b/docs/reference/method/MongoDBInsertManyResult-getInsertedCount.txt index 9297008bf..f114b4569 100644 --- a/docs/reference/method/MongoDBInsertManyResult-getInsertedCount.txt +++ b/docs/reference/method/MongoDBInsertManyResult-getInsertedCount.txt @@ -13,7 +13,7 @@ MongoDB\\InsertManyResult::getInsertedCount() Definition ---------- -.. phpmethod:: MongoDB\\InsertManyResult::getInsertedCount() +.. phpmethod:: MongoDB\InsertManyResult::getInsertedCount() Return the number of documents that were inserted. @@ -36,5 +36,5 @@ Errors/Exceptions See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::getInsertedCount() +- :php:`MongoDB\Driver\WriteResult::getInsertedCount() ` diff --git a/docs/reference/method/MongoDBInsertManyResult-getInsertedIds.txt b/docs/reference/method/MongoDBInsertManyResult-getInsertedIds.txt index 75c638703..bf30e28bb 100644 --- a/docs/reference/method/MongoDBInsertManyResult-getInsertedIds.txt +++ b/docs/reference/method/MongoDBInsertManyResult-getInsertedIds.txt @@ -13,7 +13,7 @@ MongoDB\\InsertManyResult::getInsertedIds() Definition ---------- -.. phpmethod:: MongoDB\\InsertManyResult::getInsertedIds() +.. phpmethod:: MongoDB\InsertManyResult::getInsertedIds() Return a map of IDs (i.e. ``_id`` field values) for the inserted documents. @@ -32,5 +32,5 @@ A map of IDs (i.e. ``_id`` field values) for the inserted documents. The index of each ID in the map corresponds to each document's position in the bulk operation. If a document had an ID prior to inserting (i.e. the driver did not generate an ID), the index will contain its ``_id`` field value. Any -driver-generated ID will be a :php:`MongoDB\\BSON\\ObjectId +driver-generated ID will be a :php:`MongoDB\BSON\ObjectId ` instance. diff --git a/docs/reference/method/MongoDBInsertManyResult-isAcknowledged.txt b/docs/reference/method/MongoDBInsertManyResult-isAcknowledged.txt index db376e5fa..2589edb4e 100644 --- a/docs/reference/method/MongoDBInsertManyResult-isAcknowledged.txt +++ b/docs/reference/method/MongoDBInsertManyResult-isAcknowledged.txt @@ -13,7 +13,7 @@ MongoDB\\InsertManyResult::isAcknowledged() Definition ---------- -.. phpmethod:: MongoDB\\InsertManyResult::isAcknowledged() +.. phpmethod:: MongoDB\InsertManyResult::isAcknowledged() Return whether the write was acknowledged. @@ -29,6 +29,6 @@ A boolean indicating whether the write was acknowledged. See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::isAcknowledged() +- :php:`MongoDB\Driver\WriteResult::isAcknowledged() ` - :manual:`Write Concern ` in the MongoDB manual diff --git a/docs/reference/method/MongoDBInsertOneResult-getInsertedCount.txt b/docs/reference/method/MongoDBInsertOneResult-getInsertedCount.txt index 355080150..d6ba12792 100644 --- a/docs/reference/method/MongoDBInsertOneResult-getInsertedCount.txt +++ b/docs/reference/method/MongoDBInsertOneResult-getInsertedCount.txt @@ -13,7 +13,7 @@ MongoDB\\InsertOneResult::getInsertedCount() Definition ---------- -.. phpmethod:: MongoDB\\InsertOneResult::getInsertedCount() +.. phpmethod:: MongoDB\InsertOneResult::getInsertedCount() Return the number of documents that were inserted. @@ -37,5 +37,5 @@ Errors/Exceptions See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::getInsertedCount() +- :php:`MongoDB\Driver\WriteResult::getInsertedCount() ` diff --git a/docs/reference/method/MongoDBInsertOneResult-getInsertedId.txt b/docs/reference/method/MongoDBInsertOneResult-getInsertedId.txt index 8d4a01ddf..e3cef55d0 100644 --- a/docs/reference/method/MongoDBInsertOneResult-getInsertedId.txt +++ b/docs/reference/method/MongoDBInsertOneResult-getInsertedId.txt @@ -13,7 +13,7 @@ MongoDB\\InsertOneResult::getInsertedId() Definition ---------- -.. phpmethod:: MongoDB\\InsertOneResult::getInsertedId() +.. phpmethod:: MongoDB\InsertOneResult::getInsertedId() Return the ID (i.e. ``_id`` field value) for the inserted document. @@ -31,5 +31,5 @@ The ID (i.e. ``_id`` field value) of the inserted document. If the document had an ID prior to inserting (i.e. the driver did not need to generate an ID), this will contain its ``_id`` field value. Any driver-generated -ID will be a :php:`MongoDB\\BSON\\ObjectId ` +ID will be a :php:`MongoDB\BSON\ObjectId ` instance. diff --git a/docs/reference/method/MongoDBInsertOneResult-isAcknowledged.txt b/docs/reference/method/MongoDBInsertOneResult-isAcknowledged.txt index 921e3a611..3e4505cd7 100644 --- a/docs/reference/method/MongoDBInsertOneResult-isAcknowledged.txt +++ b/docs/reference/method/MongoDBInsertOneResult-isAcknowledged.txt @@ -13,7 +13,7 @@ MongoDB\\InsertOneResult::isAcknowledged() Definition ---------- -.. phpmethod:: MongoDB\\InsertOneResult::isAcknowledged() +.. phpmethod:: MongoDB\InsertOneResult::isAcknowledged() Return whether the write was acknowledged. @@ -29,6 +29,6 @@ A boolean indicating whether the write was acknowledged. See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::isAcknowledged() +- :php:`MongoDB\Driver\WriteResult::isAcknowledged() ` - :manual:`Write Concern ` in the MongoDB manual diff --git a/docs/reference/method/MongoDBMapReduceResult-getCounts.txt b/docs/reference/method/MongoDBMapReduceResult-getCounts.txt index 35c738ddc..50cae3ef6 100644 --- a/docs/reference/method/MongoDBMapReduceResult-getCounts.txt +++ b/docs/reference/method/MongoDBMapReduceResult-getCounts.txt @@ -13,7 +13,7 @@ MongoDB\\MapReduceResult::getCounts() Definition ---------- -.. phpmethod:: MongoDB\\MapReduceResult::getCounts() +.. phpmethod:: MongoDB\MapReduceResult::getCounts() Returns count statistics for the map-reduce operation. @@ -63,6 +63,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::mapReduce()` +- :phpmethod:`MongoDB\Collection::mapReduce()` - :manual:`mapReduce ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBMapReduceResult-getExecutionTimeMS.txt b/docs/reference/method/MongoDBMapReduceResult-getExecutionTimeMS.txt index 05b6bbc17..fd094fed0 100644 --- a/docs/reference/method/MongoDBMapReduceResult-getExecutionTimeMS.txt +++ b/docs/reference/method/MongoDBMapReduceResult-getExecutionTimeMS.txt @@ -13,7 +13,7 @@ MongoDB\\MapReduceResult::getExecutionTimeMS() Definition ---------- -.. phpmethod:: MongoDB\\MapReduceResult::getExecutionTimeMS() +.. phpmethod:: MongoDB\MapReduceResult::getExecutionTimeMS() Returns the execution time in milliseconds of the map-reduce operation. @@ -55,6 +55,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::mapReduce()` +- :phpmethod:`MongoDB\Collection::mapReduce()` - :manual:`mapReduce ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBMapReduceResult-getIterator.txt b/docs/reference/method/MongoDBMapReduceResult-getIterator.txt index cb459cde6..9de948952 100644 --- a/docs/reference/method/MongoDBMapReduceResult-getIterator.txt +++ b/docs/reference/method/MongoDBMapReduceResult-getIterator.txt @@ -13,7 +13,7 @@ MongoDB\\MapReduceResult::getIterator() Definition ---------- -.. phpmethod:: MongoDB\\MapReduceResult::getIterator() +.. phpmethod:: MongoDB\MapReduceResult::getIterator() Returns a :php:`Traversable `, which may be used to iterate through the results of the map-reduce operation. @@ -81,5 +81,5 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::mapReduce()` +- :phpmethod:`MongoDB\Collection::mapReduce()` - :php:`IteratorAggregate::getIterator() ` diff --git a/docs/reference/method/MongoDBMapReduceResult-getTiming.txt b/docs/reference/method/MongoDBMapReduceResult-getTiming.txt index 0492b3bec..982682850 100644 --- a/docs/reference/method/MongoDBMapReduceResult-getTiming.txt +++ b/docs/reference/method/MongoDBMapReduceResult-getTiming.txt @@ -13,7 +13,7 @@ MongoDB\\MapReduceResult::getTiming() Definition ---------- -.. phpmethod:: MongoDB\\MapReduceResult::getTiming() +.. phpmethod:: MongoDB\MapReduceResult::getTiming() Returns timing statistics for the map-reduce operation. @@ -22,7 +22,7 @@ Definition function getTiming(): array Timing statistics will only be available if the ``verbose`` option was - specified for :phpmethod:`MongoDB\\Collection::mapReduce()`. + specified for :phpmethod:`MongoDB\Collection::mapReduce()`. Return Values ------------- @@ -34,7 +34,7 @@ Examples -------- This example specifies the ``verbose`` option for -:phpmethod:`MongoDB\\Collection::mapReduce()` and reports the timing statistics +:phpmethod:`MongoDB\Collection::mapReduce()` and reports the timing statistics for a map-reduce operation. .. code-block:: php @@ -71,6 +71,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::mapReduce()` +- :phpmethod:`MongoDB\Collection::mapReduce()` - :manual:`mapReduce ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelCollectionInfo-getCappedMax.txt b/docs/reference/method/MongoDBModelCollectionInfo-getCappedMax.txt index dcd8e703f..0b86f3504 100644 --- a/docs/reference/method/MongoDBModelCollectionInfo-getCappedMax.txt +++ b/docs/reference/method/MongoDBModelCollectionInfo-getCappedMax.txt @@ -15,10 +15,10 @@ MongoDB\\Model\\CollectionInfo::getCappedMax() Definition ---------- -.. phpmethod:: MongoDB\\Model\\CollectionInfo::getCappedMax() +.. phpmethod:: MongoDB\Model\CollectionInfo::getCappedMax() Return the document limit for the capped collection. This correlates with the - ``max`` option for :phpmethod:`MongoDB\\Database::createCollection()`. + ``max`` option for :phpmethod:`MongoDB\Database::createCollection()`. .. code-block:: php @@ -31,7 +31,7 @@ The document limit for the capped collection. If the collection is not capped, ``null`` will be returned. This method is deprecated in favor of using -:phpmethod:`MongoDB\\Model\\CollectionInfo::getOptions()` and accessing the +:phpmethod:`MongoDB\Model\CollectionInfo::getOptions()` and accessing the ``max`` key. Examples @@ -61,9 +61,9 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Model\\CollectionInfo::getCappedSize()` -- :phpmethod:`MongoDB\\Model\\CollectionInfo::isCapped()` -- :phpmethod:`MongoDB\\Database::createCollection()` +- :phpmethod:`MongoDB\Model\CollectionInfo::getCappedSize()` +- :phpmethod:`MongoDB\Model\CollectionInfo::isCapped()` +- :phpmethod:`MongoDB\Database::createCollection()` - :manual:`Capped Collections ` in the MongoDB manual - :manual:`listCollections ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelCollectionInfo-getCappedSize.txt b/docs/reference/method/MongoDBModelCollectionInfo-getCappedSize.txt index 62732aa47..9b0101aaa 100644 --- a/docs/reference/method/MongoDBModelCollectionInfo-getCappedSize.txt +++ b/docs/reference/method/MongoDBModelCollectionInfo-getCappedSize.txt @@ -15,11 +15,11 @@ MongoDB\\Model\\CollectionInfo::getCappedSize() Definition ---------- -.. phpmethod:: MongoDB\\Model\\CollectionInfo::getCappedSize() +.. phpmethod:: MongoDB\Model\CollectionInfo::getCappedSize() Return the size limit for the capped collection in bytes. This correlates with the ``size`` option for - :phpmethod:`MongoDB\\Database::createCollection()`. + :phpmethod:`MongoDB\Database::createCollection()`. .. code-block:: php @@ -32,7 +32,7 @@ The size limit for the capped collection in bytes. If the collection is not capped, ``null`` will be returned. This method is deprecated in favor of using -:phpmethod:`MongoDB\\Model\\CollectionInfo::getOptions()` and accessing the +:phpmethod:`MongoDB\Model\CollectionInfo::getOptions()` and accessing the ``size`` key. Examples @@ -61,9 +61,9 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Model\\CollectionInfo::getCappedMax()` -- :phpmethod:`MongoDB\\Model\\CollectionInfo::isCapped()` -- :phpmethod:`MongoDB\\Database::createCollection()` +- :phpmethod:`MongoDB\Model\CollectionInfo::getCappedMax()` +- :phpmethod:`MongoDB\Model\CollectionInfo::isCapped()` +- :phpmethod:`MongoDB\Database::createCollection()` - :manual:`Capped Collections ` in the MongoDB manual - :manual:`listCollections ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelCollectionInfo-getIdIndex.txt b/docs/reference/method/MongoDBModelCollectionInfo-getIdIndex.txt index 4fa22dc00..73f476684 100644 --- a/docs/reference/method/MongoDBModelCollectionInfo-getIdIndex.txt +++ b/docs/reference/method/MongoDBModelCollectionInfo-getIdIndex.txt @@ -15,7 +15,7 @@ MongoDB\\Model\\CollectionInfo::getIdIndex() Definition ---------- -.. phpmethod:: MongoDB\\Model\\CollectionInfo::getIdIndex() +.. phpmethod:: MongoDB\Model\CollectionInfo::getIdIndex() Returns information about the ``_id`` field index. @@ -70,6 +70,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Database::createCollection()` +- :phpmethod:`MongoDB\Database::createCollection()` - :manual:`listCollections ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelCollectionInfo-getInfo.txt b/docs/reference/method/MongoDBModelCollectionInfo-getInfo.txt index 4d4f19ff3..efdc11825 100644 --- a/docs/reference/method/MongoDBModelCollectionInfo-getInfo.txt +++ b/docs/reference/method/MongoDBModelCollectionInfo-getInfo.txt @@ -15,7 +15,7 @@ MongoDB\\Model\\CollectionInfo::getInfo() Definition ---------- -.. phpmethod:: MongoDB\\Model\\CollectionInfo::getInfo() +.. phpmethod:: MongoDB\Model\CollectionInfo::getInfo() Returns additional information about the collection. @@ -56,6 +56,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Database::createCollection()` +- :phpmethod:`MongoDB\Database::createCollection()` - :manual:`listCollections ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelCollectionInfo-getName.txt b/docs/reference/method/MongoDBModelCollectionInfo-getName.txt index d3104af82..83a74b2bd 100644 --- a/docs/reference/method/MongoDBModelCollectionInfo-getName.txt +++ b/docs/reference/method/MongoDBModelCollectionInfo-getName.txt @@ -13,7 +13,7 @@ MongoDB\\Model\\CollectionInfo::getName() Definition ---------- -.. phpmethod:: MongoDB\\Model\\CollectionInfo::getName() +.. phpmethod:: MongoDB\Model\CollectionInfo::getName() Return the collection name. @@ -47,6 +47,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::getCollectionName()` +- :phpmethod:`MongoDB\Collection::getCollectionName()` - :manual:`listCollections ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelCollectionInfo-getOptions.txt b/docs/reference/method/MongoDBModelCollectionInfo-getOptions.txt index 3ffac1db8..d438b44bf 100644 --- a/docs/reference/method/MongoDBModelCollectionInfo-getOptions.txt +++ b/docs/reference/method/MongoDBModelCollectionInfo-getOptions.txt @@ -13,10 +13,10 @@ MongoDB\\Model\\CollectionInfo::getOptions() Definition ---------- -.. phpmethod:: MongoDB\\Model\\CollectionInfo::getOptions() +.. phpmethod:: MongoDB\Model\CollectionInfo::getOptions() Return the collection options. This correlates with the options for - :phpmethod:`MongoDB\\Database::createCollection()`, but may include + :phpmethod:`MongoDB\Database::createCollection()`, but may include additional fields set by the server. .. code-block:: php @@ -60,6 +60,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Database::createCollection()` +- :phpmethod:`MongoDB\Database::createCollection()` - :manual:`listCollections ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelCollectionInfo-getType.txt b/docs/reference/method/MongoDBModelCollectionInfo-getType.txt index 9fdf5c990..39a6c4425 100644 --- a/docs/reference/method/MongoDBModelCollectionInfo-getType.txt +++ b/docs/reference/method/MongoDBModelCollectionInfo-getType.txt @@ -15,7 +15,7 @@ MongoDB\\Model\\CollectionInfo::getType() Definition ---------- -.. phpmethod:: MongoDB\\Model\\CollectionInfo::getType() +.. phpmethod:: MongoDB\Model\CollectionInfo::getType() Return the collection type. @@ -49,6 +49,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Database::createCollection()` +- :phpmethod:`MongoDB\Database::createCollection()` - :manual:`listCollections ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelCollectionInfo-isCapped.txt b/docs/reference/method/MongoDBModelCollectionInfo-isCapped.txt index a6067e0a5..aa70df80e 100644 --- a/docs/reference/method/MongoDBModelCollectionInfo-isCapped.txt +++ b/docs/reference/method/MongoDBModelCollectionInfo-isCapped.txt @@ -15,7 +15,7 @@ MongoDB\\Model\\CollectionInfo::isCapped() Definition ---------- -.. phpmethod:: MongoDB\\Model\\CollectionInfo::isCapped() +.. phpmethod:: MongoDB\Model\CollectionInfo::isCapped() Return whether the collection is a :manual:`capped collection `. @@ -30,7 +30,7 @@ Return Values A boolean indicating whether the collection is a capped collection. This method is deprecated in favor of using -:phpmethod:`MongoDB\\Model\\CollectionInfo::getOptions()` and accessing the +:phpmethod:`MongoDB\Model\CollectionInfo::getOptions()` and accessing the ``capped`` key. Examples @@ -59,8 +59,8 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Model\\CollectionInfo::getCappedMax()` -- :phpmethod:`MongoDB\\Model\\CollectionInfo::getCappedSize()` +- :phpmethod:`MongoDB\Model\CollectionInfo::getCappedMax()` +- :phpmethod:`MongoDB\Model\CollectionInfo::getCappedSize()` - :manual:`Capped Collections ` in the MongoDB manual - :manual:`listCollections ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelDatabaseInfo-getName.txt b/docs/reference/method/MongoDBModelDatabaseInfo-getName.txt index 6f82a77ab..4ef37321a 100644 --- a/docs/reference/method/MongoDBModelDatabaseInfo-getName.txt +++ b/docs/reference/method/MongoDBModelDatabaseInfo-getName.txt @@ -13,7 +13,7 @@ MongoDB\\Model\\DatabaseInfo::getName() Definition ---------- -.. phpmethod:: MongoDB\\Model\\DatabaseInfo::getName() +.. phpmethod:: MongoDB\Model\DatabaseInfo::getName() Return the database name. @@ -46,6 +46,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Database::getDatabaseName()` +- :phpmethod:`MongoDB\Database::getDatabaseName()` - :manual:`listDatabases ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelDatabaseInfo-getSizeOnDisk.txt b/docs/reference/method/MongoDBModelDatabaseInfo-getSizeOnDisk.txt index 8c3a0b0b4..3af6ef483 100644 --- a/docs/reference/method/MongoDBModelDatabaseInfo-getSizeOnDisk.txt +++ b/docs/reference/method/MongoDBModelDatabaseInfo-getSizeOnDisk.txt @@ -13,7 +13,7 @@ MongoDB\\Model\\DatabaseInfo::getSizeOnDisk() Definition ---------- -.. phpmethod:: MongoDB\\Model\\DatabaseInfo::getSizeOnDisk() +.. phpmethod:: MongoDB\Model\DatabaseInfo::getSizeOnDisk() Return the total size of the database file on disk in bytes. diff --git a/docs/reference/method/MongoDBModelDatabaseInfo-isEmpty.txt b/docs/reference/method/MongoDBModelDatabaseInfo-isEmpty.txt index 1c68299ea..72849b8e5 100644 --- a/docs/reference/method/MongoDBModelDatabaseInfo-isEmpty.txt +++ b/docs/reference/method/MongoDBModelDatabaseInfo-isEmpty.txt @@ -13,7 +13,7 @@ MongoDB\\Model\\DatabaseInfo::isEmpty() Definition ---------- -.. phpmethod:: MongoDB\\Model\\DatabaseInfo::isEmpty() +.. phpmethod:: MongoDB\Model\DatabaseInfo::isEmpty() Return whether the database has any data. diff --git a/docs/reference/method/MongoDBModelIndexInfo-getKey.txt b/docs/reference/method/MongoDBModelIndexInfo-getKey.txt index ff416f919..0925428f3 100644 --- a/docs/reference/method/MongoDBModelIndexInfo-getKey.txt +++ b/docs/reference/method/MongoDBModelIndexInfo-getKey.txt @@ -13,11 +13,11 @@ MongoDB\\Model\\IndexInfo::getKey() Definition ---------- -.. phpmethod:: MongoDB\\Model\\IndexInfo::getKey() +.. phpmethod:: MongoDB\Model\IndexInfo::getKey() Return the index specification (i.e. indexed field(s) and order). This correlates with the ``$key`` parameter for - :phpmethod:`MongoDB\\Collection::createIndex()`. + :phpmethod:`MongoDB\Collection::createIndex()`. .. code-block:: php @@ -53,6 +53,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::createIndex()` - :manual:`listIndexes ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelIndexInfo-getName.txt b/docs/reference/method/MongoDBModelIndexInfo-getName.txt index b37c66216..4404964df 100644 --- a/docs/reference/method/MongoDBModelIndexInfo-getName.txt +++ b/docs/reference/method/MongoDBModelIndexInfo-getName.txt @@ -13,10 +13,10 @@ MongoDB\\Model\\IndexInfo::getName() Definition ---------- -.. phpmethod:: MongoDB\\Model\\IndexInfo::getName() +.. phpmethod:: MongoDB\Model\IndexInfo::getName() Return the index name. This correlates with the return value of - :phpmethod:`MongoDB\\Collection::createIndex()`. An index name may be derived + :phpmethod:`MongoDB\Collection::createIndex()`. An index name may be derived from the ``$key`` parameter or explicitly specified via the ``name`` option. .. code-block:: php @@ -50,6 +50,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::createIndex()` - :manual:`listIndexes ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelIndexInfo-getNamespace.txt b/docs/reference/method/MongoDBModelIndexInfo-getNamespace.txt index f4bb7a596..099a18306 100644 --- a/docs/reference/method/MongoDBModelIndexInfo-getNamespace.txt +++ b/docs/reference/method/MongoDBModelIndexInfo-getNamespace.txt @@ -13,7 +13,7 @@ MongoDB\\Model\\IndexInfo::getNamespace() Definition ---------- -.. phpmethod:: MongoDB\\Model\\IndexInfo::getNamespace() +.. phpmethod:: MongoDB\Model\IndexInfo::getNamespace() Return the index namespace, which is the namespace of the collection containing the index. @@ -49,7 +49,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndex()` -- :phpmethod:`MongoDB\\Collection::getNamespace()` +- :phpmethod:`MongoDB\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::getNamespace()` - :manual:`listIndexes ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelIndexInfo-getVersion.txt b/docs/reference/method/MongoDBModelIndexInfo-getVersion.txt index 96a227706..cd0d1bb4e 100644 --- a/docs/reference/method/MongoDBModelIndexInfo-getVersion.txt +++ b/docs/reference/method/MongoDBModelIndexInfo-getVersion.txt @@ -13,7 +13,7 @@ MongoDB\\Model\\IndexInfo::getVersion() Definition ---------- -.. phpmethod:: MongoDB\\Model\\IndexInfo::getVersion() +.. phpmethod:: MongoDB\Model\IndexInfo::getVersion() Return the index version. @@ -48,6 +48,6 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::createIndex()` - :manual:`listIndexes ` command reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelIndexInfo-is2dSphere.txt b/docs/reference/method/MongoDBModelIndexInfo-is2dSphere.txt index 017e6e7bd..27fd3f9a3 100644 --- a/docs/reference/method/MongoDBModelIndexInfo-is2dSphere.txt +++ b/docs/reference/method/MongoDBModelIndexInfo-is2dSphere.txt @@ -15,7 +15,7 @@ MongoDB\\Model\\IndexInfo::is2dSphere() Definition ---------- -.. phpmethod:: MongoDB\\Model\\IndexInfo::is2dSphere() +.. phpmethod:: MongoDB\Model\IndexInfo::is2dSphere() Return whether the index is a :manual:`2dsphere ` index. @@ -55,7 +55,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndex()` -- :phpmethod:`MongoDB\\Collection::listIndexes()` +- :phpmethod:`MongoDB\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::listIndexes()` - :manual:`2dsphere Indexes ` reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelIndexInfo-isGeoHaystack.txt b/docs/reference/method/MongoDBModelIndexInfo-isGeoHaystack.txt index f6c2007df..87b7a53d7 100644 --- a/docs/reference/method/MongoDBModelIndexInfo-isGeoHaystack.txt +++ b/docs/reference/method/MongoDBModelIndexInfo-isGeoHaystack.txt @@ -18,7 +18,7 @@ MongoDB\\Model\\IndexInfo::isGeoHaystack() Definition ---------- -.. phpmethod:: MongoDB\\Model\\IndexInfo::isGeoHaystack() +.. phpmethod:: MongoDB\Model\IndexInfo::isGeoHaystack() Return whether the index is a :manual:`geoHaystack ` index. @@ -58,7 +58,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndex()` -- :phpmethod:`MongoDB\\Collection::listIndexes()` +- :phpmethod:`MongoDB\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::listIndexes()` - :manual:`geoHaystack Indexes ` reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelIndexInfo-isSparse.txt b/docs/reference/method/MongoDBModelIndexInfo-isSparse.txt index 533793c9e..22c307ab6 100644 --- a/docs/reference/method/MongoDBModelIndexInfo-isSparse.txt +++ b/docs/reference/method/MongoDBModelIndexInfo-isSparse.txt @@ -13,11 +13,11 @@ MongoDB\\Model\\IndexInfo::isSparse() Definition ---------- -.. phpmethod:: MongoDB\\Model\\IndexInfo::isSparse() +.. phpmethod:: MongoDB\Model\IndexInfo::isSparse() Return whether the index is a :manual:`sparse index `. This correlates with the ``sparse`` option for - :phpmethod:`MongoDB\\Collection::createIndex()`. + :phpmethod:`MongoDB\Collection::createIndex()`. .. code-block:: php @@ -50,7 +50,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::createIndex()` - :manual:`listIndexes ` command reference in the MongoDB manual - :manual:`Sparse Indexes ` in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelIndexInfo-isText.txt b/docs/reference/method/MongoDBModelIndexInfo-isText.txt index 7e0488f5b..b600ebdd9 100644 --- a/docs/reference/method/MongoDBModelIndexInfo-isText.txt +++ b/docs/reference/method/MongoDBModelIndexInfo-isText.txt @@ -15,7 +15,7 @@ MongoDB\\Model\\IndexInfo::isText() Definition ---------- -.. phpmethod:: MongoDB\\Model\\IndexInfo::isText() +.. phpmethod:: MongoDB\Model\IndexInfo::isText() Return whether the index is a :manual:`text ` index. @@ -54,7 +54,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndex()` -- :phpmethod:`MongoDB\\Collection::listIndexes()` +- :phpmethod:`MongoDB\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::listIndexes()` - :manual:`Text Indexes ` reference in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelIndexInfo-isTtl.txt b/docs/reference/method/MongoDBModelIndexInfo-isTtl.txt index a33a22b96..ef4179422 100644 --- a/docs/reference/method/MongoDBModelIndexInfo-isTtl.txt +++ b/docs/reference/method/MongoDBModelIndexInfo-isTtl.txt @@ -13,11 +13,11 @@ MongoDB\\Model\\IndexInfo::isTtl() Definition ---------- -.. phpmethod:: MongoDB\\Model\\IndexInfo::isTtl() +.. phpmethod:: MongoDB\Model\IndexInfo::isTtl() Return whether the index is a :manual:`TTL index `. This correlates with the ``expireAfterSeconds`` option for - :phpmethod:`MongoDB\\Collection::createIndex()`. + :phpmethod:`MongoDB\Collection::createIndex()`. .. code-block:: php @@ -50,7 +50,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::createIndex()` - :manual:`listIndexes ` command reference in the MongoDB manual - :manual:`TTL Indexes ` in the MongoDB manual diff --git a/docs/reference/method/MongoDBModelIndexInfo-isUnique.txt b/docs/reference/method/MongoDBModelIndexInfo-isUnique.txt index ef61e7c3a..12d8b45cd 100644 --- a/docs/reference/method/MongoDBModelIndexInfo-isUnique.txt +++ b/docs/reference/method/MongoDBModelIndexInfo-isUnique.txt @@ -13,11 +13,11 @@ MongoDB\\Model\\IndexInfo::isUnique() Definition ---------- -.. phpmethod:: MongoDB\\Model\\IndexInfo::isUnique() +.. phpmethod:: MongoDB\Model\IndexInfo::isUnique() Return whether the index is a :manual:`unique index `. This correlates with the ``unique`` option for - :phpmethod:`MongoDB\\Collection::createIndex()`. + :phpmethod:`MongoDB\Collection::createIndex()`. .. code-block:: php @@ -50,7 +50,7 @@ The output would then resemble: See Also -------- -- :phpmethod:`MongoDB\\Collection::createIndex()` +- :phpmethod:`MongoDB\Collection::createIndex()` - :manual:`listIndexes ` command reference in the MongoDB manual - :manual:`Unique Indexes ` in the MongoDB manual diff --git a/docs/reference/method/MongoDBUpdateResult-getMatchedCount.txt b/docs/reference/method/MongoDBUpdateResult-getMatchedCount.txt index f347a8cf0..077cddd89 100644 --- a/docs/reference/method/MongoDBUpdateResult-getMatchedCount.txt +++ b/docs/reference/method/MongoDBUpdateResult-getMatchedCount.txt @@ -13,7 +13,7 @@ MongoDB\\UpdateResult::getMatchedCount() Definition ---------- -.. phpmethod:: MongoDB\\UpdateResult::getMatchedCount() +.. phpmethod:: MongoDB\UpdateResult::getMatchedCount() Return the number of documents that were matched. @@ -44,6 +44,6 @@ Errors/Exceptions See Also -------- -- :phpmethod:`MongoDB\\UpdateResult::getModifiedCount()` -- :php:`MongoDB\\Driver\\WriteResult::getMatchedCount() +- :phpmethod:`MongoDB\UpdateResult::getModifiedCount()` +- :php:`MongoDB\Driver\WriteResult::getMatchedCount() ` diff --git a/docs/reference/method/MongoDBUpdateResult-getModifiedCount.txt b/docs/reference/method/MongoDBUpdateResult-getModifiedCount.txt index 3e2a7a6ed..5c8bfe73d 100644 --- a/docs/reference/method/MongoDBUpdateResult-getModifiedCount.txt +++ b/docs/reference/method/MongoDBUpdateResult-getModifiedCount.txt @@ -13,7 +13,7 @@ MongoDB\\UpdateResult::getModifiedCount() Definition ---------- -.. phpmethod:: MongoDB\\UpdateResult::getModifiedCount() +.. phpmethod:: MongoDB\UpdateResult::getModifiedCount() Return the number of documents that were modified. @@ -28,7 +28,7 @@ Definition If an update/replace operation results in no change to the document (e.g. setting the value of a field to its current value), the modified count may be less than the value returned by :phpmethod:`getMatchedCount() - `. + `. Return Values ------------- @@ -43,6 +43,6 @@ Errors/Exceptions See Also -------- -- :phpmethod:`MongoDB\\UpdateResult::getMatchedCount()` -- :php:`MongoDB\\Driver\\WriteResult::getModifiedCount() +- :phpmethod:`MongoDB\UpdateResult::getMatchedCount()` +- :php:`MongoDB\Driver\WriteResult::getModifiedCount() ` diff --git a/docs/reference/method/MongoDBUpdateResult-getUpsertedCount.txt b/docs/reference/method/MongoDBUpdateResult-getUpsertedCount.txt index 0bbb39fbc..7074696eb 100644 --- a/docs/reference/method/MongoDBUpdateResult-getUpsertedCount.txt +++ b/docs/reference/method/MongoDBUpdateResult-getUpsertedCount.txt @@ -13,7 +13,7 @@ MongoDB\\UpdateResult::getUpsertedCount() Definition ---------- -.. phpmethod:: MongoDB\\UpdateResult::getUpsertedCount() +.. phpmethod:: MongoDB\UpdateResult::getUpsertedCount() Return the number of documents that were upserted. @@ -38,5 +38,5 @@ Errors/Exceptions See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::getUpsertedCount() +- :php:`MongoDB\Driver\WriteResult::getUpsertedCount() ` diff --git a/docs/reference/method/MongoDBUpdateResult-getUpsertedId.txt b/docs/reference/method/MongoDBUpdateResult-getUpsertedId.txt index 52498708d..d92007787 100644 --- a/docs/reference/method/MongoDBUpdateResult-getUpsertedId.txt +++ b/docs/reference/method/MongoDBUpdateResult-getUpsertedId.txt @@ -13,7 +13,7 @@ MongoDB\\UpdateResult::getUpsertedId() Definition ---------- -.. phpmethod:: MongoDB\\UpdateResult::getUpsertedId() +.. phpmethod:: MongoDB\UpdateResult::getUpsertedId() Return the ID (i.e. ``_id`` field value) of the upserted document. @@ -29,7 +29,7 @@ upserted, ``null`` will be returned. If the document had an ID prior to upserting (i.e. the server did not need to generate an ID), this will contain its ``_id`` field value. Any server-generated -ID will be a :php:`MongoDB\\BSON\\ObjectId ` +ID will be a :php:`MongoDB\BSON\ObjectId ` instance. Errors/Exceptions @@ -40,5 +40,5 @@ Errors/Exceptions See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::getUpsertedIds() +- :php:`MongoDB\Driver\WriteResult::getUpsertedIds() ` diff --git a/docs/reference/method/MongoDBUpdateResult-isAcknowledged.txt b/docs/reference/method/MongoDBUpdateResult-isAcknowledged.txt index af15d1f11..2e7c7b057 100644 --- a/docs/reference/method/MongoDBUpdateResult-isAcknowledged.txt +++ b/docs/reference/method/MongoDBUpdateResult-isAcknowledged.txt @@ -13,7 +13,7 @@ MongoDB\\UpdateResult::isAcknowledged() Definition ---------- -.. phpmethod:: MongoDB\\UpdateResult::isAcknowledged() +.. phpmethod:: MongoDB\UpdateResult::isAcknowledged() Return whether the write was acknowledged. @@ -29,6 +29,6 @@ A boolean indicating whether the write was acknowledged. See Also -------- -- :php:`MongoDB\\Driver\\WriteResult::isAcknowledged() +- :php:`MongoDB\Driver\WriteResult::isAcknowledged() ` - :manual:`Write Concern ` in the MongoDB manual diff --git a/docs/tutorial/client-side-encryption.txt b/docs/tutorial/client-side-encryption.txt index efff2e7d4..2b5aca6ce 100644 --- a/docs/tutorial/client-side-encryption.txt +++ b/docs/tutorial/client-side-encryption.txt @@ -23,7 +23,7 @@ Creating an Encryption Key such as AWS KMS are also an option. This master key is used to encrypt data keys that are stored locally. It is important that you keep this key secure. -To create an encryption key, create a :php:`MongoDB\\Driver\\ClientEncryption ` +To create an encryption key, create a :php:`MongoDB\Driver\ClientEncryption ` instance with encryption options and create a new data key. The method will return the key ID which can be used to reference the key later. You can also pass multiple alternate names for this key and reference the key by these names diff --git a/docs/tutorial/collation.txt b/docs/tutorial/collation.txt index 28225db01..172b934a2 100644 --- a/docs/tutorial/collation.txt +++ b/docs/tutorial/collation.txt @@ -196,7 +196,7 @@ A collection called ``names`` contains the following documents: { "_id" : 4, "first_name" : "Jürgen" } The following :phpmethod:`findOneAndUpdate() -` operation on the collection does not +` operation on the collection does not specify a collation. .. code-block:: php @@ -214,7 +214,7 @@ Because ``Gunter`` is lexically first in the collection, the above operation returns no results and updates no documents. Consider the same :phpmethod:`findOneAndUpdate() -` operation but with a collation +` operation but with a collation specified, which uses the locale ``de@collation=phonebook``. .. note:: @@ -349,7 +349,7 @@ Aggregation ~~~~~~~~~~~ To use collation with an :phpmethod:`aggregate() -` operation, specify a collation in the +` operation, specify a collation in the aggregation options. The following aggregation example uses a collection called ``names`` and groups diff --git a/docs/tutorial/commands.txt b/docs/tutorial/commands.txt index bccf74626..3efa999e5 100644 --- a/docs/tutorial/commands.txt +++ b/docs/tutorial/commands.txt @@ -14,14 +14,14 @@ Overview -------- The |php-library| provides helper methods across the :phpclass:`Client -`, :phpclass:`Database `, and -:phpclass:`Collection ` classes for common +`, :phpclass:`Database `, and +:phpclass:`Collection ` classes for common :manual:`database commands `. In addition, the -:phpmethod:`MongoDB\\Database::command()` method may be used to run database +:phpmethod:`MongoDB\Database::command()` method may be used to run database commands that do not have a helper method. -The :phpmethod:`MongoDB\\Database::command()` method always returns a -:php:`MongoDB\\Driver\\Cursor ` object, since it must +The :phpmethod:`MongoDB\Database::command()` method always returns a +:php:`MongoDB\Driver\Cursor ` object, since it must support execution of commands that return single result documents *and* multiple results via a command cursor. @@ -63,7 +63,7 @@ example executes :manual:`listCollections `, which returns a cursor containing a result document for each collection in the ``test`` database, and iterates through the results using a ``foreach`` loop. Note that this example is illustrative; applications would generally use -:phpmethod:`MongoDB\\Database::listCollections()` in practice. +:phpmethod:`MongoDB\Database::listCollections()` in practice. .. code-block:: php @@ -103,8 +103,8 @@ Specifying a Custom Read Preference Write commands, such as :manual:`createUser `, can only be executed on a writable server (e.g. :term:`primary` replica set member). Command helper methods in the |php-library|, such as -:phpmethod:`MongoDB\\Database::drop()`, know to apply their own :term:`read -preference` if necessary. However, the :phpmethod:`MongoDB\\Database::command()` +:phpmethod:`MongoDB\Database::drop()`, know to apply their own :term:`read +preference` if necessary. However, the :phpmethod:`MongoDB\Database::command()` method is a generic method and defaults to the read preference of the Database object on which it is invoked. When necessary, the ``readPreference`` option may be used to override the default read preference. diff --git a/docs/tutorial/connecting.txt b/docs/tutorial/connecting.txt index c964362a0..cffd19eff 100644 --- a/docs/tutorial/connecting.txt +++ b/docs/tutorial/connecting.txt @@ -22,4 +22,4 @@ Specifying connection options Connection options can be passed via the ``$uri`` parameter, or through the ``$options`` and ``$driverOptions`` parameters. The available options are -documented in the :phpmethod:`MongoDB\\Client::__construct()` reference. +documented in the :phpmethod:`MongoDB\Client::__construct()` reference. diff --git a/docs/tutorial/crud.txt b/docs/tutorial/crud.txt index 3abbf5792..a69ec6624 100644 --- a/docs/tutorial/crud.txt +++ b/docs/tutorial/crud.txt @@ -12,7 +12,7 @@ CRUD Operations CRUD operations *create*, *read*, *update*, and *delete* documents. The -|php-library|'s :phpclass:`MongoDB\\Collection` class implements MongoDB's +|php-library|'s :phpclass:`MongoDB\Collection` class implements MongoDB's cross-driver `CRUD specification `_, providing access to methods for inserting, finding, updating, and deleting @@ -29,9 +29,9 @@ Insert Documents Insert One Document ~~~~~~~~~~~~~~~~~~~ -The :phpmethod:`MongoDB\\Collection::insertOne()` method inserts a single +The :phpmethod:`MongoDB\Collection::insertOne()` method inserts a single document into MongoDB and returns an instance of -:phpclass:`MongoDB\\InsertOneResult`, which you can use to access the ID of the +:phpclass:`MongoDB\InsertOneResult`, which you can use to access the ID of the inserted document. .. this uses the insertOne example from the method reference: @@ -70,14 +70,14 @@ The output would then resemble: .. seealso:: - :phpmethod:`MongoDB\\Collection::insertOne()` + :phpmethod:`MongoDB\Collection::insertOne()` Insert Many Documents ~~~~~~~~~~~~~~~~~~~~~ -The :phpmethod:`MongoDB\\Collection::insertMany()` method allows you to insert +The :phpmethod:`MongoDB\Collection::insertMany()` method allows you to insert multiple documents in one write operation and returns an instance of -:phpclass:`MongoDB\\InsertManyResult`, which you can use to access the IDs of +:phpclass:`MongoDB\InsertManyResult`, which you can use to access the IDs of the inserted documents. .. this uses the insertMany example from the method reference: @@ -88,14 +88,14 @@ the inserted documents. .. seealso:: - :phpmethod:`MongoDB\\Collection::insertMany()` + :phpmethod:`MongoDB\Collection::insertMany()` Query Documents --------------- -The |php-library| provides the :phpmethod:`MongoDB\\Collection::findOne()` and -:phpmethod:`MongoDB\\Collection::find()` methods for querying documents and the -:phpmethod:`MongoDB\\Collection::aggregate()` method for performing +The |php-library| provides the :phpmethod:`MongoDB\Collection::findOne()` and +:phpmethod:`MongoDB\Collection::find()` methods for querying documents and the +:phpmethod:`MongoDB\Collection::aggregate()` method for performing :manual:`aggregation operations `. .. include:: /includes/extracts/note-bson-comparison.rst @@ -103,7 +103,7 @@ The |php-library| provides the :phpmethod:`MongoDB\\Collection::findOne()` and Find One Document ~~~~~~~~~~~~~~~~~ -:phpmethod:`MongoDB\\Collection::findOne()` returns the :term:`first document +:phpmethod:`MongoDB\Collection::findOne()` returns the :term:`first document ` that matches the query or ``null`` if no document matches the query. @@ -153,21 +153,21 @@ The output would then resemble: ``"94301"``. The same criteria would not have matched a document with an integer value of ``94301`` due to MongoDB's :manual:`comparison rules for BSON types `. Similarly, users should - use a :php:`MongoDB\\BSON\\ObjectId ` object + use a :php:`MongoDB\BSON\ObjectId ` object when matching an ``_id`` with an :manual:`ObjectId ` value, as strings and ObjectIds are not directly comparable. .. seealso:: - :phpmethod:`MongoDB\\Collection::findOne()` + :phpmethod:`MongoDB\Collection::findOne()` .. _php-find-many-documents: Find Many Documents ~~~~~~~~~~~~~~~~~~~ -:phpmethod:`MongoDB\\Collection::find()` returns a -:php:`MongoDB\\Driver\\Cursor ` object, which you can +:phpmethod:`MongoDB\Collection::find()` returns a +:php:`MongoDB\Driver\Cursor ` object, which you can iterate upon to access all matched documents. The following example lists the documents in the ``zips`` collection with the @@ -198,7 +198,7 @@ The output would resemble: .. seealso:: - :phpmethod:`MongoDB\\Collection::find()` + :phpmethod:`MongoDB\Collection::find()` .. _php-query-projection: @@ -355,7 +355,7 @@ Regular Expressions ~~~~~~~~~~~~~~~~~~~ Filter criteria may include regular expressions, either by using the -:php:`MongoDB\\BSON\\Regex ` class directory or the +:php:`MongoDB\BSON\Regex ` class directory or the :query:`$regex` operator. The following example lists documents in the ``zips`` collection where the city @@ -421,10 +421,10 @@ Complex Queries with Aggregation MongoDB's :manual:`Aggregation Framework ` allows you to issue complex queries that filter, transform, and group collection data. -The |php-library|\'s :phpmethod:`MongoDB\\Collection::aggregate()` method +The |php-library|\'s :phpmethod:`MongoDB\Collection::aggregate()` method returns a :php:`Traversable ` object, which you can iterate upon to access the results of the aggregation operation. Refer to the -:phpmethod:`MongoDB\\Collection::aggregate()` method's :ref:`behavior +:phpmethod:`MongoDB\Collection::aggregate()` method's :ref:`behavior reference ` for more about the method's output. The following example lists the 5 US states with the most zip codes associated @@ -458,7 +458,7 @@ The output would then resemble: .. seealso:: - :phpmethod:`MongoDB\\Collection::aggregate()` + :phpmethod:`MongoDB\Collection::aggregate()` Update Documents ---------------- @@ -466,18 +466,18 @@ Update Documents Update One Document ~~~~~~~~~~~~~~~~~~~ -Use the :phpmethod:`MongoDB\\Collection::updateOne()` method to update a single -document matching a filter. :phpmethod:`MongoDB\\Collection::updateOne()` -returns a :phpclass:`MongoDB\\UpdateResult` object, which you can use to access +Use the :phpmethod:`MongoDB\Collection::updateOne()` method to update a single +document matching a filter. :phpmethod:`MongoDB\Collection::updateOne()` +returns a :phpclass:`MongoDB\UpdateResult` object, which you can use to access statistics about the update operation. Update methods have two required parameters: the query filter that identifies the document or documents to update, and an update document that specifies what -updates to perform. The :phpmethod:`MongoDB\\Collection::updateOne()` reference +updates to perform. The :phpmethod:`MongoDB\Collection::updateOne()` reference describes each parameter in detail. The following example inserts two documents into an empty ``users`` collection -in the ``test`` database using the :phpmethod:`MongoDB\\Collection::insertOne()` +in the ``test`` database using the :phpmethod:`MongoDB\Collection::insertOne()` method, and then updates the documents where the value for the ``state`` field is ``"ny"`` to include a ``country`` field set to ``"us"``: @@ -499,7 +499,7 @@ is ``"ny"`` to include a ``country`` field set to ``"us"``: printf("Modified %d document(s)\n", $updateResult->getModifiedCount()); Since the update operation uses the -:phpmethod:`MongoDB\\Collection::updateOne()` method, which updates the first +:phpmethod:`MongoDB\Collection::updateOne()` method, which updates the first document to match the filter criteria, the results would then resemble: .. code-block:: none @@ -537,19 +537,19 @@ therefore not be equal, and the output from the operation would resemble: .. seealso:: - - :phpmethod:`MongoDB\\Collection::updateOne()` - - :phpmethod:`MongoDB\\Collection::findOneAndUpdate()` + - :phpmethod:`MongoDB\Collection::updateOne()` + - :phpmethod:`MongoDB\Collection::findOneAndUpdate()` Update Many Documents ~~~~~~~~~~~~~~~~~~~~~ -:phpmethod:`MongoDB\\Collection::updateMany()` updates one or more documents -matching the filter criteria and returns a :phpclass:`MongoDB\\UpdateResult` +:phpmethod:`MongoDB\Collection::updateMany()` updates one or more documents +matching the filter criteria and returns a :phpclass:`MongoDB\UpdateResult` object, which you can use to access statistics about the update operation. Update methods have two required parameters: the query filter that identifies the document or documents to update, and an update document that specifies what -updates to perform. The :phpmethod:`MongoDB\\Collection::updateMany()` reference +updates to perform. The :phpmethod:`MongoDB\Collection::updateMany()` reference describes each parameter in detail. The following example inserts three documents into an empty ``users`` collection @@ -588,7 +588,7 @@ operation therefore resembles: .. seealso:: - :phpmethod:`MongoDB\\Collection::updateMany()` + :phpmethod:`MongoDB\Collection::updateMany()` Replace Documents ~~~~~~~~~~~~~~~~~ @@ -598,23 +598,23 @@ a document to include new fields or new field values, a replacement operation replaces the entire document with a new document, but retains the original document's ``_id`` value. -The :phpmethod:`MongoDB\\Collection::replaceOne()` method replaces a single +The :phpmethod:`MongoDB\Collection::replaceOne()` method replaces a single document that matches the filter criteria and returns an instance of -:phpclass:`MongoDB\\UpdateResult`, which you can use to access statistics about +:phpclass:`MongoDB\UpdateResult`, which you can use to access statistics about the replacement operation. -:phpmethod:`MongoDB\\Collection::replaceOne()` has two required parameters: the +:phpmethod:`MongoDB\Collection::replaceOne()` has two required parameters: the query filter that identifies the document or documents to replace, and a replacement document that will replace the original document in MongoDB. The -:phpmethod:`MongoDB\\Collection::replaceOne()` reference describes each +:phpmethod:`MongoDB\Collection::replaceOne()` reference describes each parameter in detail. .. important:: Replacement operations replace all of the fields in a document except the ``_id`` value. To avoid accidentally overwriting or deleting desired fields, - use the :phpmethod:`MongoDB\\Collection::updateOne()` or - :phpmethod:`MongoDB\\Collection::updateMany()` methods to update individual + use the :phpmethod:`MongoDB\Collection::updateOne()` or + :phpmethod:`MongoDB\Collection::updateMany()` methods to update individual fields in a document rather than replacing the entire document. The following example inserts one document into an empty ``users`` collection in @@ -645,8 +645,8 @@ The output would then resemble: .. seealso:: - - :phpmethod:`MongoDB\\Collection::replaceOne()` - - :phpmethod:`MongoDB\\Collection::findOneAndReplace()` + - :phpmethod:`MongoDB\Collection::replaceOne()` + - :phpmethod:`MongoDB\Collection::findOneAndReplace()` Upsert ~~~~~~ @@ -658,9 +658,9 @@ document and inserts it. If there *are* matching documents, then the operation modifies or replaces the matching document or documents. When a document is upserted, the ID is accessible via -:phpmethod:`MongoDB\\UpdateResult::getUpsertedId()`. +:phpmethod:`MongoDB\UpdateResult::getUpsertedId()`. -The following example uses :phpmethod:`MongoDB\\Collection::updateOne()` with +The following example uses :phpmethod:`MongoDB\Collection::updateOne()` with the ``upsert`` option set to ``true`` and an empty ``users`` collection in the ``test`` database, therefore inserting the document into the database: @@ -715,18 +715,18 @@ Delete Documents Delete One Document ~~~~~~~~~~~~~~~~~~~ -The :phpmethod:`MongoDB\\Collection::deleteOne()` method deletes a single +The :phpmethod:`MongoDB\Collection::deleteOne()` method deletes a single document that matches the filter criteria and returns a -:phpclass:`MongoDB\\DeleteResult`, which you can use to access statistics about +:phpclass:`MongoDB\DeleteResult`, which you can use to access statistics about the delete operation. If multiple documents match the filter criteria, -:phpmethod:`MongoDB\\Collection::deleteOne()` deletes the :term:`first +:phpmethod:`MongoDB\Collection::deleteOne()` deletes the :term:`first ` matching document. -:phpmethod:`MongoDB\\Collection::deleteOne()` has one required parameter: a +:phpmethod:`MongoDB\Collection::deleteOne()` has one required parameter: a query filter that specifies the document to delete. Refer to the -:phpmethod:`MongoDB\\Collection::deleteOne()` reference for full method +:phpmethod:`MongoDB\Collection::deleteOne()` reference for full method documentation. The following operation deletes the first document where the ``state`` field's @@ -753,18 +753,18 @@ The output would then resemble: .. seealso:: - :phpmethod:`MongoDB\\Collection::deleteOne()` + :phpmethod:`MongoDB\Collection::deleteOne()` Delete Many Documents ~~~~~~~~~~~~~~~~~~~~~ -:phpmethod:`MongoDB\\Collection::deleteMany()` deletes all of the documents that -match the filter criteria and returns a :phpclass:`MongoDB\\DeleteResult`, which +:phpmethod:`MongoDB\Collection::deleteMany()` deletes all of the documents that +match the filter criteria and returns a :phpclass:`MongoDB\DeleteResult`, which you can use to access statistics about the delete operation. -:phpmethod:`MongoDB\\Collection::deleteMany()` has one required parameter: a +:phpmethod:`MongoDB\Collection::deleteMany()` has one required parameter: a query filter that specifies the document to delete. Refer to the -:phpmethod:`MongoDB\\Collection::deleteMany()` reference for full method +:phpmethod:`MongoDB\Collection::deleteMany()` reference for full method documentation. The following operation deletes all of the documents where the ``state`` field's @@ -791,4 +791,4 @@ The output would then resemble: .. seealso:: - :phpmethod:`MongoDB\\Collection::deleteMany()` + :phpmethod:`MongoDB\Collection::deleteMany()` diff --git a/docs/tutorial/custom-types.txt b/docs/tutorial/custom-types.txt index 5fa5880f3..87cb3e08b 100644 --- a/docs/tutorial/custom-types.txt +++ b/docs/tutorial/custom-types.txt @@ -15,7 +15,7 @@ communicates to the server, and deserializes BSON back into PHP variables when it receives data from the server. It is possible to influence the behavior by implementing the -:php:`MongoDB\\BSON\\Persistable ` interface. +:php:`MongoDB\BSON\Persistable ` interface. If a class implements this interface, then upon serialization the :php:`bsonSerialize ` method is called. This method is responsible for returning an array or stdClass object @@ -23,7 +23,7 @@ to convert to BSON and store in the database. That data will later be used to reconstruct the object upon reading from the database. As an example we present the ``LocalDateTime`` class. This class wraps around -the :php:`MongoDB\\BSON\\UTCDateTime ` data +the :php:`MongoDB\BSON\UTCDateTime ` data type and a time zone. .. code-block:: php @@ -45,7 +45,7 @@ type and a time zone. } ?> -As it implements the :php:`MongoDB\\BSON\\Persistable +As it implements the :php:`MongoDB\BSON\Persistable ` interface, the class is required to implement the :php:`bsonSerialize ` and :php:`bsonUnserialize @@ -53,7 +53,7 @@ class is required to implement the :php:`bsonSerialize :php:`bsonSerialize ` method, we return an array with the two values that we need to persist: the point in time in milliseconds since the Epoch, represented by a -:php:`MongoDB\\BSON\\UTCDateTime ` object, and +:php:`MongoDB\BSON\UTCDateTime ` object, and a string containing the Olson time zone identifier: .. code-block:: php @@ -75,7 +75,7 @@ stored object. When the document is read from the database, the driver detects whether a ``__pclass`` field is present and then executes -:php:`MongoDB\\BSON\\Persistable::bsonUnserialize +:php:`MongoDB\BSON\Persistable::bsonUnserialize ` method which is responsible for restoring the object's original state. @@ -102,25 +102,25 @@ properties. ?> You may have noticed that the class also implements the -:php:`MongoDB\\BSON\\UTCDateTimeInterface +:php:`MongoDB\BSON\UTCDateTimeInterface ` interface. This interface defines -the two non-constructor methods of the :php:`MongoDB\\BSON\\UTCDateTime +the two non-constructor methods of the :php:`MongoDB\BSON\UTCDateTime ` class. It is recommended that wrappers around existing BSON classes implement their -respective interface (i.e. :php:`MongoDB\\BSON\\UTCDateTimeInterface +respective interface (i.e. :php:`MongoDB\BSON\UTCDateTimeInterface `) so that the wrapper objects can be used in the same context as their original unwrapped version. It is also recommended that you always type-hint against the interface (i.e. -:php:`MongoDB\\BSON\\UTCDateTimeInterface +:php:`MongoDB\BSON\UTCDateTimeInterface `) and never against the concrete -class (i.e. :php:`MongoDB\\BSON\\UTCDateTime +class (i.e. :php:`MongoDB\BSON\UTCDateTime `), as this would prevent wrapped objects from being accepted into methods. In our new ``toDateTime`` method we return a :php:`DateTime ` object with the local time zone set, instead of the UTC time zone that -:php:`MongoDB\\BSON\\UTCDateTime ` normally uses +:php:`MongoDB\BSON\UTCDateTime ` normally uses in its return value. .. code-block:: php diff --git a/docs/tutorial/gridfs.txt b/docs/tutorial/gridfs.txt index 4eb7e1566..4688aefb3 100644 --- a/docs/tutorial/gridfs.txt +++ b/docs/tutorial/gridfs.txt @@ -13,7 +13,7 @@ GridFS :manual:`GridFS ` is a specification for storing and retrieving files in MongoDB. GridFS uses two collections to store files. One collection stores the file chunks (e.g. ``fs.chunks``), and the other stores file metadata -(e.g. ``fs.files``). The :phpclass:`MongoDB\\GridFS\\Bucket` class provides an +(e.g. ``fs.files``). The :phpclass:`MongoDB\GridFS\Bucket` class provides an interface around these collections for working with the files as PHP :php:`Streams `. @@ -21,9 +21,9 @@ Creating a GridFS Bucket ------------------------ You can construct a GridFS bucket using the PHP extension's -:php:`MongoDB\\Driver\\Manager ` class, or select -a bucket from the |php-library|'s :phpclass:`MongoDB\\Database` class via the -:phpmethod:`selectGridFSBucket() ` +:php:`MongoDB\Driver\Manager ` class, or select +a bucket from the |php-library|'s :phpclass:`MongoDB\Database` class via the +:phpmethod:`selectGridFSBucket() ` method. The bucket can be constructed with various options: @@ -35,7 +35,7 @@ The bucket can be constructed with various options: needed. The default size is ``261120`` (i.e. 255 KiB). - ``readConcern``, ``readPreference`` and ``writeConcern`` options can be used to specify defaults for read and write operations, much like the - :phpclass:`MongoDB\\GridFS\\Collection` options. + :phpclass:`MongoDB\GridFS\Collection` options. Uploading Files with Writable Streams ------------------------------------- @@ -112,9 +112,9 @@ number. Revision numbers are used to distinguish between files sharing the same ``filename`` metadata field, ordered by date of upload (i.e. the ``uploadDate`` metadata field). The ``revision`` option accepted by :phpmethod:`openDownloadStreamByName() -` and +` and :phpmethod:`downloadToStreamByName() -` can be positive or negative. +` can be positive or negative. A positive ``revision`` number may be used to select files in order of the oldest upload date. A revision of ``0`` would denote the file with the oldest @@ -157,7 +157,7 @@ You can delete a GridFS file by its ``_id``. Finding File Metadata --------------------- -The :phpmethod:`find() ` method allows you to +The :phpmethod:`find() ` method allows you to retrieve documents from the GridFS files collection, which contain metadata about the GridFS files. @@ -173,7 +173,7 @@ Accessing File Metadata for an Existing Stream ---------------------------------------------- The :phpmethod:`getFileDocumentForStream() -` method may be used to get +` method may be used to get the file document for an existing readable or writable GridFS stream. .. code-block:: php @@ -193,16 +193,16 @@ the file document for an existing readable or writable GridFS stream. Since the file document for a writable stream is not committed to MongoDB until the stream is closed, :phpmethod:`getFileDocumentForStream() - ` can only return an + ` can only return an in-memory document, which will be missing some fields (e.g. ``length``, ``md5``). The :phpmethod:`getFileIdForStream() -` method may be used to get the +` method may be used to get the ``_id`` for an existing readable or writable GridFS stream. This is a convenience for accessing the ``_id`` property of the object returned by :phpmethod:`getFileDocumentForStream() -`. +`. .. code-block:: php diff --git a/docs/tutorial/indexes.txt b/docs/tutorial/indexes.txt index e04d43653..51d2d3f70 100644 --- a/docs/tutorial/indexes.txt +++ b/docs/tutorial/indexes.txt @@ -11,7 +11,7 @@ appropriate index exists for a query, MongoDB can use the index to limit the number of documents it must inspect. The PHP driver supports managing indexes through the -:phpclass:`MongoDB\\Collection` class, which implements MongoDB's +:phpclass:`MongoDB\Collection` class, which implements MongoDB's cross-driver `Index Management `_ and `Enumerating Indexes @@ -26,12 +26,12 @@ MongoDB. Create Indexes -------------- -Create indexes with the :phpmethod:`MongoDB\\Collection::createIndex()` or -:phpmethod:`MongoDB\\Collection::createIndexes()` methods. Refer to the method +Create indexes with the :phpmethod:`MongoDB\Collection::createIndex()` or +:phpmethod:`MongoDB\Collection::createIndexes()` methods. Refer to the method reference for more details about each method. The following example creates an ascending index on the ``state`` field using -the :phpmethod:`createIndex() ` method: +the :phpmethod:`createIndex() ` method: .. code-block:: php @@ -54,10 +54,10 @@ similar to: List Indexes ------------ -The :phpmethod:`MongoDB\\Collection::listIndexes()` method provides information +The :phpmethod:`MongoDB\Collection::listIndexes()` method provides information about the indexes in a collection. The -:phpmethod:`MongoDB\\Collection::listIndexes()` method returns an iterator of -:phpclass:`MongoDB\\Model\\IndexInfo` objects, which you can use to view +:phpmethod:`MongoDB\Collection::listIndexes()` method returns an iterator of +:phpclass:`MongoDB\Model\IndexInfo` objects, which you can use to view information about each index. Refer to the method reference for more details. The following example lists all indexes in the ``zips`` collection in the @@ -107,8 +107,8 @@ The output would resemble: Drop Indexes ------------ -The :phpmethod:`MongoDB\\Collection::dropIndex()` method lets you drop a single -index while :phpmethod:`MongoDB\\Collection::dropIndexes()` drops all of the +The :phpmethod:`MongoDB\Collection::dropIndex()` method lets you drop a single +index while :phpmethod:`MongoDB\Collection::dropIndexes()` drops all of the indexes on a collection. Refer to the method reference for more details about each method. diff --git a/docs/tutorial/modeling-bson-data.txt b/docs/tutorial/modeling-bson-data.txt index 46ab3cf91..56f0217af 100644 --- a/docs/tutorial/modeling-bson-data.txt +++ b/docs/tutorial/modeling-bson-data.txt @@ -17,13 +17,13 @@ Type Maps Most methods that read data from MongoDB support a ``typeMap`` option, which allows control over how BSON is converted to PHP. Additionally, -the :phpclass:`MongoDB\\Client`, :phpclass:`MongoDB\\Database`, and -:phpclass:`MongoDB\\Collection` classes accept a ``typeMap`` option, which can +the :phpclass:`MongoDB\Client`, :phpclass:`MongoDB\Database`, and +:phpclass:`MongoDB\Collection` classes accept a ``typeMap`` option, which can be used to specify a default type map to apply to any supporting methods and -selected classes (e.g. :phpmethod:`MongoDB\\Client::selectDatabase()`). +selected classes (e.g. :phpmethod:`MongoDB\Client::selectDatabase()`). -The :phpclass:`MongoDB\\Client`, :phpclass:`MongoDB\\Database`, and -:phpclass:`MongoDB\\Collection` classes use the following type map by +The :phpclass:`MongoDB\Client`, :phpclass:`MongoDB\Database`, and +:phpclass:`MongoDB\Collection` classes use the following type map by default: .. code-block:: php @@ -35,13 +35,13 @@ default: ] The type map above will convert BSON documents and arrays to -:phpclass:`MongoDB\\Model\\BSONDocument` and -:phpclass:`MongoDB\\Model\\BSONArray` objects, respectively. The ``root`` and +:phpclass:`MongoDB\Model\BSONDocument` and +:phpclass:`MongoDB\Model\BSONArray` objects, respectively. The ``root`` and ``document`` keys are used to distinguish the top-level BSON document from embedded documents, respectively. A type map may specify any class that implements -:php:`MongoDB\\BSON\\Unserializable ` as well as +:php:`MongoDB\BSON\Unserializable ` as well as ``"array"``, ``"stdClass``", and ``"object"`` (``"stdClass``" and ``"object"`` are aliases of one another). @@ -54,7 +54,7 @@ Persistable Classes ------------------- The driver's :php:`persistence specification ` outlines how -classes implementing its :php:`MongoDB\\BSON\\Persistable +classes implementing its :php:`MongoDB\BSON\Persistable ` interface are serialized to and deserialized from BSON. The :php:`Persistable ` interface is analogous to PHP's :php:`Serializable interface `. @@ -156,7 +156,7 @@ The same document in the MongoDB shell might display as: .. note:: - :php:`MongoDB\\BSON\\Persistable ` may only be used + :php:`MongoDB\BSON\Persistable ` may only be used for root and embedded BSON documents. It may not be used for BSON arrays. Working with Enums @@ -208,10 +208,10 @@ enum is responsible for converting the value back to an enum case: } Enums are prohibited from implementing -:php:`MongoDB\\BSON\\Unserializable ` and -:php:`MongoDB\\BSON\\Persistable `, since enum cases +:php:`MongoDB\BSON\Unserializable ` and +:php:`MongoDB\BSON\Persistable `, since enum cases have no state and cannot be instantiated like ordinary objects. Pure and backed enums can, however, implement -:php:`MongoDB\\BSON\\Serializable `, which can be +:php:`MongoDB\BSON\Serializable `, which can be used to overcome the default behavior whereby backed enums are serialized as their case value and pure enums cannot be serialized. diff --git a/docs/tutorial/stable-api.txt b/docs/tutorial/stable-api.txt index 1220f0326..d018162a7 100644 --- a/docs/tutorial/stable-api.txt +++ b/docs/tutorial/stable-api.txt @@ -15,7 +15,7 @@ Declaring an API Version To declare an API version, pass a ``serverApi`` driver option when creating your client. The value is a -:php:`MongoDB\\Driver\\ServerApi ` instance that +:php:`MongoDB\Driver\ServerApi ` instance that contains API version information. This feature is introduced in MongoDB 5.0, which will initially support only API version "1". Additional versions may be introduced in future versions of the server. @@ -46,7 +46,7 @@ By default, declaring an API version guarantees behavior for commands that are part of the stable API, but does not forbid using commands that are not part of the API version. To only allow commands and options that are part of the stable API, specify the ``strict`` option when creating the -:php:`MongoDB\\Driver\\ServerApi ` instance: +:php:`MongoDB\Driver\ServerApi ` instance: .. code-block:: php @@ -85,9 +85,9 @@ testing to ensure a smooth transition to a future API version. Usage with the Command Helper ----------------------------- -When using the :phpmethod:`MongoDB\\Database::command()` method to run arbitrary +When using the :phpmethod:`MongoDB\Database::command()` method to run arbitrary commands, the API version declared to the client is automatically appended to the command document. Setting any of the ``apiVersion``, ``apiStrict``, or ``apiDeprecationErrors`` command options in the command document and calling -:phpmethod:`MongoDB\\Database::command()` from a client with a declared API +:phpmethod:`MongoDB\Database::command()` from a client with a declared API version is not supported and will lead to undefined behavior. diff --git a/docs/tutorial/tailable-cursor.txt b/docs/tutorial/tailable-cursor.txt index 370a642a1..6f2503214 100644 --- a/docs/tutorial/tailable-cursor.txt +++ b/docs/tutorial/tailable-cursor.txt @@ -17,7 +17,7 @@ Overview When the driver executes a query or command (e.g. :manual:`aggregate `), results from the operation -are returned via a :php:`MongoDB\\Driver\\Cursor ` +are returned via a :php:`MongoDB\Driver\Cursor ` object. The Cursor class implements PHP's :php:`Iterator ` interface, which allows it to be iterated with ``foreach`` and interface with any PHP functions that work with :php:`iterables `. Similar to @@ -108,7 +108,7 @@ Iterating a Tailable Cursor In order to demonstrate a tailable cursor in action, we'll need two scripts: a "producer" and a "consumer". The producer script will create a new capped -collection using :phpmethod:`MongoDB\\Database::createCollection()` and proceed +collection using :phpmethod:`MongoDB\Database::createCollection()` and proceed to insert a new document into that collection each second. .. code-block:: php @@ -131,7 +131,7 @@ to insert a new document into that collection each second. With the producer script still running, we will now execute a consumer script to read the inserted documents using a tailable cursor, indicated by the -``cursorType`` option to :phpmethod:`MongoDB\\Collection::find()`. We'll start +``cursorType`` option to :phpmethod:`MongoDB\Collection::find()`. We'll start by using ``foreach`` to illustrate its shortcomings: .. code-block:: php @@ -187,4 +187,4 @@ to check if there is actually data available to read at each step. Since we've elected to use a ``TAILABLE_AWAIT`` cursor, the server will delay its response to the driver for a set amount of time. In this example, we've requested that the server block for approximately 100 milliseconds by specifying -the ``maxAwaitTimeMS`` option to :phpmethod:`MongoDB\\Collection::find()`. +the ``maxAwaitTimeMS`` option to :phpmethod:`MongoDB\Collection::find()`. diff --git a/docs/upgrade.txt b/docs/upgrade.txt index 50da6f2fe..c31c9d9d4 100644 --- a/docs/upgrade.txt +++ b/docs/upgrade.txt @@ -31,7 +31,7 @@ Type Classes When upgrading from the legacy driver, type classes such as MongoId must be replaced with classes in the -`MongoDB\\BSON namespace `_. The +`MongoDB\BSON namespace `_. The new driver also introduces interfaces for its BSON types, which should be preferred if applications need to type hint against BSON values. @@ -46,31 +46,31 @@ the new driver. - BSON type interface * - MongoId - - :php:`MongoDB\\BSON\\ObjectId ` - - :php:`MongoDB\\BSON\\ObjectIdInterface ` + - :php:`MongoDB\BSON\ObjectId ` + - :php:`MongoDB\BSON\ObjectIdInterface ` * - MongoCode - - :php:`MongoDB\\BSON\\Javascript ` - - :php:`MongoDB\\BSON\\JavascriptInterface ` + - :php:`MongoDB\BSON\Javascript ` + - :php:`MongoDB\BSON\JavascriptInterface ` * - MongoDate - - :php:`MongoDB\\BSON\\UTCDateTime ` - - :php:`MongoDB\\BSON\\UTCDateTimeInterface ` + - :php:`MongoDB\BSON\UTCDateTime ` + - :php:`MongoDB\BSON\UTCDateTimeInterface ` * - MongoRegex - - :php:`MongoDB\\BSON\\Regex ` - - :php:`MongoDB\\BSON\\RegexInterface ` + - :php:`MongoDB\BSON\Regex ` + - :php:`MongoDB\BSON\RegexInterface ` * - MongoBinData - - :php:`MongoDB\\BSON\\Binary ` - - :php:`MongoDB\\BSON\\BinaryInterface ` + - :php:`MongoDB\BSON\Binary ` + - :php:`MongoDB\BSON\BinaryInterface ` * - MongoInt32 - Not implemented. [1]_ - * - MongoInt64 - - :php:`MongoDB\\BSON\\Int64 ` + - :php:`MongoDB\BSON\Int64 ` - Not implemented. [2]_ * - MongoDBRef @@ -78,23 +78,23 @@ the new driver. - * - MongoMinKey - - :php:`MongoDB\\BSON\\MinKey ` - - :php:`MongoDB\\BSON\\MinKeyInterface ` + - :php:`MongoDB\BSON\MinKey ` + - :php:`MongoDB\BSON\MinKeyInterface ` * - MongoMaxKey - - :php:`MongoDB\\BSON\\MaxKey ` - - :php:`MongoDB\\BSON\\MaxKeyInterface ` + - :php:`MongoDB\BSON\MaxKey ` + - :php:`MongoDB\BSON\MaxKeyInterface ` * - MongoTimestamp - - :php:`MongoDB\\BSON\\Timestamp ` - - :php:`MongoDB\\BSON\\TimestampInterface ` + - :php:`MongoDB\BSON\Timestamp ` + - :php:`MongoDB\BSON\TimestampInterface ` .. [1] The new driver does not implement an equivalent class for MongoInt32. When decoding BSON, 32-bit integers will always be represented as a PHP integer. When encoding BSON, PHP integers will encode as either a 32-bit or 64-bit integer depending on their value. -.. [2] :php:`MongoDB\\BSON\\Int64 ` does not have an +.. [2] :php:`MongoDB\BSON\Int64 ` does not have an interface defined. The new driver does not allow applications to instantiate this type (i.e. its constructor is private) and it is only created during BSON decoding when a 64-bit integer cannot be represented as a PHP integer on @@ -121,8 +121,8 @@ problematic: was a gap in their key sequence. Such gaps were caused by unsetting a key to remove an element and forgetting to numerically reindex the array. -The |php-library|'s :phpclass:`BSONDocument ` and -:phpclass:`BSONArray ` classes address these concerns +The |php-library|'s :phpclass:`BSONDocument ` and +:phpclass:`BSONArray ` classes address these concerns by preserving the BSON type information during serialization and deserialization; however, some users may still prefer the legacy behavior. If desired, you can use the ``typeMap`` option to have the library return @@ -173,7 +173,7 @@ The above example would output something similar to: Collection API -------------- -This library's :phpclass:`MongoDB\\Collection` class implements MongoDB's +This library's :phpclass:`MongoDB\Collection` class implements MongoDB's cross-driver `CRUD `_ and `Index Management @@ -197,102 +197,102 @@ equivalent method(s) in the new driver. :header-rows: 1 * - MongoCollection method - - :phpclass:`MongoDB\\Collection` method(s) + - :phpclass:`MongoDB\Collection` method(s) * - ``MongoCollection::aggregate()`` - - :phpmethod:`MongoDB\\Collection::aggregate()` + - :phpmethod:`MongoDB\Collection::aggregate()` * - ``MongoCollection::aggregateCursor()`` - - :phpmethod:`MongoDB\\Collection::aggregate()` + - :phpmethod:`MongoDB\Collection::aggregate()` * - ``MongoCollection::batchInsert()`` - - :phpmethod:`MongoDB\\Collection::insertMany()` + - :phpmethod:`MongoDB\Collection::insertMany()` * - ``MongoCollection::count()`` - - :phpmethod:`MongoDB\\Collection::count()` + - :phpmethod:`MongoDB\Collection::count()` * - ``MongoCollection::createDBRef()`` - Not yet implemented. [3]_ * - ``MongoCollection::createIndex()`` - - :phpmethod:`MongoDB\\Collection::createIndex()` + - :phpmethod:`MongoDB\Collection::createIndex()` * - ``MongoCollection::deleteIndex()`` - - :phpmethod:`MongoDB\\Collection::dropIndex()` + - :phpmethod:`MongoDB\Collection::dropIndex()` * - ``MongoCollection::deleteIndexes()`` - - :phpmethod:`MongoDB\\Collection::dropIndexes()` + - :phpmethod:`MongoDB\Collection::dropIndexes()` * - ``MongoCollection::drop()`` - - :phpmethod:`MongoDB\\Collection::drop()` + - :phpmethod:`MongoDB\Collection::drop()` * - ``MongoCollection::distinct()`` - - :phpmethod:`MongoDB\\Collection::distinct()` + - :phpmethod:`MongoDB\Collection::distinct()` * - ``MongoCollection::ensureIndex()`` - - :phpmethod:`MongoDB\\Collection::createIndex()` + - :phpmethod:`MongoDB\Collection::createIndex()` * - ``MongoCollection::find()`` - - :phpmethod:`MongoDB\\Collection::find()` + - :phpmethod:`MongoDB\Collection::find()` * - ``MongoCollection::findAndModify()`` - - :phpmethod:`MongoDB\\Collection::findOneAndDelete()`, - :phpmethod:`MongoDB\\Collection::findOneAndReplace()`, and - :phpmethod:`MongoDB\\Collection::findOneAndUpdate()` + - :phpmethod:`MongoDB\Collection::findOneAndDelete()`, + :phpmethod:`MongoDB\Collection::findOneAndReplace()`, and + :phpmethod:`MongoDB\Collection::findOneAndUpdate()` * - ``MongoCollection::findOne()`` - - :phpmethod:`MongoDB\\Collection::findOne()` + - :phpmethod:`MongoDB\Collection::findOne()` * - ``MongoCollection::getDBRef()`` - Not implemented. [3]_ * - ``MongoCollection::getIndexInfo()`` - - :phpmethod:`MongoDB\\Collection::listIndexes()` + - :phpmethod:`MongoDB\Collection::listIndexes()` * - ``MongoCollection::getName()`` - - :phpmethod:`MongoDB\\Collection::getCollectionName()` + - :phpmethod:`MongoDB\Collection::getCollectionName()` * - ``MongoCollection::getReadPreference()`` - - :phpmethod:`MongoDB\\Collection::getReadPreference()` + - :phpmethod:`MongoDB\Collection::getReadPreference()` * - ``MongoCollection::getSlaveOkay()`` - Not implemented. * - ``MongoCollection::getWriteConcern()`` - - :phpmethod:`MongoDB\\Collection::getWriteConcern()` + - :phpmethod:`MongoDB\Collection::getWriteConcern()` * - ``MongoCollection::group()`` - - Not implemented. Use :phpmethod:`MongoDB\\Database::command()`. See + - Not implemented. Use :phpmethod:`MongoDB\Database::command()`. See :ref:`Group Command Helper ` for an example. * - ``MongoCollection::insert()`` - - :phpmethod:`MongoDB\\Collection::insertOne()` + - :phpmethod:`MongoDB\Collection::insertOne()` * - ``MongoCollection::parallelCollectionScan()`` - Not implemented. * - ``MongoCollection::remove()`` - - :phpmethod:`MongoDB\\Collection::deleteMany()` and - :phpmethod:`MongoDB\\Collection::deleteOne()` + - :phpmethod:`MongoDB\Collection::deleteMany()` and + :phpmethod:`MongoDB\Collection::deleteOne()` * - ``MongoCollection::save()`` - - :phpmethod:`MongoDB\\Collection::insertOne()` or - :phpmethod:`MongoDB\\Collection::replaceOne()` with the ``upsert`` + - :phpmethod:`MongoDB\Collection::insertOne()` or + :phpmethod:`MongoDB\Collection::replaceOne()` with the ``upsert`` option. * - ``MongoCollection::setReadPreference()`` - - Not implemented. Use :phpmethod:`MongoDB\\Collection::withOptions()`. + - Not implemented. Use :phpmethod:`MongoDB\Collection::withOptions()`. * - ``MongoCollection::setSlaveOkay()`` - Not implemented. * - ``MongoCollection::setWriteConcern()`` - - Not implemented. Use :phpmethod:`MongoDB\\Collection::withOptions()`. + - Not implemented. Use :phpmethod:`MongoDB\Collection::withOptions()`. * - ``MongoCollection::update()`` - - :phpmethod:`MongoDB\\Collection::replaceOne()`, - :phpmethod:`MongoDB\\Collection::updateMany()`, and - :phpmethod:`MongoDB\\Collection::updateOne()`. + - :phpmethod:`MongoDB\Collection::replaceOne()`, + :phpmethod:`MongoDB\Collection::updateMany()`, and + :phpmethod:`MongoDB\Collection::updateOne()`. * - ``MongoCollection::validate()`` - Not implemented. @@ -312,18 +312,18 @@ longer done in the new driver and library. IDs of inserted documents (whether generated or not) may be accessed through the following methods on the write result objects: -- :phpmethod:`MongoDB\\InsertOneResult::getInsertedId()` for - :phpmethod:`MongoDB\\Collection::insertOne()` -- :phpmethod:`MongoDB\\InsertManyResult::getInsertedIds()` for - :phpmethod:`MongoDB\\Collection::insertMany()` -- :phpmethod:`MongoDB\\BulkWriteResult::getInsertedIds()` for - :phpmethod:`MongoDB\\Collection::bulkWrite()` +- :phpmethod:`MongoDB\InsertOneResult::getInsertedId()` for + :phpmethod:`MongoDB\Collection::insertOne()` +- :phpmethod:`MongoDB\InsertManyResult::getInsertedIds()` for + :phpmethod:`MongoDB\Collection::insertMany()` +- :phpmethod:`MongoDB\BulkWriteResult::getInsertedIds()` for + :phpmethod:`MongoDB\Collection::bulkWrite()` Bulk Write Operations ~~~~~~~~~~~~~~~~~~~~~ The legacy driver's MongoWriteBatch classes have been replaced with a -general-purpose :phpmethod:`MongoDB\\Collection::bulkWrite()` method. Whereas +general-purpose :phpmethod:`MongoDB\Collection::bulkWrite()` method. Whereas the legacy driver only allowed bulk operations of the same type, the new method allows operations to be mixed (e.g. inserts, updates, and deletes). @@ -332,16 +332,16 @@ MongoCollection::save() Removed ``MongoCollection::save()``, which was syntactic sugar for an insert or upsert operation, has been removed in favor of explicitly using -:phpmethod:`MongoDB\\Collection::insertOne()` or -:phpmethod:`MongoDB\\Collection::replaceOne()` (with the ``upsert`` option). +:phpmethod:`MongoDB\Collection::insertOne()` or +:phpmethod:`MongoDB\Collection::replaceOne()` (with the ``upsert`` option). While the ``save`` method does have its uses for interactive environments, such as the MongoDB shell, it was intentionally excluded from the `CRUD specification `_ for language drivers. Generally, application code should know if the document has an identifier and be able to explicitly insert or replace the document and -handle the returned :phpclass:`MongoDB\\InsertOneResult` or -:phpclass:`MongoDB\\UpdateResult`, respectively. This also helps avoid +handle the returned :phpclass:`MongoDB\InsertOneResult` or +:phpclass:`MongoDB\UpdateResult`, respectively. This also helps avoid inadvertent and potentially dangerous :manual:`full-document replacements `. @@ -350,10 +350,10 @@ inadvertent and potentially dangerous :manual:`full-document replacements Group Command Helper ~~~~~~~~~~~~~~~~~~~~ -:phpclass:`MongoDB\\Collection` does not have a helper method for the +:phpclass:`MongoDB\Collection` does not have a helper method for the :manual:`group ` command. The following example demonstrates how to execute a group command using the -:phpmethod:`MongoDB\\Database::command()` method: +:phpmethod:`MongoDB\Database::command()` method: .. code-block:: php