DOCSP-44002: v2 void return types

Author: rustagir

source/includes/databases-collections/databases-collections.php

@@ -30,7 +30,7 @@
 
 // Explicitly creates the "example_collection" collection
 // start-create-collection
-$result = $client->test_database->createCollection('example_collection');
+$client->test_database->createCollection('example_collection');
 // end-create-collection
 
 // Lists the collections in the "test_database" database

source/includes/databases-collections/time-series.php

@@ -16,7 +16,7 @@
     ]
 ];
 
-$collection = $db->createCollection('sept2023', $options);
+$db->createCollection('sept2023', $options);
 // end-create-ts
 
 // Lists the collections in the "precipitation" database

source/includes/read/cursor.php

@@ -32,7 +32,7 @@
 // Creates a collection with a maximum size and inserts documents representing vegetables
 // start-capped-coll
 $db = $client->db;
-$create_coll = $db->createCollection(
+$db->createCollection(
     'vegetables', 
     ['capped' => true, 'size' => 1024 * 1024]
 );

source/indexes/index-mgmt.txt

@@ -127,9 +127,6 @@ You can delete all indexes by calling the
    :end-before: end-remove-all-indexes
    :dedent:
 
-The ``dropIndexes()`` method returns information about the number of
-indexes removed and a success message.
-
 API Documentation
 ~~~~~~~~~~~~~~~~~
 

source/reference/method/MongoDBClient-dropDatabase.txt

@@ -2,8 +2,6 @@
 MongoDB\\Client::dropDatabase()
 ===============================
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -19,7 +17,7 @@ Definition
 
    .. code-block:: php
 
-      function dropDatabase(string $databaseName, array $options = []): array|object
+      function dropDatabase(string $databaseName, array $options = []): void
 
 Parameters
 ----------
@@ -62,13 +60,6 @@ Parameters
        - :php:`MongoDB\Driver\WriteConcern <class.mongodb-driver-writeconcern>`
        - .. include:: /includes/extracts/client-option-writeConcern.rst
 
-Return Values
--------------
-
-An array or object with the result document of the :manual:`dropDatabase
-</reference/command/dropDatabase>` command. The return type will depend on the
-``typeMap`` option.
-
 Errors/Exceptions
 -----------------
 
@@ -87,23 +78,7 @@ The following example drops the ``test`` database:
 
    $client = new MongoDB\Client;
 
-   $result = $client->dropDatabase('test');
-
-   var_dump($result);
-
-The output would then resemble:
-
-.. code-block:: none
-
-   object(MongoDB\Model\BSONDocument)#8 (1) {
-     ["storage":"ArrayObject":private]=>
-     array(2) {
-       ["dropped"]=>
-       string(4) "test"
-       ["ok"]=>
-       float(1)
-     }
-   }
+   $client->dropDatabase('test');
 
 See Also
 --------

source/reference/method/MongoDBCollection-drop.txt

@@ -19,7 +19,7 @@ Definition
 
    .. code-block:: php
 
-      function drop(array $options = []): array|object
+      function drop(array $options = []): void
 
 Parameters
 ----------
@@ -79,15 +79,6 @@ Parameters
 
          .. include:: /includes/extracts/common-option-writeConcern-transaction.rst
 
-
-
-Return Values
--------------
-
-An array or object with the result document of the :manual:`drop
-</reference/command/drop>` command. The return type will depend on the
-``typeMap`` option.
-
 Errors/Exceptions
 -----------------
 
@@ -107,25 +98,7 @@ database:
 
    $collection = (new MongoDB\Client)->test->restaurants;
 
-   $result = $collection->drop();
-
-   var_dump($result);
-
-The output would then resemble:
-
-.. code-block:: none
-
-   object(MongoDB\Model\BSONDocument)#9 (1) {
-     ["storage":"ArrayObject":private]=>
-     array(3) {
-       ["ns"]=>
-       string(16) "test.restaurants"
-       ["nIndexesWas"]=>
-       int(3)
-       ["ok"]=>
-       float(1)
-     }
-   }
+   $collection->drop();
 
 See Also
 --------

