PDOStatement::fetch

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

PDOStatement::fetch — Recupera la siguiente línea de un conjunto de resultados PDO

Descripción

public PDOStatement::fetch(int $mode = PDO::FETCH_DEFAULT, int $cursorOrientation = PDO::FETCH_ORI_NEXT, int $cursorOffset = 0): mixed

Recupera una línea desde un conjunto de resultados asociado al objeto PDOStatement. El argumento mode determina la forma en que PDO devuelve la línea.

Parámetros

mode

Controla cómo se devolverá la siguiente línea al llamante. Este valor debe ser una de las constantes PDO::FETCH_*, y por omisión, vale la constante PDO::ATTR_DEFAULT_FETCH_MODE (que por omisión vale la constante PDO::FETCH_BOTH).

PDO::FETCH_ASSOC: devuelve un array indexado por el nombre de la columna como se devuelve en el conjunto de resultados
PDO::FETCH_BOTH (por omisión): devuelve un array indexado por los nombres de columnas y también por los números de columnas, comenzando en el índice 0, como se devuelve en el conjunto de resultados
PDO::FETCH_BOUND: devuelve true y asigna los valores de las columnas de su conjunto de resultados en las variables PHP a las que están vinculadas con el método PDOStatement::bindColumn()
PDO::FETCH_CLASS: devuelve una nueva instancia de la clase solicitada. El objeto se inicializa mapeando las columnas del conjunto de resultados a las propiedades de la clase. Este proceso ocurre antes de que se llame al constructor, permitiendo la población de las propiedades, independientemente de su visibilidad o de su marca como readonly. Si una propiedad no existe en la clase, se invocará el método mágico __set() si existe; de lo contrario, se creará una propiedad pública dinámica. Sin embargo, cuando PDO::FETCH_PROPS_LATE también está especificado, el constructor se llama antes de que las propiedades sean pobladas.
PDO::FETCH_INTO : actualiza una instancia existente de la clase solicitada, vinculando las columnas del conjunto de resultados a los nombres de las propiedades de la clase
PDO::FETCH_LAZY : combina PDO::FETCH_BOTH y PDO::FETCH_OBJ, y devuelve un objeto PDORow que crea los nombres de propiedad del objeto a medida que se acceden.
PDO::FETCH_NAMED : devuelve un array de la misma forma que PDO::FETCH_ASSOC, excepto que si hay múltiples columnas con los mismos nombres, el valor apuntado por esta clave será un array de todas las valores de la línea que tiene ese nombre como columna
PDO::FETCH_NUM : devuelve un array indexado por el número de la columna como se devuelve en su conjunto de resultados, comenzando en 0
PDO::FETCH_OBJ : devuelve un objeto anónimo con los nombres de propiedades que corresponden a los nombres de las columnas devueltas en el conjunto de resultados
PDO::FETCH_PROPS_LATE : cuando se usa con PDO::FETCH_CLASS, el constructor de la clase es llamado antes de que las propiedades sean asignadas a partir de los valores de columna respectivos.

cursorOrientation

Para un objeto PDOStatement que representa un cursor desplazable, este valor determina qué línea se devolverá al llamante. Este valor debe ser una de las constantes PDO::FETCH_ORI_*, y por omisión, vale PDO::FETCH_ORI_NEXT. Para solicitar un cursor desplazable para su objeto PDOStatement, debe definir el atributo PDO::ATTR_CURSOR a PDO::CURSOR_SCROLL cuando prepare la consulta SQL con la función PDO::prepare().

cursorOffset

Para un objeto PDOStatement que representa un cursor desplazable para el cual el argumento cursorOrientation está definido a PDO::FETCH_ORI_ABS, este valor especifica el número absoluto de la línea en el conjunto de resultados que debe ser recuperada.

Para un objeto PDOStatement que representa un cursor desplazable para el cual el argumento cursorOrientation está definido a PDO::FETCH_ORI_REL, este valor especifica la línea a recuperar relativamente a la posición del cursor antes de la llamada a la función PDOStatement::fetch().

Valores devueltos

