From a84eb33155eededa6d75b32df245be00628faaad Mon Sep 17 00:00:00 2001 From: Nora Reidy Date: Wed, 21 Feb 2024 15:39:30 -0500 Subject: [PATCH] DOCSP-36027: Shorten class headings in nav (#1229) Also consolidates result classes to a single section (cherry picked from commit 00d44d41a4eb67586207d149d24fd93b1eb5bc6d) --- .../class/MongoDBBulkWriteResult.txt | 37 ++++ docs/reference/class/MongoDBChangeStream.txt | 42 ++++ docs/reference/class/MongoDBClient.txt | 46 +++-- docs/reference/class/MongoDBCollection.txt | 115 +++++++---- docs/reference/class/MongoDBDatabase.txt | 66 ++++-- docs/reference/class/MongoDBDeleteResult.txt | 26 +++ docs/reference/class/MongoDBGridFSBucket.txt | 69 ++++--- .../class/MongoDBInsertManyResult.txt | 27 +++ .../class/MongoDBInsertOneResult.txt | 27 +++ .../class/MongoDBMapReduceResult.txt | 34 +++ .../class/MongoDBModelCollectionInfo.txt | 49 +++++ .../MongoDBModelCollectionInfoIterator.txt | 20 ++ .../class/MongoDBModelDatabaseInfo.txt | 39 ++++ .../MongoDBModelDatabaseInfoIterator.txt | 20 ++ .../reference/class/MongoDBModelIndexInfo.txt | 51 +++++ .../class/MongoDBModelIndexInfoIterator.txt | 20 ++ docs/reference/class/MongoDBUpdateResult.txt | 33 +++ docs/reference/enumeration-classes.txt | 193 ------------------ docs/reference/functions.txt | 4 +- .../method/MongoDBCollection-mapReduce.txt | 4 +- .../MongoDBGridFSBucket-getWriteConcern.txt | 6 +- docs/reference/result-classes.txt | 80 ++------ docs/reference/write-result-classes.txt | 143 ------------- 23 files changed, 644 insertions(+), 507 deletions(-) create mode 100644 docs/reference/class/MongoDBBulkWriteResult.txt create mode 100644 docs/reference/class/MongoDBChangeStream.txt create mode 100644 docs/reference/class/MongoDBDeleteResult.txt create mode 100644 docs/reference/class/MongoDBInsertManyResult.txt create mode 100644 docs/reference/class/MongoDBInsertOneResult.txt create mode 100644 docs/reference/class/MongoDBMapReduceResult.txt create mode 100644 docs/reference/class/MongoDBModelCollectionInfo.txt create mode 100644 docs/reference/class/MongoDBModelCollectionInfoIterator.txt create mode 100644 docs/reference/class/MongoDBModelDatabaseInfo.txt create mode 100644 docs/reference/class/MongoDBModelDatabaseInfoIterator.txt create mode 100644 docs/reference/class/MongoDBModelIndexInfo.txt create mode 100644 docs/reference/class/MongoDBModelIndexInfoIterator.txt create mode 100644 docs/reference/class/MongoDBUpdateResult.txt delete mode 100644 docs/reference/enumeration-classes.txt delete mode 100644 docs/reference/write-result-classes.txt diff --git a/docs/reference/class/MongoDBBulkWriteResult.txt b/docs/reference/class/MongoDBBulkWriteResult.txt new file mode 100644 index 000000000..f33b036d6 --- /dev/null +++ b/docs/reference/class/MongoDBBulkWriteResult.txt @@ -0,0 +1,37 @@ +============================== +MongoDB\\BulkWriteResult Class +============================== + +Definition +---------- + +.. 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()`. + +Methods +------- + +.. toctree:: + :titlesonly: + + getDeletedCount() + getInsertedCount() + getInsertedIds() + getMatchedCount() + getModifiedCount() + getUpsertedCount() + 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 diff --git a/docs/reference/class/MongoDBChangeStream.txt b/docs/reference/class/MongoDBChangeStream.txt new file mode 100644 index 000000000..3142aeece --- /dev/null +++ b/docs/reference/class/MongoDBChangeStream.txt @@ -0,0 +1,42 @@ +=========================== +MongoDB\\ChangeStream Class +=========================== + +.. versionadded:: 1.3 + +Definition +---------- + +.. 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()`. + + 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 + failover. + +Methods +------- + +.. toctree:: + :titlesonly: + + current() + getCursorId() + getResumeToken() + key() + next() + 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 diff --git a/docs/reference/class/MongoDBClient.txt b/docs/reference/class/MongoDBClient.txt index b677ebb1d..757392528 100644 --- a/docs/reference/class/MongoDBClient.txt +++ b/docs/reference/class/MongoDBClient.txt @@ -28,18 +28,34 @@ Methods .. toctree:: :titlesonly: - /reference/method/MongoDBClient__construct - /reference/method/MongoDBClient__get - /reference/method/MongoDBClient-createClientEncryption - /reference/method/MongoDBClient-dropDatabase - /reference/method/MongoDBClient-getManager - /reference/method/MongoDBClient-getReadConcern - /reference/method/MongoDBClient-getReadPreference - /reference/method/MongoDBClient-getTypeMap - /reference/method/MongoDBClient-getWriteConcern - /reference/method/MongoDBClient-listDatabaseNames - /reference/method/MongoDBClient-listDatabases - /reference/method/MongoDBClient-selectCollection - /reference/method/MongoDBClient-selectDatabase - /reference/method/MongoDBClient-startSession - /reference/method/MongoDBClient-watch + __construct() + __get() + createClientEncryption() + dropDatabase() + getManager() + getReadConcern() + getReadPreference() + getTypeMap() + getWriteConcern() + listDatabaseNames() + listDatabases() + selectCollection() + selectDatabase() + 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()` diff --git a/docs/reference/class/MongoDBCollection.txt b/docs/reference/class/MongoDBCollection.txt index 9c9aa3134..e303643b3 100644 --- a/docs/reference/class/MongoDBCollection.txt +++ b/docs/reference/class/MongoDBCollection.txt @@ -58,41 +58,80 @@ Methods .. toctree:: :titlesonly: - /reference/method/MongoDBCollection__construct - /reference/method/MongoDBCollection-aggregate - /reference/method/MongoDBCollection-bulkWrite - /reference/method/MongoDBCollection-count - /reference/method/MongoDBCollection-countDocuments - /reference/method/MongoDBCollection-createIndex - /reference/method/MongoDBCollection-createIndexes - /reference/method/MongoDBCollection-deleteMany - /reference/method/MongoDBCollection-deleteOne - /reference/method/MongoDBCollection-distinct - /reference/method/MongoDBCollection-drop - /reference/method/MongoDBCollection-dropIndex - /reference/method/MongoDBCollection-dropIndexes - /reference/method/MongoDBCollection-estimatedDocumentCount - /reference/method/MongoDBCollection-explain - /reference/method/MongoDBCollection-find - /reference/method/MongoDBCollection-findOne - /reference/method/MongoDBCollection-findOneAndDelete - /reference/method/MongoDBCollection-findOneAndReplace - /reference/method/MongoDBCollection-findOneAndUpdate - /reference/method/MongoDBCollection-getCollectionName - /reference/method/MongoDBCollection-getDatabaseName - /reference/method/MongoDBCollection-getManager - /reference/method/MongoDBCollection-getNamespace - /reference/method/MongoDBCollection-getReadConcern - /reference/method/MongoDBCollection-getReadPreference - /reference/method/MongoDBCollection-getTypeMap - /reference/method/MongoDBCollection-getWriteConcern - /reference/method/MongoDBCollection-insertMany - /reference/method/MongoDBCollection-insertOne - /reference/method/MongoDBCollection-listIndexes - /reference/method/MongoDBCollection-mapReduce - /reference/method/MongoDBCollection-rename - /reference/method/MongoDBCollection-replaceOne - /reference/method/MongoDBCollection-updateMany - /reference/method/MongoDBCollection-updateOne - /reference/method/MongoDBCollection-watch - /reference/method/MongoDBCollection-withOptions + __construct() + aggregate() + bulkWrite() + count() + countDocuments() + createIndex() + createIndexes() + deleteMany() + deleteOne() + distinct() + drop() + dropIndex() + dropIndexes() + estimatedDocumentCount() + explain() + find() + findOne() + findOneAndDelete() + findOneAndReplace() + findOneAndUpdate() + getCollectionName() + getDatabaseName() + getManager() + getNamespace() + getReadConcern() + getReadPreference() + getTypeMap() + getWriteConcern() + insertMany() + insertOne() + listIndexes() + mapReduce() + rename() + replaceOne() + updateMany() + updateOne() + 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()` diff --git a/docs/reference/class/MongoDBDatabase.txt b/docs/reference/class/MongoDBDatabase.txt index ac0e0d16c..f92d23145 100644 --- a/docs/reference/class/MongoDBDatabase.txt +++ b/docs/reference/class/MongoDBDatabase.txt @@ -43,26 +43,48 @@ Methods .. toctree:: :titlesonly: - /reference/method/MongoDBDatabase__construct - /reference/method/MongoDBDatabase__get - /reference/method/MongoDBDatabase-aggregate - /reference/method/MongoDBDatabase-command - /reference/method/MongoDBDatabase-createCollection - /reference/method/MongoDBDatabase-createEncryptedCollection - /reference/method/MongoDBDatabase-drop - /reference/method/MongoDBDatabase-dropCollection - /reference/method/MongoDBDatabase-getDatabaseName - /reference/method/MongoDBDatabase-getManager - /reference/method/MongoDBDatabase-getReadConcern - /reference/method/MongoDBDatabase-getReadPreference - /reference/method/MongoDBDatabase-getTypeMap - /reference/method/MongoDBDatabase-getWriteConcern - /reference/method/MongoDBDatabase-listCollectionNames - /reference/method/MongoDBDatabase-listCollections - /reference/method/MongoDBDatabase-modifyCollection - /reference/method/MongoDBDatabase-renameCollection - /reference/method/MongoDBDatabase-selectCollection - /reference/method/MongoDBDatabase-selectGridFSBucket - /reference/method/MongoDBDatabase-watch - /reference/method/MongoDBDatabase-withOptions + __construct() + __get() + aggregate() + command() + createCollection() + createEncryptedCollection() + drop() + dropCollection() + getDatabaseName() + getManager() + getReadConcern() + getReadPreference() + getTypeMap() + getWriteConcern() + listCollectionNames() + listCollections() + modifyCollection() + renameCollection() + selectCollection() + selectGridFSBucket() + 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 diff --git a/docs/reference/class/MongoDBDeleteResult.txt b/docs/reference/class/MongoDBDeleteResult.txt new file mode 100644 index 000000000..02c2c8c17 --- /dev/null +++ b/docs/reference/class/MongoDBDeleteResult.txt @@ -0,0 +1,26 @@ +=========================== +MongoDB\\DeleteResult Class +=========================== + +Definition +---------- + +.. 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()`. + +Methods +------- + +.. toctree:: + :titlesonly: + + getDeletedCount() + isAcknowledged() + +- :phpmethod:`MongoDB\\DeleteResult::getDeletedCount()` +- :phpmethod:`MongoDB\\DeleteResult::isAcknowledged()` diff --git a/docs/reference/class/MongoDBGridFSBucket.txt b/docs/reference/class/MongoDBGridFSBucket.txt index 0fdeb5cb8..7703a678c 100644 --- a/docs/reference/class/MongoDBGridFSBucket.txt +++ b/docs/reference/class/MongoDBGridFSBucket.txt @@ -34,26 +34,49 @@ Methods .. toctree:: :titlesonly: - /reference/method/MongoDBGridFSBucket__construct - /reference/method/MongoDBGridFSBucket-delete - /reference/method/MongoDBGridFSBucket-downloadToStream - /reference/method/MongoDBGridFSBucket-downloadToStreamByName - /reference/method/MongoDBGridFSBucket-drop - /reference/method/MongoDBGridFSBucket-find - /reference/method/MongoDBGridFSBucket-findOne - /reference/method/MongoDBGridFSBucket-getBucketName - /reference/method/MongoDBGridFSBucket-getChunksCollection - /reference/method/MongoDBGridFSBucket-getChunkSizeBytes - /reference/method/MongoDBGridFSBucket-getDatabaseName - /reference/method/MongoDBGridFSBucket-getFileDocumentForStream - /reference/method/MongoDBGridFSBucket-getFileIdForStream - /reference/method/MongoDBGridFSBucket-getFilesCollection - /reference/method/MongoDBGridFSBucket-getReadConcern - /reference/method/MongoDBGridFSBucket-getReadPreference - /reference/method/MongoDBGridFSBucket-getTypeMap - /reference/method/MongoDBGridFSBucket-getWriteConcern - /reference/method/MongoDBGridFSBucket-openDownloadStream - /reference/method/MongoDBGridFSBucket-openDownloadStreamByName - /reference/method/MongoDBGridFSBucket-openUploadStream - /reference/method/MongoDBGridFSBucket-rename - /reference/method/MongoDBGridFSBucket-uploadFromStream + __construct() + delete() + downloadToStream() + downloadToStreamByName() + drop() + find() + findOne() + getBucketName() + getChunksCollection() + getChunkSizeBytes() + getDatabaseName() + getFileDocumentForStream() + getFileIdForStream() + getFilesCollection() + getReadConcern() + getReadPreference() + getTypeMap() + getWriteConcern() + openDownloadStream() + openDownloadStreamByName() + openUploadStream() + 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()` diff --git a/docs/reference/class/MongoDBInsertManyResult.txt b/docs/reference/class/MongoDBInsertManyResult.txt new file mode 100644 index 000000000..16d9b4827 --- /dev/null +++ b/docs/reference/class/MongoDBInsertManyResult.txt @@ -0,0 +1,27 @@ +=============================== +MongoDB\\InsertManyResult Class +=============================== + +Definition +---------- + +.. 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()`. + +Methods +------- + +.. toctree:: + :titlesonly: + + getInsertedCount() + getInsertedIds() + isAcknowledged() + +- :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 new file mode 100644 index 000000000..19454d221 --- /dev/null +++ b/docs/reference/class/MongoDBInsertOneResult.txt @@ -0,0 +1,27 @@ +============================== +MongoDB\\InsertOneResult Class +============================== + +Definition +---------- + +.. 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()`. + +Methods +------- + +.. toctree:: + :titlesonly: + + getInsertedCount() + getInsertedId() + isAcknowledged() + +- :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 new file mode 100644 index 000000000..601f6f82a --- /dev/null +++ b/docs/reference/class/MongoDBMapReduceResult.txt @@ -0,0 +1,34 @@ +============================== +MongoDB\\MapReduceResult Class +============================== + +.. versionadded:: 1.2 + +Definition +---------- + +.. phpclass:: MongoDB\\MapReduceResult + + This class extends PHP's :php:`IteratorAggregate ` + interface. An instance of this class is returned by + :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 + statistics. + +Methods +------- + +.. toctree:: + :titlesonly: + + getCounts() + getExecutionTimeMS() + getIterator() + getTiming() + +- :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 new file mode 100644 index 000000000..178070952 --- /dev/null +++ b/docs/reference/class/MongoDBModelCollectionInfo.txt @@ -0,0 +1,49 @@ +==================================== +MongoDB\\Model\\CollectionInfo Class +==================================== + +Definition +---------- + +.. 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()`. + +.. versionchanged:: 1.4 + + This class implements PHP's :php:`ArrayAccess ` interface. This + provides a mechanism for accessing index fields for which there exists no + helper method. :php:`isset() ` may be used to check for the existence + of a field before accessing it with ``[]``. + + .. note:: + + 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`. + +Methods +------- + +.. toctree:: + :titlesonly: + + getCappedMax() + getCappedSize() + getIdIndex() + getInfo() + getName() + getOptions() + 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 diff --git a/docs/reference/class/MongoDBModelCollectionInfoIterator.txt b/docs/reference/class/MongoDBModelCollectionInfoIterator.txt new file mode 100644 index 000000000..5358f2137 --- /dev/null +++ b/docs/reference/class/MongoDBModelCollectionInfoIterator.txt @@ -0,0 +1,20 @@ +============================================ +MongoDB\\Model\\CollectionInfoIterator Class +============================================ + +Definition +---------- + +.. phpclass:: MongoDB\\Model\\CollectionInfoIterator + + This interface extends PHP's :php:`Iterator ` + interface. An instance of this interface is returned by + :phpmethod:`MongoDB\\Database::listCollections()`. + +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 diff --git a/docs/reference/class/MongoDBModelDatabaseInfo.txt b/docs/reference/class/MongoDBModelDatabaseInfo.txt new file mode 100644 index 000000000..e0f45852d --- /dev/null +++ b/docs/reference/class/MongoDBModelDatabaseInfo.txt @@ -0,0 +1,39 @@ +================================== +MongoDB\\Model\\DatabaseInfo Class +================================== + +Definition +---------- + +.. 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()`. + +.. versionchanged:: 1.4 + + This class implements PHP's :php:`ArrayAccess ` interface. This + provides a mechanism for accessing index fields for which there exists no + helper method. :php:`isset() ` may be used to check for the existence + of a field before accessing it with ``[]``. + + .. note:: + + 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`. + +Methods +------- + +.. toctree:: + :titlesonly: + + getName() + getSizeOnDisk() + isEmpty() + +- :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 new file mode 100644 index 000000000..960ca2562 --- /dev/null +++ b/docs/reference/class/MongoDBModelDatabaseInfoIterator.txt @@ -0,0 +1,20 @@ +========================================== +MongoDB\\Model\\DatabaseInfoIterator Class +========================================== + +Definition +---------- + +.. phpclass:: MongoDB\\Model\\DatabaseInfoIterator + + This interface extends PHP's :php:`Iterator ` + interface. An instance of this interface is returned by + :phpmethod:`MongoDB\\Client::listDatabases()`. + +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 diff --git a/docs/reference/class/MongoDBModelIndexInfo.txt b/docs/reference/class/MongoDBModelIndexInfo.txt new file mode 100644 index 000000000..8b9c42c85 --- /dev/null +++ b/docs/reference/class/MongoDBModelIndexInfo.txt @@ -0,0 +1,51 @@ +=============================== +MongoDB\\Model\\IndexInfo Class +=============================== + +Definition +---------- + +.. 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()`. + + This class implements PHP's :php:`ArrayAccess ` interface. This + provides a mechanism for accessing index fields for which there exists no + helper method. :php:`isset() ` may be used to check for the existence + of a field before accessing it with ``[]``. + + .. note:: + + 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`. + +Methods +------- + +.. toctree:: + :titlesonly: + + getKey() + getName() + getNamespace() + getVersion() + is2dSphere() + isGeoHaystack() + isSparse() + isText() + 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 diff --git a/docs/reference/class/MongoDBModelIndexInfoIterator.txt b/docs/reference/class/MongoDBModelIndexInfoIterator.txt new file mode 100644 index 000000000..2b1547069 --- /dev/null +++ b/docs/reference/class/MongoDBModelIndexInfoIterator.txt @@ -0,0 +1,20 @@ +======================================= +MongoDB\\Model\\IndexInfoIterator Class +======================================= + +Definition +---------- + +.. phpclass:: MongoDB\\Model\\IndexInfoIterator + + This interface extends PHP's :php:`Iterator ` + interface. An instance of this interface is returned by + :phpmethod:`MongoDB\\Collection::listIndexes()`. + +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 diff --git a/docs/reference/class/MongoDBUpdateResult.txt b/docs/reference/class/MongoDBUpdateResult.txt new file mode 100644 index 000000000..0534980df --- /dev/null +++ b/docs/reference/class/MongoDBUpdateResult.txt @@ -0,0 +1,33 @@ +=========================== +MongoDB\\UpdateResult Class +=========================== + +Definition +---------- + +.. phpclass:: MongoDB\\UpdateResult + + This class contains information about an executed update or replace + 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()`. + +Methods +------- + +.. toctree:: + :titlesonly: + + getMatchedCount() + getModifiedCount() + getUpsertedCount() + 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 diff --git a/docs/reference/enumeration-classes.txt b/docs/reference/enumeration-classes.txt deleted file mode 100644 index bb2a629a8..000000000 --- a/docs/reference/enumeration-classes.txt +++ /dev/null @@ -1,193 +0,0 @@ -=================== -Enumeration Classes -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -MongoDB\\Model\\CollectionInfo ------------------------------- - -Definition -~~~~~~~~~~ - -.. 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()`. - -.. versionchanged:: 1.4 - - This class implements PHP's :php:`ArrayAccess ` interface. This - provides a mechanism for accessing index fields for which there exists no - helper method. :php:`isset() ` may be used to check for the existence - of a field before accessing it with ``[]``. - - .. note:: - - 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`. - -Methods -~~~~~~~ - -.. toctree:: - :titlesonly: - - /reference/method/MongoDBModelCollectionInfo-getCappedMax - /reference/method/MongoDBModelCollectionInfo-getCappedSize - /reference/method/MongoDBModelCollectionInfo-getIdIndex - /reference/method/MongoDBModelCollectionInfo-getInfo - /reference/method/MongoDBModelCollectionInfo-getName - /reference/method/MongoDBModelCollectionInfo-getOptions - /reference/method/MongoDBModelCollectionInfo-getType - /reference/method/MongoDBModelCollectionInfo-isCapped - ----- - -MongoDB\\Model\\CollectionInfoIterator --------------------------------------- - -Definition -~~~~~~~~~~ - -.. phpclass:: MongoDB\\Model\\CollectionInfoIterator - - This interface extends PHP's :php:`Iterator ` - interface. An instance of this interface is returned by - :phpmethod:`MongoDB\\Database::listCollections()`. - -Methods -~~~~~~~ - -This interface adds no new methods to :php:`Iterator -`, but specifies that :php:`current() -` will return an instance of -:phpclass:`MongoDB\\Model\\CollectionInfo`. - ----- - -MongoDB\\Model\\DatabaseInfo ----------------------------- - -Definition -~~~~~~~~~~ - -.. 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()`. - -.. versionchanged:: 1.4 - - This class implements PHP's :php:`ArrayAccess ` interface. This - provides a mechanism for accessing index fields for which there exists no - helper method. :php:`isset() ` may be used to check for the existence - of a field before accessing it with ``[]``. - - .. note:: - - 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`. - -Methods -~~~~~~~ - -.. toctree:: - :titlesonly: - - /reference/method/MongoDBModelDatabaseInfo-getName - /reference/method/MongoDBModelDatabaseInfo-getSizeOnDisk - /reference/method/MongoDBModelDatabaseInfo-isEmpty - ----- - -MongoDB\\Model\\DatabaseInfoIterator ------------------------------------- - -Definition -~~~~~~~~~~ - -.. phpclass:: MongoDB\\Model\\DatabaseInfoIterator - - This interface extends PHP's :php:`Iterator ` - interface. An instance of this interface is returned by - :phpmethod:`MongoDB\\Client::listDatabases()`. - -Methods -~~~~~~~ - -This interface adds no new methods to :php:`Iterator -`, but specifies that :php:`current() -` will return an instance of -:phpclass:`MongoDB\\Model\\DatabaseInfo`. - ----- - -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()`. - - This class implements PHP's :php:`ArrayAccess ` interface. This - provides a mechanism for accessing index fields for which there exists no - helper method. :php:`isset() ` may be used to check for the existence - of a field before accessing it with ``[]``. - - .. note:: - - 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`. - -Methods -~~~~~~~ - -.. toctree:: - :titlesonly: - - /reference/method/MongoDBModelIndexInfo-getKey - /reference/method/MongoDBModelIndexInfo-getName - /reference/method/MongoDBModelIndexInfo-getNamespace - /reference/method/MongoDBModelIndexInfo-getVersion - /reference/method/MongoDBModelIndexInfo-is2dSphere - /reference/method/MongoDBModelIndexInfo-isGeoHaystack - /reference/method/MongoDBModelIndexInfo-isSparse - /reference/method/MongoDBModelIndexInfo-isText - /reference/method/MongoDBModelIndexInfo-isTtl - /reference/method/MongoDBModelIndexInfo-isUnique - ----- - -MongoDB\\Model\\IndexInfoIterator ---------------------------------- - -Definition -~~~~~~~~~~ - -.. phpclass:: MongoDB\\Model\\IndexInfoIterator - - This interface extends PHP's :php:`Iterator ` - interface. An instance of this interface is returned by - :phpmethod:`MongoDB\\Collection::listIndexes()`. - -Methods -~~~~~~~ - -This interface adds no new methods to :php:`Iterator -`, but specifies that :php:`current() -` will return an instance of -:phpclass:`MongoDB\\Model\\IndexInfo`. diff --git a/docs/reference/functions.txt b/docs/reference/functions.txt index 4ce49e3f9..ca1aadf33 100644 --- a/docs/reference/functions.txt +++ b/docs/reference/functions.txt @@ -13,4 +13,6 @@ Functions .. toctree:: :titlesonly: - /reference/function/with_transaction + with_transaction() + +- :phpmethod:`MongoDB\\with_transaction()` diff --git a/docs/reference/method/MongoDBCollection-mapReduce.txt b/docs/reference/method/MongoDBCollection-mapReduce.txt index 1cb66f357..9081c36c0 100644 --- a/docs/reference/method/MongoDBCollection-mapReduce.txt +++ b/docs/reference/method/MongoDBCollection-mapReduce.txt @@ -1,6 +1,6 @@ -================================= +================================ MongoDB\\Collection::mapReduce() -================================= +================================ .. deprecated:: 1.12 diff --git a/docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt b/docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt index b77f1f00c..77303b92a 100644 --- a/docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt +++ b/docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt @@ -1,6 +1,6 @@ -========================================= -MongoDB\\GridFS\Bucket::getWriteConcern() -========================================= +========================================== +MongoDB\\GridFS\\Bucket::getWriteConcern() +========================================== .. versionadded:: 1.2 diff --git a/docs/reference/result-classes.txt b/docs/reference/result-classes.txt index 3371c137e..db5ff7590 100644 --- a/docs/reference/result-classes.txt +++ b/docs/reference/result-classes.txt @@ -4,73 +4,19 @@ Result Classes .. default-domain:: mongodb -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -MongoDB\\ChangeStream ---------------------- - -.. versionadded:: 1.3 - -Definition -~~~~~~~~~~ - -.. 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()`. - - 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 - failover. - -Methods -~~~~~~~ - -.. toctree:: - :titlesonly: - - /reference/method/MongoDBChangeStream-current - /reference/method/MongoDBChangeStream-getCursorId - /reference/method/MongoDBChangeStream-getResumeToken - /reference/method/MongoDBChangeStream-key - /reference/method/MongoDBChangeStream-next - /reference/method/MongoDBChangeStream-rewind - /reference/method/MongoDBChangeStream-valid - ----- - -MongoDB\\MapReduceResult ------------------------- - -.. versionadded:: 1.2 - -Definition -~~~~~~~~~~ - -.. phpclass:: MongoDB\\MapReduceResult - - This class extends PHP's :php:`IteratorAggregate ` - interface. An instance of this class is returned by - :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 - statistics. - -Methods -~~~~~~~ - .. toctree:: :titlesonly: - /reference/method/MongoDBMapReduceResult-getCounts - /reference/method/MongoDBMapReduceResult-getExecutionTimeMS - /reference/method/MongoDBMapReduceResult-getIterator - /reference/method/MongoDBMapReduceResult-getTiming + BulkWriteResult Class + DeleteResult Class + InsertManyResult Class + InsertOneResult Class + UpdateResult Class + ChangeStream Class + MapReduceResult Class + CollectionInfo Class + CollectionInfoIterator Class + DatabaseInfo Class + DatabaseInfoIterator Class + IndexInfo Class + IndexInfoIterator Class \ No newline at end of file diff --git a/docs/reference/write-result-classes.txt b/docs/reference/write-result-classes.txt deleted file mode 100644 index f410c0834..000000000 --- a/docs/reference/write-result-classes.txt +++ /dev/null @@ -1,143 +0,0 @@ -==================== -Write Result Classes -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -MongoDB\\BulkWriteResult ------------------------- - -Definition -~~~~~~~~~~ - -.. 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()`. - -Methods -~~~~~~~ - -.. toctree:: - :titlesonly: - - /reference/method/MongoDBBulkWriteResult-getDeletedCount - /reference/method/MongoDBBulkWriteResult-getInsertedCount - /reference/method/MongoDBBulkWriteResult-getInsertedIds - /reference/method/MongoDBBulkWriteResult-getMatchedCount - /reference/method/MongoDBBulkWriteResult-getModifiedCount - /reference/method/MongoDBBulkWriteResult-getUpsertedCount - /reference/method/MongoDBBulkWriteResult-getUpsertedIds - /reference/method/MongoDBBulkWriteResult-isAcknowledged - ----- - -MongoDB\\DeleteResult ---------------------- - -Definition -~~~~~~~~~~ - -.. 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()`. - -Methods -~~~~~~~ - -.. toctree:: - :titlesonly: - - /reference/method/MongoDBDeleteResult-getDeletedCount - /reference/method/MongoDBDeleteResult-isAcknowledged - ----- - -MongoDB\\InsertManyResult -------------------------- - -Definition -~~~~~~~~~~ - -.. 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()`. - -Methods -~~~~~~~ - -.. toctree:: - :titlesonly: - - /reference/method/MongoDBInsertManyResult-getInsertedCount - /reference/method/MongoDBInsertManyResult-getInsertedIds - /reference/method/MongoDBInsertManyResult-isAcknowledged - ----- - -MongoDB\\InsertOneResult ------------------------- - -Definition -~~~~~~~~~~ - -.. 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()`. - -Methods -~~~~~~~ - -.. toctree:: - :titlesonly: - - /reference/method/MongoDBInsertOneResult-getInsertedCount - /reference/method/MongoDBInsertOneResult-getInsertedId - /reference/method/MongoDBInsertOneResult-isAcknowledged - ----- - -MongoDB\\UpdateResult ---------------------- - -Definition -~~~~~~~~~~ - -.. phpclass:: MongoDB\\UpdateResult - - This class contains information about an executed update or replace - 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()`. - -Methods -~~~~~~~ - -.. toctree:: - :titlesonly: - - /reference/method/MongoDBUpdateResult-getMatchedCount - /reference/method/MongoDBUpdateResult-getModifiedCount - /reference/method/MongoDBUpdateResult-getUpsertedCount - /reference/method/MongoDBUpdateResult-getUpsertedId - /reference/method/MongoDBUpdateResult-isAcknowledged