PDOStatement::fetch

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

PDOStatement::fetch — Ruft die nächste Zeile aus einer Ergebnismenge ab

Beschreibung

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

Ruft eine Zeile aus einer Ergebnismenge ab, die mit einem PDOStatement-Objekt verknüpft ist. Der Parameter mode bestimmt, wie PDO die Zeile zurückgibt.

Parameter-Liste

mode

Legt fest, wie die nächste Zeile an die aufrufende Methode zurückgegeben werden soll. Dieser Wert muss eine der PDO::FETCH_*-Konstanten sein. Voreingestellt ist PDO::ATTR_DEFAULT_FETCH_MODE (das standardmäßig auf PDO::FETCH_BOTH gesetzt ist).

PDO::FETCH_ASSOC: gibt ein Array zurück, das durch die Spaltennamen der Ergebnismenge indiziert ist.
PDO::FETCH_BOTH (Voreinstellung): gibt ein Array zurück, das sowohl durch die Spaltennamen der Ergebnismenge als auch durch deren Spaltennummern (beginnend bei 0) indiziert ist.
PDO::FETCH_BOUND: gibt true zurück und weist die Werte der Spalten der Ergebnismenge den PHP-Variablen zu, an die sie mit der Methode PDOStatement::bindColumn() gebunden wurden.
PDO::FETCH_CLASS: gibt eine neue Instanz der angeforderten Klasse zurück, wobei die Spalten der Ergebnismenge den benannten Eigenschaften der Klasse zugeordnet werden und anschließend der Konstruktor aufgerufen wird, es sei denn, PDO::FETCH_PROPS_LATE ist ebenfalls angegeben. Wenn mode das Attribut PDO::FETCH_CLASSTYPE enthält (z. B. PDO::FETCH_CLASS | PDO::FETCH_CLASSTYPE), wird der Name der Klasse aus einem Wert der ersten Spalte ermittelt.
PDO::FETCH_INTO: aktualisiert eine bestehende Instanz der angeforderten Klasse, wobei die Spalten der Ergebnismenge den benannten Eigenschaften der Klasse zugeordnet werden.
PDO::FETCH_LAZY: kombiniert PDO::FETCH_BOTH und PDO::FETCH_OBJ und gibt ein PDORow-Objekt zurück, das die Eigenschaftsnamen des Objekts erstellt, wenn auf sie zugegriffen wird.
PDO::FETCH_NAMED: gibt ein Array zurück, das die gleiche Form hat wie PDO::FETCH_ASSOC. Wenn es jedoch mehrere Spalten mit demselben Namen gibt, ist der Wert, auf den der betreffende Schlüssel verweist, ein Array mit allen Werten in der Zeile, die diesen Spaltennamen hatten.
PDO::FETCH_NUM: gibt ein Array zurück, das durch die Spaltennummer aus der Ergebnismenge indiziert ist (beginnend bei Spalte 0).
PDO::FETCH_OBJ: gibt ein anonymes Objekt mit Eigenschaftsnamen zurück, die den Spaltennamen aus der Ergebnismenge entsprechen.
PDO::FETCH_PROPS_LATE: in Kombination mit PDO::FETCH_CLASS wird der Konstruktor der Klasse aufgerufen, bevor die Eigenschaften aus den jeweiligen Spaltenwerten zugewiesen werden.

cursorOrientation

Bei einem PDOStatement-Objekt, das einen scrollbaren Cursor repräsentiert, bestimmt dieser Wert, welche Zeile an die aufrufende Methode zurückgegeben werden soll. Dieser Wert muss eine der PDO::FETCH_ORI_*-Konstanten sein, wobei PDO::FETCH_ORI_NEXT voreingestellt ist. Wenn die SQL-Anweisung mit PDO::prepare() vorbereitet wird, muss das Attribut PDO::ATTR_CURSOR auf PDO::CURSOR_SCROLL gesetzt werden, um einen scrollbaren Cursor für das PDOStatement-Objekt zu erhalten.

cursorOffset

Bei einem PDOStatement-Objekt, das einen scrollbaren Cursor repräsentiert, dessen Parameter cursorOrientation auf PDO::FETCH_ORI_ABS gesetzt ist, gibt dieser Wert die absolute Nummer der Zeile in der Ergebnismenge an, die abgerufen werden soll.

Bei einem PDOStatement-Objekt, das einen scrollbaren Cursor repräsentiert, dessen Parameter cursorOrientation auf PDO::FETCH_ORI_REL gesetzt ist, gibt dieser Wert die abzurufende Zeile relativ zur Position des Zeigers vor dem Aufruf von PDOStatement::fetch() an.

Rückgabewerte

Bei Erfolg hängt der Rückgabewert dieser Funktion von der Art des Abrufs ab. Bei einem Fehler oder wenn es keine weiteren Zeilen gibt, wird in jedem Fall false zurückgegeben.

Fehler/Exceptions

