Add documentation

Author: tanlisu

docs/includes/apiargs-MongoDBCollection-method-renameCollection-option.yaml

@@ -0,0 +1,23 @@
+source:
+  file: apiargs-MongoDBCollection-common-option.yaml
+  ref: typeMap
+post: |
+  This will be used for the returned command result document.
+---
+source:
+  file: apiargs-common-option.yaml
+  ref: session
+post: |
+  .. versionadded:: 1.3
+---
+source:
+  file: apiargs-MongoDBCollection-common-option.yaml
+  ref: writeConcern
+post: |
+  This is not supported for server versions prior to 3.4 and will result in an
+  exception at execution time if used.
+---
+source:
+  file: apiargs-MongoDBCollection-common-option.yaml
+  ref: dropTarget
+...

docs/includes/apiargs-MongoDBCollection-method-renameCollection-param.yaml

@@ -0,0 +1,13 @@
+arg_name: param
+name: $newCollectionName
+type: string
+description: |
+  The new name for this collection.
+interface: phpmethod
+operation: ~
+optional: false
+---
+source:
+  file: apiargs-common-param.yaml
+  ref: $options
+...

docs/reference/class/MongoDBCollection.txt

@@ -91,6 +91,7 @@ Methods
    /reference/method/MongoDBCollection-insertOne
    /reference/method/MongoDBCollection-listIndexes
    /reference/method/MongoDBCollection-mapReduce
+   /reference/method/MongoDBCollection-renameCollection
    /reference/method/MongoDBCollection-replaceOne
    /reference/method/MongoDBCollection-updateMany
    /reference/method/MongoDBCollection-updateOne

docs/reference/class/MongoDBDatabase.txt

@@ -59,6 +59,7 @@ Methods
    /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

docs/reference/method/MongoDBCollection-renameCollection.txt

@@ -0,0 +1,81 @@
+===========================
+MongoDB\\Collection::renameCollection()
+===========================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Definition
+----------
+
+.. phpmethod:: MongoDB\\Collection::renameCollection()
+
+   Rename the collection.
+
+   .. code-block:: php
+
+      function renameCollection(string $newCollectionName, array $options = []): array|object
+
+   This method has the following parameters:
+
+   .. include:: /includes/apiargs/MongoDBCollection-method-renameCollection-param.rst
+
+   The ``$options`` parameter supports the following options:
+
+   .. include:: /includes/apiargs/MongoDBCollection-method-renameCollection-option.rst
+
+Return Values
+-------------
+
+An array or object with the result document of the :manual:`renameCollection
+</reference/command/renameCollection>` command. The return type will depend on the
+``typeMap`` option.
+
+Errors/Exceptions
+-----------------
+
+.. include:: /includes/extracts/error-unsupportedexception.rst
+.. include:: /includes/extracts/error-invalidargumentexception.rst
+.. include:: /includes/extracts/error-driver-runtimeexception.rst
+
+Example
+-------
+
+The following operation renames the ``restaurants`` collection in the ``admin``
+database to ``zips``:
+
+.. code-block:: php
+
+   <?php
+
+   $collection = (new MongoDB\Client)->admin->restaurants;
+
+   $result = $collection->renameCollection('zips');
+
+   var_dump($result);
+
+The output would then resemble::
+
+   object(MongoDB\Model\BSONDocument)#9 (1) {
+     ["storage":"ArrayObject":private]=>
+     array(3) {
+       ["ns"]=>
+       string(16) "test.restaurants"
+       ["nIndexesWas"]=>
+       int(3)
+       ["ok"]=>
+       float(1)
+     }
+   }
+
+See Also
+--------
+
+- :phpmethod:`MongoDB\\Database::renameCollection()`
+- :manual:`renameCollection </reference/command/renameCollection>` command reference in the MongoDB
+  manual