El valor devuelto por esta función en caso de éxito depende del tipo recuperado. En todos los casos, false se devuelve si ocurre un error o si no hay más líneas.

Errores/Excepciones

Emite un error de nivel E_WARNING si el atributo PDO::ATTR_ERRMODE está definido a PDO::ERRMODE_WARNING.

Lanza una excepción PDOException si el atributo PDO::ATTR_ERRMODE está definido a PDO::ERRMODE_EXCEPTION.

Ejemplos

Ejemplo #1 Recuperación de líneas utilizando diferentes métodos

<?php
$sth = $dbh->prepare("SELECT nom, couleur FROM fruit");
$sth->execute();

/* estilos PDOStatement::fetch */
print "PDO::FETCH_ASSOC: ";
print "Devuelve la siguiente línea como un array indexado por el nombre de las columnas\n";
$result = $sth->fetch(PDO::FETCH_ASSOC);
print_r($result);
print "\n";

print "PDO::FETCH_BOTH: ";
print "Devuelve la siguiente línea como un array indexado por el nombre y el número de la columna\n";
$result = $sth->fetch(PDO::FETCH_BOTH);
print_r($result);
print "\n";

print "PDO::FETCH_LAZY: ";
print "Devuelve la siguiente línea como objeto PDORow con los nombres de columnas como propiedades\n";
$result = $sth->fetch(PDO::FETCH_LAZY);
print_r($result);
print "\n";

print "PDO::FETCH_OBJ: ";
print "Devuelve la siguiente línea como objeto anónimo con los nombres de columnas como propiedades\n";
$result = $sth->fetch(PDO::FETCH_OBJ);
print $result->name;
print "\n";
?>

El ejemplo anterior mostrará :

PDO::FETCH_ASSOC: Devuelve la siguiente línea como un array indexado por el nombre de las columnas
Array
(
    [nom] => apple
    [couleur] => red
)

PDO::FETCH_BOTH: Devuelve la siguiente línea como un array indexado por el nombre y el número de la columna
Array
(
    [nom] => banana
    [0] => banana
    [couleur] => yellow
    [1] => yellow
)

PDO::FETCH_LAZY: Devuelve la siguiente línea como objeto PDORow con los nombres de columnas como propiedades PDORow Object
(
    [nom] => orange
    [couleur] => orange
)

PDO::FETCH_OBJ: Devuelve la siguiente línea como objeto anónimo con los nombres de columnas como propiedades kiwi

Ejemplo #2 Recuperación de líneas con un cursor desplazable

<?php
function readDataForwards($dbh) {
    $sql = 'SELECT hand, won, bet FROM mynumbers ORDER BY BET';
    $stmt = $dbh->prepare($sql, array(PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL));
    $stmt->execute();
    while ($row = $stmt->fetch(PDO::FETCH_NUM, PDO::FETCH_ORI_NEXT)) {
        $data = $row[0] . "\t" . $row[1] . "\t" . $row[2] . "\n";
        print $data;
    }
}
function readDataBackwards($dbh) {
    $sql = 'SELECT hand, won, bet FROM mynumbers ORDER BY bet';
    $stmt = $dbh->prepare($sql, array(PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL));
    $stmt->execute();
    $row = $stmt->fetch(PDO::FETCH_NUM, PDO::FETCH_ORI_LAST);
    do {
        $data = $row[0] . "\t" . $row[1] . "\t" . $row[2] . "\n";
        print $data;
    } while ($row = $stmt->fetch(PDO::FETCH_NUM, PDO::FETCH_ORI_PRIOR));
}

print "Lectura hacia adelante :\n";
readDataForwards($conn);

print "Lectura hacia atrás :\n";
readDataBackwards($conn);
?>

El ejemplo anterior mostrará :

Lectura hacia adelante :
21    10    5
16    0     5
19    20    10

Lectura hacia atrás :
19    20    10
16    0     5
21    10    5

Ejemplo #3 Orden de construcción

Cuando los objetos son recuperados mediante PDO::FETCH_CLASS, las propiedades del objeto se asignan primero, luego se llama al constructor de la clase. Sin embargo, cuando PDO::FETCH_PROPS_LATE también está especificado, este orden se invierte, es decir, el constructor se llama primero, luego las propiedades son asignadas.

