PDO::getAttribute

(no version information, might be only in CVS)

PDO::getAttribute --  Retrieve a database connection attribute

Description

mixed PDO::getAttribute ( int attribute )

This function returns the value of a database connection attribute. To retrieve PDOStatement attributes, refer to PDOStatement::getAttribute().

Note that some database/driver combinations may not support all of the database connection attributes.

Parameters

attribute

One of the PDO::ATTR_* constants. The constants that apply to database connections are as follows:

PDO::ATTR_AUTOCOMMIT
PDO::ATTR_CASE
PDO::ATTR_CLIENT_VERSION
PDO::ATTR_CONNECTION_STATUS
PDO::ATTR_DRIVER_NAME
PDO::ATTR_ERRMODE
PDO::ATTR_ORACLE_NULLS
PDO::ATTR_PERSISTENT
PDO::ATTR_PREFETCH
PDO::ATTR_SERVER_INFO
PDO::ATTR_SERVER_VERSION
PDO::ATTR_TIMEOUT

Return Values

A successful call returns the value of the requested PDO attribute. An unsuccessful call returns null.

Examples

Example 1. Retrieving database connection attributes

<?php
$conn
= new PDO('odbc:sample', 'db2inst1', 'ibmdb2');

print
"\nPDO::ATTR_AUTOCOMMIT: ";
print
$conn->getAttribute(PDO::ATTR_AUTOCOMMIT);

print
"\nPDO::ATTR_ERRMODE: ";
print
$conn->getAttribute(PDO::ATTR_ERRMODE);

print
"\nPDO::ATTR_CASE: ";
print
$conn->getAttribute(PDO::ATTR_CASE);

print
"\nPDO::ATTR_CLIENT_VERSION: ";
print
$conn->getAttribute(PDO::ATTR_CLIENT_VERSION);

print
"\nPDO::ATTR_CONNECTION_STATUS: ";
print
$conn->getAttribute(PDO::ATTR_CONNECTION_STATUS);

print
"\nPDO::ATTR_ORACLE_NULLS: ";
print
$conn->getAttribute(PDO::ATTR_ORACLE_NULLS);

print
"\nPDO::ATTR_PERSISTENT: ";
print
$conn->getAttribute(PDO::ATTR_PERSISTENT);

print
"\nPDO::ATTR_PREFETCH: ";
print
$conn->getAttribute(PDO::ATTR_PREFETCH);

print
"\nPDO::ATTR_SERVER_INFO: ";
print
$conn->getAttribute(PDO::ATTR_SERVER_INFO);

print
"\nPDO::ATTR_SERVER_VERSION: ";
print
$conn->getAttribute(PDO::ATTR_SERVER_VERSION);

print
"\nPDO::ATTR_TIMEOUT: ";
print
$conn->getAttribute(PDO::ATTR_TIMEOUT);
?>

See Also

PDO::setAttribute()
PDOStatement::getAttribute()
PDOStatement::setAttribute()