Gibt einen Fehler der Stufe E_WARNING aus, wenn das Attribut PDO::ATTR_ERRMODE auf PDO::ERRMODE_WARNING gesetzt ist.

Löst eine PDOException aus, wenn das Attribut PDO::ATTR_ERRMODE auf PDO::ERRMODE_EXCEPTION gesetzt ist.

Beispiele

Beispiel #1 Abrufen von Zeilen mit verschiedenen Arten des Abrufs

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

/* Beispiele für die verschiedenen Arten von PDOStatement::fetch */
print "PDO::FETCH_ASSOC: ";
print "Die nächste Zeile als Array zurückgeben, das durch den Spaltennamen indiziert ist\n";
$Ergebnis = $sth->fetch(PDO::FETCH_ASSOC);
print_r($result);
print "\n";

print "PDO::FETCH_BOTH: ";
print "Die nächste Zeile als Array zurückgeben, das sowohl durch den Spaltennamen als auch durch die Spaltennummer indiziert ist\n";
$Ergebnis = $sth->fetch(PDO::FETCH_BOTH);
print_r($result);
print "\n";

print "PDO::FETCH_LAZY: ";
print "Die nächste Zeile als PDORow-Objekt mit den Spaltennamen als Eigenschaften zurückgeben\n";
$Ergebnis = $sth->fetch(PDO::FETCH_LAZY);
print_r($result);
print "\n";

print "PDO::FETCH_OBJ: ";
print "Die nächste Zeile als PDORow-Objekt mit den Spaltennamen als Eigenschaften zurückgeben\n";
$result = $sth->fetch(PDO::FETCH_OBJ);
print $result->name;
print "\n";
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

PDO::FETCH_ASSOC: Die nächste Zeile als Array zurückgeben, das durch den Spaltennamen indiziert ist
Array
(
    [name] => apple
    [colour] => red
)

PDO::FETCH_BOTH: Die nächste Zeile als Array zurückgeben, das sowohl durch den Spaltennamen als auch durch die Spaltennummer indiziert ist
Array
(
    [name] => banana
    [0] => banana
    [colour] => yellow
    [1] => yellow
)

PDO::FETCH_LAZY: Die nächste Zeile als anonymes Objekt mit den Spaltennamen als Eigenschaften zurückgeben
PDORow Object
(
    [name] => orange
    [colour] => orange
)

PDO::FETCH_OBJ: Die nächste Zeile als anonymes Objekt mit den Spaltennamen als Eigenschaften zurückgeben
kiwi

Beispiel #2 Abrufen von Zeilen mittels scrollbarem Cursor

<?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 "Vorwärts ausgelesen:\n";
readDataForwards($conn);

print "Rückwärts ausgelesen:\n";
readDataBackwards($conn);
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

Vorwärts ausgelesen:
21    10    5
16    0     5
19    20    10

Rückwärts ausgelesen:
19    20    10
16    0     5
21    10    5

Beispiel #3 Reihenfolge der Konstruktion

Wenn Objekte über PDO::FETCH_CLASS abgerufen werden, werden zuerst die Objekteigenschaften zugewiesen und dann der Konstruktor der Klasse aufgerufen. Wenn zusätzlich PDO::FETCH_PROPS_LATE angegeben wird, wird diese Reihenfolge umgekehrt, d. h. zuerst wird der Konstruktor aufgerufen und danach werden die Eigenschaften zugewiesen.

<?php
class Person
{
    private $name;

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

    public function tell()
    {
        if (isset($this->name)) {
            echo "Ich heiße {$this->name}.\n";
        } else {
            echo "Ich habe noch keinen Namen.\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();
?>

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

Ich heiße Alice.
Ich heiße Alice.
Ich habe noch keinen Namen.
Ich heiße Bob.

Siehe auch

PDO::prepare() - Bereitet eine Anweisung zur Ausführung vor und liefert ein Anweisungsobjekt
PDOStatement::execute() - Führt ein Prepared Statement aus
PDOStatement::fetchAll() - Ruft die verbleibenden Zeilen aus einer Ergebnismenge ab
PDOStatement::fetchColumn() - Liefert eine einzelne Spalte aus der nächsten Zeile einer Ergebnismenge
PDOStatement::fetchObject() - Ruft die nächste Zeile ab und liefert sie als Objekt
PDOStatement::setFetchMode() - Legt den standardmäßigen Abrufmodus eine Anweisung fest

Improve This Page

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 ¶

18 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 ¶

10 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 ¶

11 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 ¶

16 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 ¶

13 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 ¶

14 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 ¶

4 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 ¶

10 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 ¶

18 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

fh at ez dot no ¶

18 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

Black Knight ¶

8 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 ¶

4 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 ¶

17 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 ¶

16 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

-2

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

-3

sumariva at gmail dot com ¶

12 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 ¶

16 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

-4

tim at kooky dot org ¶

8 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