<?php
class Person
{
    private $name;

    public function __construct()
    {
        $this->tell();
    }

    public function tell()
    {
        if (isset($this->name)) {
            echo "Soy {$this->name}.\n";
        } else {
            echo "Aún no tengo nombre.\n";
        }
    }
}

$sth = $dbh->query("SELECT * FROM people");
$sth->setFetchMode(PDO::FETCH_CLASS, 'Person');
$person = $sth->fetch();
$person->tell();
$sth->setFetchMode(PDO::FETCH_CLASS|PDO::FETCH_PROPS_LATE, 'Person');
$person = $sth->fetch();
$person->tell();
?>

Resultado del ejemplo anterior es similar a :

Soy Alice.
Soy Alice.
Aún no tengo nombre.
Soy Bob.

Ver también

PDO::prepare() - Prepara una consulta para su ejecución y devuelve un objeto
PDOStatement::execute() - Ejecuta una consulta preparada
PDOStatement::fetchAll() - Recupera las líneas restantes de un conjunto de resultados
PDOStatement::fetchColumn() - Devuelve una columna de la siguiente fila de un conjunto de resultados
PDOStatement::fetchObject() - Recupera la siguiente línea y la devuelve como objeto
PDOStatement::setFetchMode() - Establece el modo de recuperación por defecto para esta consulta

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 22 notes

down

terry at bitsoup dot com ¶

19 years ago

WARNING:
fetch() does NOT adhere to SQL-92 SQLSTATE standard when dealing with empty datasets.

Instead of setting the errorcode class to 20 to indicate "no data found", it returns a class of 00 indicating success, and returns NULL to the caller.

This also prevents the exception mechainsm from firing.

Programmers will need to explicitly code tests for empty resultsets after any fetch*() instead of relying on the default behavior of the RDBMS.

I tried logging this as a bug, but it was dismissed as "working as intended". Just a head's up.

down

yarco dot wang at gmail dot com ¶

11 years ago

If no record, this function will also return false.
I think that is not very good...

down

henry at henrysmith dot org ¶

13 years ago

Someone's already pointed out that PDO::CURSOR_SCROLL isn't supported by the SQLite driver. It's also worth noting that it's not supported by the MySQL driver either.

In fact, if you try to use scrollable cursors with a MySQL statement, the PDO::FETCH_ORI_ABS parameter and the offset given to fetch() will be silently ignored. fetch() will behave as normal, returning rows in the order in which they came out of the database.

It's actually pretty confusing behaviour at first. Definitely worth documenting even if only as a user-added note on this page.

down

gergo at gergoerdosi dot com ¶

12 years ago

When using PDO::FETCH_COLUMN in a while loop, it's not enough to just use the value in the while statement as many examples show:

<?php
while ($row = $stmt->fetch(PDO::FETCH_COLUMN)) {
    print $row;
}
?>

If there are 5 rows with values 1 2 0 4 5, then the while loop above will stop at the third row printing only 1 2. The solution is to either explicitly test for false:

<?php
while (($row = $stmt->fetch(PDO::FETCH_COLUMN)) !== false) {
    print $row;
}
?>

Or use foreach with fetchAll():

<?php
foreach ($stmt->fetchAll(PDO::FETCH_COLUMN) as $row) {
    print $row;
}
?>

Both will correctly print 1 2 0 4 5.

down

lod ¶

17 years ago

A quick one liner to get the first entry returned.  This is nice for very basic queries.

<?php
$count = current($db->query("select count(*) from table")->fetch());
?>php

down

public at grik dot net ¶

14 years ago

When fetching an object, the constructor of the class is called after the fields are populated by default.



PDO::FETCH_PROPS_LATE is used to change the behaviour and make it work as expected - constructor be called _before_ the object fields will be populated with the data.



sample:



<?php

$a = $PDO->query('select id from table');

$a->setFetchMode(PDO::FETCH_CLASS|PDO::FETCH_PROPS_LATE, 'ClassName');

