mongoclient.close(3) [php man page]

MONGOCLIENT.CLOSE(3)							 1						      MONGOCLIENT.CLOSE(3)

MongoClient::close - Closes this connection

SYNOPSIS

       public bool MongoClient::close ([boolean|string	$connection])

DESCRIPTION

	The  MongoClient.close(3) method forcefully closes a connection to the database, even if persistent connections are being used. You should
       never have to do this under normal circumstances.

PARAMETERS

	      o $connection
		- If connection is not given, or FALSE then connection that would be selected for writes would be closed. In a single-node config-
		uration,  that	is then the whole connection, but if you are connected to a replica set, close() will only close the connection to
		the primary server.  If connection is TRUE then all connections as known by the  connection  manager  will  be	closed.  This  can
		include  connections that are not referenced in the connection string used to create the object that you are calling close on.	If
		connection is a string argument, then it will only close the connection identified by this hash. Hashes are identifiers for a con-
		nection and can be obtained by calling MongoClient.getConnections(3).

RETURN VALUES

	Returns if the connection was successfully closed.

EXAMPLES

       Example #1

	      MongoClient.close(3) example

	      This example demonstrates how to selectively close all connections for secondaries only.

	      <?php
	      // Connect to a replicaset
	      $a = new MongoClient("mongodb://whisky:13000/?replicaset=seta");

	      $connections = $a->getConnections();

	      foreach ( $connections as $con )
	      {
		  // Loop over all the connections, and when the type is "SECONDARY"
		  // we close the connection
		  if ( $con['connection']['connection_type_desc'] == "SECONDARY" )
		  {
		      echo "Closing '{$con['hash']}': ";
		      $closed = $a->close( $con['hash'] );
		      echo $closed ? "ok" : "failed", "
";
		  }
	      }
	      ?>

	      The above example will output:

	      Closing 'whisky:13001;X;4948': ok

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 1.3.0	|						    |
       |	|						    |
       |	|  The	$connection  parameter to this function was |
       |	| added in 1.3.0. Before that, only the write  con- |
       |	| nection would be closed by this method.	    |
       |	|						    |
       | 1.2.0	|						    |
       |	|						    |
       |	|  Before  version  1.2.0  the driver would not use |
       |	| persistent connections by default, and  all  con- |
       |	| nections  would  be  closed  as soon as a MongoDB |
       |	| connection went out if scope. Since version 1.2.0 |
       |	| this	is  no longer the case and it is a bad idea |
       |	| to call close as you might end up overloading the |
       |	| server with connections under high load.	    |
       |	|						    |
       +--------+---------------------------------------------------+
SEE ALSO 
MongoClient.getConnections(3).
PHP Documentation Group 												      MONGOCLIENT.CLOSE(3)

Check Out this Related Man Page

MONGOCOMMANDCURSOR.CREATEFROMDOCUMENT(3)				 1				  MONGOCOMMANDCURSOR.CREATEFROMDOCUMENT(3)

MongoCommandCursor::createFromDocument - Create a new command cursor from an existing command response document

SYNOPSIS

       publicstatic MongoCommandCursor MongoCommandCursor::createFromDocument (MongoClient  $connection, string  $hash, array  $document)

DESCRIPTION

	Use this method if you have a raw command result with cursor information in it. Note that cursors created with this method cannot be iter-
       ated multiple times, as they will lack the original command necessary for re-execution.

PARAMETERS

	      o $connection
		- Database connection.

	      o $hash
		- The connection hash, as obtained through the third by-reference argument to MongoDB::command.

	      o $document
		- Document with cursor information in it. This document needs to contain the id, ns and firstBatch  fields.  Such  a  document	is
		obtained  by  calling  the  MongoDB::command with appropriate arguments to return a cursor, and not just an inline result. See the
		example below.

RETURN VALUES

	Returns the new cursor.

EXAMPLES

       Example #1

	      MongoCommandCursor.createFromDocument(3)

	      <?php
	      $m = new MongoClient;
	      $d = $m->demo;

	      // Define the aggregation pipeline
	      $pipeline = [
		  [ '$group' => [
		      '_id' => '$country_code',
		      'timezones' => [ '$addToSet' => '$timezone' ]
		  ] ],
		  [ '$sort' => [ '_id' => 1 ] ],
	      ];

	      // Execute the command. The "cursor" option instructs the server to return
	      // cursor information in the response instead of inline results.
	      $r = $d->command(
		  [
		      'aggregate' => 'cities',
		      'pipeline' => $pipeline,
		      'cursor' => [ 'batchSize' => 1 ],
		  ],
		  null,
		  $hash
	      );

	      // Show result and hash
	      var_dump( $r, $hash );

	      // Construct the command cursor
	      $cursor = MongoCommandCursor::createFromDocument( $m, $hash, $r );
	      ?>

	      The above example will output something similar to:

	      array(2) {
		["cursor"]=>
		array(3) {
		  ["id"]=>
		  object(MongoInt64)#5(1) {
		    ["value"]=>
		    string(12) "392143983421"
		  }
		  ["ns"]=>
		  string(11) "demo.cities"
		  ["firstBatch"]=>
		  array(1) {
		    [0]=>
		    array(2) {
		      ["_id"]=>
		      string(2) "AD"
		      ["timezones"]=>
		      array(1) {
			[0]=>
			string(14) "Europe/Andorra"
		      }
		    }
		  }
		}
		["ok"]=>
		float(1)
	      }
	      string(25) "localhost:27017;-;.;17617"

	       As you can see, the returned cursor information has the id, ns and firstBatch fields.

SEE ALSO 
MongoCommandCursor.__construct(3).
PHP Documentation Group 										  MONGOCOMMANDCURSOR.CREATEFROMDOCUMENT(3)

Linux and UNIX Man Pages

mongoclient.close(3) [php man page]

Check Out this Related Man Page