Update renameCollection documentation

Author: tanlisu

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

@@ -19,8 +19,8 @@ arg_name: option
 name: dropTarget
 type: boolean
 description: |
-  If ``true``, ``mongod`` will drop the ``target`` of ``renameCollection`` prior
-  to renaming the collection. The default value is ``false``.
+  If ``true``, MongoDB will drop the target before renaming the collection. The
+  default value is ``false``.
 interface: phpmethod
 operation: ~
 optional: true

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

@@ -1,14 +1,27 @@
 arg_name: param
-name: $toNamespace
+name: $toCollectionName
 type: string
 description: |
-  The new namespace of the collection. If the new namespace specifies a
-  different database, the command copies the collection to the new database
-  and drops the source collection.
+  The new name of the collection. If a full namespace is not
+  specified, the database of the original collection will be used. If the new
+  namespace specifies a different database, the command copies the collection
+  to the new database and drops the source collection.
 interface: phpmethod
 operation: ~
 optional: false
 ---
+arg_name: param
+name: $toDatabaseName
+type: string
+description: |
+  The new database name of the collection. If a new database name is not
+  specified, the database of the original collection will be used. If the new
+  name specifies a different database, the command copies the collection
+  to the new database and drops the source collection.
+interface: phpmethod
+operation: ~
+optional: true
+---
 source:
   file: apiargs-common-param.yaml
   ref: $options

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

@@ -19,8 +19,8 @@ arg_name: option
 name: dropTarget
 type: boolean
 description: |
-  If ``true``, ``mongod`` will drop the ``target`` of ``renameCollection`` prior
-  to renaming the collection. The default value is ``false``.
+  If ``true``, MongoDB will drop the target before renaming the collection. The
+  default value is ``false``.
 interface: phpmethod
 operation: ~
 optional: true

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

@@ -1,14 +1,32 @@
-source:
-  file: apiargs-common-param.yaml
-  ref: $fromNamespace
-replacement:
-  action: " to rename"
+arg_name: param
+name: $fromCollectionName
+type: string
+description: |
+  The name of the collection to rename.
+interface: phpmethod
+operation: ~
+optional: false
 ---
-source:
-  file: apiargs-common-param.yaml
-  ref: $toNamespace
-replacement:
-  action: ""
+arg_name: param
+name: $toCollectionName
+type: string
+description: |
+  The new name of the collection.
+interface: phpmethod
+operation: ~
+optional: false
+---
+arg_name: param
+name: $toDatabaseName
+type: string
+description: |
+  The new database name of the collection. If a new database name is not
+  specified, the current database will be used. If the new name specifies a
+  different database, the command copies the collection to the new database
+  and drops the source collection.
+interface: phpmethod
+operation: ~
+optional: true
 ---
 source:
   file: apiargs-common-param.yaml

docs/reference/class/MongoDBCollection.txt

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

docs/reference/method/MongoDBCollection-rename.txt

@@ -2,6 +2,8 @@
 MongoDB\\Collection::rename()
 =============================
 
+.. versionadded:: 1.9
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
@@ -19,7 +21,7 @@ Definition
 
    .. code-block:: php
 
-      function rename(string $toNamespace, array $options = []): array|object
+      function rename(string $toCollectionName, ?string $toDatabaseName = null, array $options = []): array|object
 
    This method has the following parameters:
 
@@ -55,7 +57,7 @@ database to ``places``:
 
    $collection = (new MongoDB\Client)->test->restaurants;
 
-   $result = $collection->renameCollection('places');
+   $result = $collection->rename('places');
 
    var_dump($result);
 

docs/reference/method/MongoDBDatabase-renameCollection.txt

@@ -1,6 +1,8 @@
-===================================
+=====================================
 MongoDB\\Database::renameCollection()
-===================================
+=====================================
+
+.. versionadded:: 1.9
 
 .. default-domain:: mongodb
 
@@ -15,11 +17,11 @@ Definition
 
 .. phpmethod:: MongoDB\\Database::renameCollection()
 
-   Changes the name of an existing collection.
+   Rename a collection within the current database.
 
    .. code-block:: php
 
-      function renameCollection($fromNamespace, $toNamespace, array $options = []): array|object
+      function renameCollection(string $fromCollectionName, string $toCollectionName, ?string $toDatabaseName = null, array $options = []): array|object
 
    This method has the following parameters:
 
@@ -46,15 +48,16 @@ Errors/Exceptions
 Example
 -------
 
-The following example renames the ``users`` collection in the ``test`` database:
+The following example renames the ``restaurants`` collection in the ``test``
+database to ``places``:
 
 .. code-block:: php
 
    <?php
 
    $db = (new MongoDB\Client)->test;
 
-   $result = $db->renameCollection('users', 'restaurants');
+   $result = $db->renameCollection('restaurants', 'places');
 
    var_dump($result);