$obj = $a->fetch();

?>



http://bugs.php.net/bug.php?id=53394

down

Typer85 at gmail dot com ¶

15 years ago

Here is quick note for developers that use the PDO SQLite Driver:

The PDO SQLite driver does not support cursors, so using the PDO::CURSOR_SCROLL Attribute, will not work when using the PDO SQLite driver. For example:

<?php

// Assuming $Handle Is a PDO Handle.
$Statement = $Handle->query( $sqlStatement , array( PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL ) );

?>

What is even worse is that PDO::prepare will NOT throw an Exception when it fails to prepare the query, even when the error mode is set to throw Exceptions, and will instead return a Boolean False!

Not only do I consider this a poor design choice, but also its a real shame that this is not documented anywhere in the manual -- in fact the manual is not clear on what Attributes are supported by which drivers and which are not so developers are left to play a classic game of guess.

I hope this saves some developers some headaches.

Good Luck,

down

paulf at quillandmouse dot com ¶

5 years ago

A prior poster indicated that this function returns a NULL when there are no results. This is not true. This function returns an empty array. fetchAll() returns the same.

Also, the documentation specifies what happens on "failure", but doesn't indicate what constitutes a "failure". A "failure" could be where the function returns no results; that is, the query "failed". However, a "failure" is apparently a situation where the PDO error functions would reveal a "failure", as in illegal SQL syntax, or a query on a table which doesn't exist, etc. An empty result is not a "failure". Maybe that's obvious to everyone else, but it wasn't to me.

down

Gerard van Beek ¶

17 years ago

If you to use a new instance of a class for a record you can use:

<?php
include_once("user.class");
$sth = $db->prepare("SELECT * FROM user WHERE id = 1");

/* create instance automatically */
$sth->setFetchMode( PDO::FETCH_CLASS, 'user');
$sth->execute();
$user = $sth->fetch( PDO::FETCH_CLASS );
$sth->closeCursor();
print ($user->id);

/* or create an instance yourself and use it */
$user= new user();
$sth->setFetchMode( PDO::FETCH_INTO, $user);
$sth->execute();
$user= $sth->fetch( PDO::FETCH_INTO );
$sth->closeCursor();
print ($user->id);
?>

down

lenz_kappov at yahoo dot co dot uk ¶

11 years ago

Because MySQL does not currently support the use of cursors, the $cursor_offset feature cannot work when using PDO to access a MySQL database.

If you are tring to arbitrarily access a specific record or group of records in a MySQL database recordset, you might want to consider using the LIMIT clause of the SELECT statement to achieve this e.g. LIMIT 5,3 to return just the 6th,7th & 8th records - 3 records starting at index 5 (which is the 6th record).

down

fh at ez dot no ¶

19 years ago

