Last updated: Fri, 13 Nov 2009

PDOStatement->getColumnMeta

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

PDOStatement->getColumnMeta — 結果セットのカラムに対するメタデータを返す

説明

array PDOStatement::getColumnMeta ( int $column )

警告

この関数は、 実験的 なものです。この関数の動作・名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP のリリースにおいて変更される可能性があります。この関数は自己責任で使用してください。

結果セットの 0 から始まるカラムに対するメタデータを連想配列で取得します。

警告

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

パラメータ

column: 結果セットの 0 から始まるカラムを指定します。

返り値

1つのカラムについてのメタデータに相当する次の値を含んだ連想配列を返します。

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

要求されたカラムが結果セットに存在しない、もしくは結果セットが存在しない場合、FALSE を返します。

変更履歴

バージョン	説明
5.2.3	table フィールド

例

例1 カラムのメタデータを取得する

以下の例は、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)
}

参考

PDOStatement::columnCount() - 結果セット中のカラム数を返す
PDOStatement::rowCount() - 直近の SQL ステートメントによって作用した行数を返す

add a note User Contributed Notes
PDOStatement->getColumnMeta

colin at fusionbox dot com
23-Jan-2009 06:38


This method is supported in the MySQL 5.0+ driver.  It can be used for object hydration:



<?php



$pdo_stmt = $dbh->execute('SELECT discussion.id, discussion.text, comment.id, comment.text FROM discussions LEFT JOIN comments ON comment.discussion_id = discussion.id');



foreach(range(0, $pdo_stmt->columnCount() - 1) as $column_index)

{

  $meta[] = $pdo_stmt->getColumnMeta($column_index);

}



while($row = $pdo_stmt->fetch(PDO::FETCH_NUM))

{

  foreach($row as $column_index => $column_value)

  {

    //do something with the data, using the ids to establish the discussion.has_many(comments) relationship.

  }

}



?>



If you are building an ORM, this method is very useful to support more natural SQL syntax.  Most ORMs require the column names to be aliases so that they can be parsed and turned into objects that properly represent has_one, has_many, many_to_many relationships.

asohn aircanopy net
29-Feb-2008 05:21


I found a short discussion related to this function at 

http://www.sitepoint.com/forums/showthread.php?t=497257



I haven't tried it (yet?) but hopefully someone can find it useful.

add a note

PDOStatement->nextRowset

PDOStatement->getAttribute

Last updated: Fri, 13 Nov 2009