PHP: Hypertext Preprocessor (original) (raw)

Connections and Connection management

Connections are established by creating instances of the PDO base class. It doesn't matter which driver you want to use; you always use the PDO class name. The constructor accepts parameters for specifying the database source (known as the DSN) and optionally for the username and password (if any).

Example #1 Connecting to MySQL

<?php <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>d</mi><mi>b</mi><mi>h</mi><mo>=</mo><mi>n</mi><mi>e</mi><mi>w</mi><mi>P</mi><mi>D</mi><mi>O</mi><msup><mo stretchy="false">(</mo><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mi>m</mi><mi>y</mi><mi>s</mi><mi>q</mi><mi>l</mi><mo>:</mo><mi>h</mi><mi>o</mi><mi>s</mi><mi>t</mi><mo>=</mo><mi>l</mi><mi>o</mi><mi>c</mi><mi>a</mi><mi>l</mi><mi>h</mi><mi>o</mi><mi>s</mi><mi>t</mi><mo separator="true">;</mo><mi>d</mi><mi>b</mi><mi>n</mi><mi>a</mi><mi>m</mi><mi>e</mi><mo>=</mo><mi>t</mi><mi>e</mi><mi>s</mi><msup><mi>t</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mo separator="true">,</mo></mrow><annotation encoding="application/x-tex">dbh = new PDO('mysql:host=localhost;dbname=test', </annotation></semantics></math>dbh=newPDO(′mysql:host=localhost;dbname=test′,user, $pass); ?>

If there are any connection errors, a PDOException object will be thrown. You may catch the exception if you want to handle the error condition, or you may opt to leave it for an application global exception handler that you set up viaset_exception_handler().

Example #2 Handling connection errors

<?php try { <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>d</mi><mi>b</mi><mi>h</mi><mo>=</mo><mi>n</mi><mi>e</mi><mi>w</mi><mi>P</mi><mi>D</mi><mi>O</mi><msup><mo stretchy="false">(</mo><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mi>m</mi><mi>y</mi><mi>s</mi><mi>q</mi><mi>l</mi><mo>:</mo><mi>h</mi><mi>o</mi><mi>s</mi><mi>t</mi><mo>=</mo><mi>l</mi><mi>o</mi><mi>c</mi><mi>a</mi><mi>l</mi><mi>h</mi><mi>o</mi><mi>s</mi><mi>t</mi><mo separator="true">;</mo><mi>d</mi><mi>b</mi><mi>n</mi><mi>a</mi><mi>m</mi><mi>e</mi><mo>=</mo><mi>t</mi><mi>e</mi><mi>s</mi><msup><mi>t</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mo separator="true">,</mo></mrow><annotation encoding="application/x-tex">dbh = new PDO('mysql:host=localhost;dbname=test', </annotation></semantics></math>dbh=newPDO(′mysql:host=localhost;dbname=test′,user, $pass); } catch (PDOException $e) { // attempt to retry the connection after some timeout for example }

Warning

Just like any other exception,PDOException could be caught either explicitly, via a catch statement, or implicitly via set_exception_handler(). Otherwise, the default behaviour of converting an uncaught exception to a**E_FATAL_ERROR** will occur. The fatal error will contain a backtrace that can leak connection details. As such, the php.ini optiondisplay_errors should be set to 0 on a production server.

Upon successful connection to the database, an instance of the PDO class is returned to your script. The connection remains active for the lifetime of that PDO object. To close the connection, you need to destroy the object by ensuring that all remaining references to it are deleted—you do this by assigning [null](reserved.constants.php#constant.null) to the variable that holds the object. If you don't do this explicitly, PHP will automatically close the connection when your script ends.

Note: If there are still other references to this PDO instance (such as from a PDOStatement instance, or from other variables referencing the same PDO instance), these have to be removed also (for instance, by assigning [null](reserved.constants.php#constant.null) to the variable that references the PDOStatement).

Example #3 Closing a connection

Many web applications will benefit from making persistent connections to database servers. Persistent connections are not closed at the end of the script, but are cached and re-used when another script requests a connection using the same credentials. The persistent connection cache allows you to avoid the overhead of establishing a new connection every time a script needs to talk to a database, resulting in a faster web application.

Example #4 Persistent connections

The value of the [PDO::ATTR_PERSISTENT](pdo.constants.php#pdo.constants.attr-persistent) option is converted to bool (enable/disable persistent connections), unless it is a non-numericstring, in which case it allows to use multiple persistent connection pools. This is useful if different connections use incompatible settings, for instance, different values of [PDO::MYSQL_ATTR_USE_BUFFERED_QUERY](ref.pdo-mysql.php#pdo.constants.mysql-attr-use-buffered-query).

Note:

If you wish to use persistent connections, you must set**[PDO::ATTR_PERSISTENT](pdo.constants.php#pdo.constants.attr-persistent)** in the array of driver options passed to the PDO constructor. If setting this attribute withPDO::setAttribute() after instantiation of the object, the driver will not use persistent connections.

Note:

If you're using the PDO ODBC driver and your ODBC libraries support ODBC Connection Pooling (unixODBC and Windows are two that do; there may be more), then it's recommended that you don't use persistent PDO connections, and instead leave the connection caching to the ODBC Connection Pooling layer. The ODBC Connection Pool is shared with other modules in the process; if PDO is told to cache the connection, then that connection would never be returned to the ODBC connection pool, resulting in additional connections being created to service those other modules.

Found A Problem?

There are no user contributed notes for this page.