PDOStatement::getColumnMeta

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

PDOStatement::getColumnMeta Devuelve las metadatos para una columna de un conjunto de resultados

Descripción

public PDOStatement::getColumnMeta(int $column): array|false

Recupera las metadatos para una columna de un conjunto de resultados en un array asociativo.

Advertencia

Algunos controladores pueden no implementar la función PDOStatement::getColumnMeta(), ya que es opcional. Sin embargo, todos los controladores PDO documentados en el manual implementan esta función.

Parámetros

column

El nombre de la columna en el conjunto de resultados.

Valores devueltos

Devuelve un array asociativo que contiene los siguientes valores representando las metadatos para una columna:

Metadatos de una columna
Nombre Valor
native_type El tipo nativo de PHP utilizado para representar el valor de la columna.
driver:decl_type El tipo SQL utilizado para representar el valor de la columna en la base de datos. Si la columna del conjunto de resultados es el resultado de una función, este valor no es devuelto por la función PDOStatement::getColumnMeta().
flags Cualquier flag definido para esta columna.
name El nombre de esta columna, como es devuelto por la base de datos.
table El nombre de la tabla de esta columna, tal como es devuelto por la base de datos.
len La longitud de esta columna. Normalmente, -1 para tipos distintos a los números decimales de punto flotante.
precision La precisión numérica para esta columna. Normalmente, 0 para tipos distintos a los números decimales de punto flotante.
pdo_type El tipo de esta columna como es representado por la constante PDO::PARAM_*.

Devuelve false si la columna solicitada no existe en el conjunto de resultados, o si no existe ningún conjunto de resultados.

Ejemplos

Ejemplo #1 Recuperación de las metadatos para una columna

El siguiente ejemplo muestra el resultado de la recuperación de las metadatos para una columna generada por una función (COUNT) en un controlador PDO_SQLITE.

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

El resultado del ejemplo sería:

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

Ver también