If you want to use PDO::FETCH_CLASS you need to set it up with setFetchMode first like so:
        $stmt->setFetchMode( PDO::FETCH_CLASS, 'classType', array( 'parameters to constructor' );
        $object = $stmt->fetch( PDO::FETCH_CLASS );
If you ommit this PHP will segfault.

down

fh at ez dot no ¶

19 years ago

I can also add that the constructor is run _after_ the data is set on the object if yo use PDO::FETCH_CLASS.

down

Black Knight ¶

9 years ago

this is just On reminder note about Second parameter -cursor_oriantation-

PDO::FETCH_ORI_NEXT :-
Fetch the next row in the result set. Valid only for scrollable cursors.

PDO::FETCH_ORI_PRIOR :-
Fetch the previous row in the result set. Valid only for scrollable cursors.

PDO::FETCH_ORI_FIRST :-
Fetch the first row in the result set. Valid only for scrollable cursors.

PDO::FETCH_ORI_LAST :-
Fetch the last row in the result set. Valid only for scrollable cursors.

PDO::FETCH_ORI_ABS :-
Fetch the requested row by row number from the result set. Valid only for scrollable cursors.

PDO::FETCH_ORI_REL :- 
Fetch the requested row by relative position from the current position of the cursor in the result set. Valid only for scrollable cursors.

down

Drew ¶

5 years ago

When using a PDOStatement with the fetch mode set to FETCH_CLASS, fetch will return false if no rows were found.

down

marcini ¶

18 years ago

Be careful with fetch() when you use prepared statements and MySQL (I don`t know how it is with other databases). Fetch won`t close cursor and won`t let you send any other query, even if your result set has only one row, . 
If you use $statement->fetch(), you will also have to use $statement->closeCursor() afterwards, to be albe to execute another query.
Alternatively you can use $statement->fetchAll() without $statement->closeCursor().

down

-2

Alex ¶

13 years ago

It seems that if you do a $statement->query() with an INSERT statement and after that a $statement->fetch() you will get an exception saying: SQLSTATE[HY000]: General error.

down

-1

lozitskiys at gmail dot com ¶

17 years ago

I spent some hours trying to find out how to manipulate with BLOB fields using PDO.

Remember that you can't retreive BLOB data using something like this :

<?php
$sql = 'SELECT * FROM sometable LIMIT 1';
$stmt = $dbh->prepare($sql);
$stmt->execute();
$stmt->setAttribute(PDO::FETCH_ASSOC);
$row = $stmt->fetch();

$myFile = $row['file'];
?>

Instead of this you should try following approach:

<?php
$sql = "SELECT mime, file FROM sometable LIMIT 1"; 
$stmt = $dbh->prepare($sql); 
$stmt->execute(); 

$stmt->bindColumn(1, $mime,); 
$stmt->bindColumn(2, $file, PDO::PARAM_LOB); 

$stmt->fetch(); 

header('Content-type: '.$mime);
print $file; 

?>

down

-3

sumariva at gmail dot com ¶

13 years ago

I could use PDO::FETCH_COLUMN to retrieve the first column from result.
$ps->fetch( PDO::FETCH_COLUMN );
Worked on Postgresql with PHP 5.3.10.

down

-2

aledmb at gmail dot com ¶

19 years ago

note that fetch constants are not included in the PDO class for PHP versions prior to 5.1

down

-4

josh ¶

17 years ago

Note that PDO::ATTR_STRINGIFY_FETCHES will NOT work for the MySQL driver. MySQL will always return strings because that is the behaviour of the core mysql PHP extension. See http://bugs.php.net/bug.php?id=44341

down

-3

tastro ¶

10 years ago

Note that this way, the "fetch mode" will get "overwritten", and PDO::FETCH_PROPS_LATE won't be applied:

<?php
$sth = $db->prepare("SELECT * FROM user WHERE id = 1");
$sth->setFetchMode( PDO::FETCH_CLASS|PDO::FETCH_PROPS_LATE, 'user');
$sth->execute();
$user = $sth->fetch( PDO::FETCH_CLASS );
$sth->closeCursor();
?>

Instead, you should leave the parameter area for the fetch() method empty, like this (if you want to set the fetch mode with the setFetchMode() method):

<?php
$sth = $db->prepare("SELECT * FROM user WHERE id = 1");
$sth->setFetchMode( PDO::FETCH_CLASS|PDO::FETCH_PROPS_LATE, 'user');
$sth->execute();
$user = $sth->fetch();
$sth->closeCursor();
?>

down

-4

tim at kooky dot org ¶

9 years ago

Be careful when using PDO::FETCH_LAZY.  It adds an additional field called queryString.  I'm not sure if this a bug or not. I'm using version 5.6.17 in Debian Jessie.

Query:  'select 1,2,3'

$row=$smt->fetch(PDO::FETCH_OBJ);
var_dump($row);

object(stdClass)#6 (3) {
  ["1"]=>
  string(1) "1"
  ["2"]=>
  string(1) "2"
  ["3"]=>
  string(1) "3"
}

$row=$smt->fetch(PDO::FETCH_LAZY);
var_dump($row);

object(PDORow)#3 (4) {
  ["queryString"]=>
  string(12) "select 1,2,3"
  ["1"]=>
  string(1) "1"
  ["2"]=>
  string(1) "2"
  ["3"]=>
  string(1) "3"
}

＋add a note