source/reference/method/MongoDBCollection-dropIndex.txt

@@ -2,8 +2,6 @@
 MongoDB\\Collection::dropIndex()
 ================================
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -22,7 +20,7 @@ Definition
       function dropIndex(
           string|MongoDB\Model\IndexInfo $indexName,
           array $options = []
-      ): array|object
+      ): void
 
 Parameters
 ----------
@@ -74,13 +72,6 @@ Parameters
 
          .. include:: /includes/extracts/common-option-writeConcern-transaction.rst
 
-Return Values
--------------
-
-An array or object with the result document of the :manual:`dropIndexes
-</reference/command/dropIndexes>` command. The return type will depend on the
-``typeMap`` option.
-
 Errors/Exceptions
 -----------------
 
@@ -100,23 +91,7 @@ collection in the ``test`` database:
 
    $collection = (new MongoDB\Client)->test->restaurants;
 
-   $result = $collection->dropIndex('borough_1');
-
-   var_dump($result);
-
-The output would then resemble:
-
-.. code-block:: none
-
-   object(MongoDB\Model\BSONDocument)#9 (1) {
-     ["storage":"ArrayObject":private]=>
-     array(2) {
-       ["nIndexesWas"]=>
-       int(2)
-       ["ok"]=>
-       float(1)
-     }
-   }
+   $collection->dropIndex('borough_1');
 
 See Also
 --------

source/reference/method/MongoDBCollection-dropIndexes.txt

@@ -2,8 +2,6 @@
 MongoDB\\Collection::dropIndexes()
 ==================================
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -20,7 +18,7 @@ Definition
 
    .. code-block:: php
 
-      function dropIndexes(array $options = []): array|object
+      function dropIndexes(array $options = []): void
 
 Parameters
 ----------
@@ -72,13 +70,6 @@ Parameters
 
          .. include:: /includes/extracts/common-option-writeConcern-transaction.rst
 
-Return Values
--------------
-
-An array or object with the result document of the :manual:`dropIndexes
-</reference/command/dropIndexes>` command. The return type will depend on the
-``typeMap`` option.
-
 Errors/Exceptions
 -----------------
 
@@ -98,25 +89,7 @@ The following drops all indexes from the ``restaurants`` collection in the
 
    $collection = (new MongoDB\Client)->test->restaurants;
 
-   $result = $collection->dropIndexes();
-
-   var_dump($result);
-
-The output would then resemble:
-
-.. code-block:: none
-
-   object(MongoDB\Model\BSONDocument)#9 (1) {
-     ["storage":"ArrayObject":private]=>
-     array(3) {
-       ["nIndexesWas"]=>
-       int(3)
-       ["msg"]=>
-       string(38) "non-_id indexes dropped for collection"
-       ["ok"]=>
-       float(1)
-     }
-   }
+   $collection->dropIndexes();
 
 See Also
 --------

source/reference/method/MongoDBCollection-dropSearchIndex.txt

@@ -4,8 +4,6 @@ MongoDB\\Collection::dropSearchIndex()
 
 .. versionadded:: 1.17
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none

source/reference/method/MongoDBCollection-rename.txt

@@ -4,8 +4,6 @@ MongoDB\\Collection::rename()
 
 .. versionadded:: 1.10
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -25,7 +23,7 @@ Definition
           string $toCollectionName,
           ?string $toDatabaseName = null,
           array $options = []
-      ): array|object
+      ): void
 
 Parameters
 ----------
@@ -79,13 +77,6 @@ Parameters
 
          .. include:: /includes/extracts/common-option-writeConcern-transaction.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
 -----------------
 
@@ -105,21 +96,7 @@ database to ``places``:
 
    $collection = (new MongoDB\Client)->test->restaurants;
 
-   $result = $collection->rename('places');
-
-   var_dump($result);
-
-The output would then resemble:
-
-.. code-block:: none
-
-   object(MongoDB\Model\BSONDocument)#9 (1) {
-     ["storage":"ArrayObject":private]=>
-     array(1) {
-       ["ok"]=>
-       float(1)
-     }
-   }
+   $collection->rename('places');
 
 See Also
 --------