mongoclient.close(3) php man page | unix.com

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)