array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.db2-close.php', 1 => 'db2_close', 2 => 'Closes a database connection', ), 'up' => array ( 0 => 'ref.ibm-db2.php', 1 => 'IBM DB2 Functions', ), 'prev' => array ( 0 => 'function.db2-client-info.php', 1 => 'db2_client_info', ), 'next' => array ( 0 => 'function.db2-column-privileges.php', 1 => 'db2_column_privileges', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/ibm_db2/functions/db2-close.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

db2_close

(PECL ibm_db2 >= 1.0.0)

db2_close — Closes a database connection

Description

db2_close(resource $connection): bool

This function closes a DB2 client connection created with db2_connect() and returns the corresponding resources to the database server.

If you attempt to close a persistent DB2 client connection created with db2_pconnect(), the close request is ignored and the persistent DB2 client connection remains available for the next caller.

Parameters

connection
Specifies an active DB2 client connection.

Return Values

Returns true on success or false on failure.

Examples

Example #1 Closing a connection

The following example demonstrates a successful attempt to close a connection to an IBM DB2, Cloudscape, or Apache Derby database.

<?php
$conn = db2_connect('SAMPLE', 'db2inst1', 'ibmdb2');
$rc = db2_close($conn);
if ($rc) {
echo "Connection was successfully closed.";
}
?>

The above example will output:

Connection was successfully closed.

See Also