PDO::getAttribute

データベース接続の属性を取得する

説明

public mixed PDO::getAttribute(int $attribute)

この関数はデータベース接続の属性値を返します。PDOStatement 属性を取得する場合、 PDOStatement::getAttribute を参照ください。

ドライバを問わず取得できるのは、以下に示す一般的な属性だけです。 それ以外の属性を取得できるかどうかは、ドライバ次第です。

パラメータ

attribute

PDO::ATTR_* 定数の 1 つを指定します。 以下の一般的な属性は PDO 自体が処理するので、ドライバを問わず取得できます。

  • 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

それ以外の属性は、ドライバが処理します。 そのうちどれを取得できるかは、ドライバ次第です。 ドライバが処理する属性には、 PDO::ATTR_AUTOCOMMIT、 PDO::ATTR_CLIENT_VERSION、 PDO::ATTR_CONNECTION_STATUS、 PDO::ATTR_SERVER_INFO、 PDO::ATTR_SERVER_VERSION、 PDO::ATTR_TIMEOUT などの一般的な属性と、ドライバ固有の属性が含まれます。 ドライバ固有の属性は、他のドライバでは使っては いけない ことに注意して下さい。

戻り値

要求された属性の値を返します。失敗した場合は false を返します。

PDO::ATTR_PERSISTENT のように、値そのものが false になる属性もあるため、false が返されても失敗したとは限りません。

エラー / 例外

ドライバが要求された attribute をサポートしていない場合、 PDO::getAttribute は PDOException をスローします。

変更履歴

バージョン 説明
8.4.0 PDO::ATTR_STRINGIFY_FETCHES 属性の値を 取得できるようになりました。
8.4.0 MySQL ドライバと Firebird ドライバは PDO::ATTR_AUTOCOMMIT 属性の値を、それに加えて MySQL ドライバは PDO::ATTR_EMULATE_PREPARES と PDO::MYSQL_ATTR_DIRECT_QUERY 属性の値も、 bool で返すようになりました。 これより前のバージョンでは、int で返していました。

例

例1 データベース接続の属性を取得する

<?php
$pdo = new PDO('sqlite::memory:');

$attributes = [
    'DRIVER_NAME', 'ERRMODE', 'CASE', 'ORACLE_NULLS', 'PERSISTENT',
    'CLIENT_VERSION', 'SERVER_VERSION', 'AUTOCOMMIT', 'TIMEOUT',
];

foreach ($attributes as $name) {
    try {
        $value = $pdo->getAttribute(constant("PDO::ATTR_$name"));
        echo "PDO::ATTR_$name: ", var_export($value, true), "\n";
    } catch (PDOException $e) {
        echo "PDO::ATTR_$name: ", $e->getMessage(), "\n";
    }
}
?>

上の例の出力は、 たとえば以下のようになります。

PDO::ATTR_DRIVER_NAME: 'sqlite'
PDO::ATTR_ERRMODE: 2
PDO::ATTR_CASE: 0
PDO::ATTR_ORACLE_NULLS: 0
PDO::ATTR_PERSISTENT: false
PDO::ATTR_CLIENT_VERSION: '3.46.1'
PDO::ATTR_SERVER_VERSION: '3.46.1'
PDO::ATTR_AUTOCOMMIT: SQLSTATE[IM001]: Driver does not support this function: driver does not support that attribute
PDO::ATTR_TIMEOUT: SQLSTATE[IM001]: Driver does not support this function: driver does not support that attribute

参考

  • PDO::setAttribute
  • PDOStatement::getAttribute
  • PDOStatement::setAttribute