PDOStatement::getColumnMeta

PHP PDO 参考手册PHP PDO リファレンスマニュアル

PDOStatement::getColumnMeta — 結果セット内の1列のメタデータを返す(PHP 5 >= 5.1.0, PECL pdo >= 0.2.0)


説明

構文

array PDOStatement::getColumnMeta ( int $column )

結果セット内の0から始まるインデックスを持つ列のメタデータを連想配列として取得します。

注意:この関数は実験的なものです。この関数の挙動、名前、および関連ドキュメントは、将来のPHPリリースで予告なく変更される可能性があります。この関数の使用は自己責任です。

注意:すべての PDO ドライバが PDOStatement::getColumnMeta() をサポートしているわけではありません。


パラメータ

column
結果セット内の0から始まるインデックスの列。


戻り値

単一の列のメタデータを表す以下の値を含む連想配列を返します。

列のメタデータ
名前 值
native_type 列の値を表すために使用される PHP ネイティブ型。
driver:decl_type データベース内で列の値を表すために使用される SQL 型。結果セットの列が関数の結果である場合、この値はPDOStatement::getColumnMeta()返されません。
flags この列に設定されたすべてのフラグ。
name データベースから返される列名。
table データベースから返される、この列のテーブル名。
len この列の長さ。浮動小数点数以外の場合は通常-1
precision この列の数値精度。浮動小数点数以外の場合は通常0 。
pdo_type 以 PDO::PARAM_*定数で表される列の型。

例

列のメタデータを取得する

次の例は、PDO_SQLITE において関数(COUNT)によって生成された単一の列のメタデータを取得した結果を示しています。

<?php
$select = $DB->query('SELECT COUNT(*) FROM fruit');
$meta = $select->getColumnMeta(0);
var_dump($meta);
?>

上の例の出力は次のとおりです。

array(6) {
  ["native_type"]=>
  string(7) "integer"
  ["flags"]=>
  array(0) {
  }
  ["name"]=>
  string(8) "COUNT(*)"
  ["len"]=>
  int(-1)
  ["precision"]=>
  int(0)
  ["pdo_type"]=>
  int(2)
}

PHP PDO 参考手册PHP PDO リファレンスマニュアル

その他の拡張モジュール