Home/ Manual/ pdo / pdo/ PDO::getAttribute

PDO::getAttribute

PHP function Edit on GitHub ✎

(PHP 5 >= 5.1.0, PHP 7, PHP 8, PECL pdo >= 0.2.0)

Retrieve a database connection attribute

Description

PDO::getAttribute(int $attribute): mixed

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 generic attributes that apply to database connections are as follows:

PDO::ATTR_CASE
PDO::ATTR_DEFAULT_FETCH_MODE
PDO::ATTR_DRIVER_NAME
PDO::ATTR_ERRMODE
PDO::ATTR_ORACLE_NULLS
PDO::ATTR_PERSISTENT
PDO::ATTR_STATEMENT_CLASS
PDO::ATTR_STRINGIFY_FETCHES

Some drivers may make use of additional driver specific attributes. Note that driver specific attributes must not be used with other drivers.

Return Values

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

Errors/Exceptions

PDO::getAttribute may throw a PDOException when the underlying driver does not support the requested attribute.

Changelog

Version	Description
8.4.0	It is now possible to fetch the value of the `PDO::ATTR_STRINGIFY_FETCHES` attribute.

Examples

Retrieving database connection attributes

php

<?php
$conn = new PDO('odbc:sample', 'db2inst1', 'ibmdb2');
$attributes = array(
    "AUTOCOMMIT", "ERRMODE", "CASE", "CLIENT_VERSION", "CONNECTION_STATUS",
    "ORACLE_NULLS", "PERSISTENT", "PREFETCH", "SERVER_INFO", "SERVER_VERSION",
    "TIMEOUT"
);

foreach ($attributes as $val) {
    echo "PDO::ATTR_$val: ";
    echo $conn->getAttribute(constant("PDO::ATTR_$val")) . "\n";
}
?>