PDO::setAttribute

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

PDO::setAttribute — Setzt ein Attribut

Beschreibung

public PDO::setAttribute(int $attribute, mixed $value): bool

Legt ein Attribut für eine Datenbankverbindung fest. Einige der allgemein verfügbaren Attribute sind unten aufgeführt; manche Treiber verwenden möglicherweise zusätzliche treiberspezifische Attribute. Es ist zu beachten, dass die treiberspezifischen Attribute nicht mit anderen Treibern verwendet werden dürfen.

PDO::ATTR_CASE

Erzwingt, dass Spaltennamen eine bestimmte Groß-/Kleinschreibung aufweisen; kann einen der folgenden Werte annehmen:

PDO::CASE_LOWER: Erzwingt, dass Spaltennamen klein geschrieben werden.
PDO::CASE_NATURAL: Belässt die Spaltennamen so, wie sie vom Datenbanktreiber zurückgegeben werden.
PDO::CASE_UPPER: Erzwingt, dass Spaltennamen groß geschrieben werden.

PDO::ATTR_ERRMODE

Modus der PDO-Fehlermeldung; kann einen der folgenden Werte annehmen:

PDO::ERRMODE_SILENT: Es werden nur Fehlercodes gesetzt.
PDO::ERRMODE_WARNING: Gibt einen Fehler der Stufe E_WARNING aus.
PDO::ERRMODE_EXCEPTION: Löst PDOExceptions aus.

PDO::ATTR_ORACLE_NULLS

Hinweis: Dieses Attribut ist für alle Treiber verfügbar, nicht nur für Oracle.

Legt fest, ob und wie null und leere Strings umgewandelt werden sollen; kann einen der folgenden Werte annehmen:

PDO::NULL_NATURAL: Es findet keine Umwandlung statt.
PDO::NULL_EMPTY_STRING: Leere Zeichenketten werden in null umgewandelt.
PDO::NULL_TO_STRING: null wird in eine leere Zeichenkette umgewandelt.

PDO::ATTR_STRINGIFY_FETCHES

Legt fest, ob numerische Werte beim Abrufen in Zeichenketten umgewandelt werden sollen; akzeptiert einen Wert vom Typ bool: true zum Aktivieren und false zum Deaktivieren.

PDO::ATTR_STATEMENT_CLASS

Legt die vom Benutzer bereitgestellte Anweisungsklasse fest, die von PDOStatement abgeleitet ist; muss das Format array(string classname, array(mixed constructor_args)) haben.

Achtung

Kann nicht mit persistenten PDO-Instanzen verwendet werden.

PDO::ATTR_TIMEOUT

Legt das Zeitlimit fest (in Sekunden); akzeptiert einen Wert vom Typ int.

Hinweis:
Diese Option wird nicht von allen Treibern unterstützt und ihre Bedeutung kann sich je nach Treiber unterscheiden. So wartet SQLite beispielsweise bis zu diesem Zeitwert, bevor es aufgibt, eine beschreibbare Sperre zu erhalten, aber andere Treiber können dies als Zeitlimit für den Verbindungsaufbau oder den Lesevorgang interpretieren.

PDO::ATTR_AUTOCOMMIT

Hinweis: Nur für die OCI-, Firebird- und MySQL-Treiber verfügbar.

Legt fest, ob jede einzelne Anweisung automatisch bestätigt werden soll; akzeptiert einen Wert vom Typ bool: true zum Aktivieren und false zum Deaktivieren. Voreinstellung: true.

PDO::ATTR_EMULATE_PREPARES

Hinweis: Nur für die OCI-, Firebird- und MySQL-Treiber verfügbar.

Aktiviert oder deaktiviert die Emulation vorbereiteter Anweisungen. Einige Treiber unterstützen vorbereitete Anweisungen nicht nativ oder nur eingeschränkt. Wenn es auf true gesetzt ist, werden vorbereitete Anweisungen immer emuliert, andernfalls versucht PDO, nativ vorbereitete Anweisungen zu verwenden. Falls der Treiber die aktuelle Abfrage nicht erfolgreich vorbereiten kann, greift PDO immer darauf zurück, die vorbereitete Anweisung zu emulieren.

PDO::MYSQL_ATTR_USE_BUFFERED_QUERY

Hinweis: Nur für den MySQL-Treiber verfügbar.

Legt fest, ob gepufferte Abfragen verwendet werden sollen; akzeptiert einen Wert vom Typ bool: true zum Aktivieren und false zum Deaktivieren. Voreinstellung: true.

PDO::ATTR_DEFAULT_FETCH_MODE

Legt den standardmäßigen Abrufmodus fest. Eine Beschreibung der Modi und ihrer Verwendung ist in der Dokumentation zu PDOStatement::fetch() zu finden.

Parameter-Liste

attribute: Das Attribut, das geändert werden soll.
value: Der Wert, auf den attribute gesetzt wird; je nach Attribut kann ein bestimmter Typ erforderlich sein.

Rückgabewerte

Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben.

Siehe auch

PDO::getAttribute() - Ruft ein Attribut einer Datenbankverbindung ab
PDOStatement::getAttribute() - Ruft ein Attribut einer Anweisung ab
PDOStatement::setAttribute() - Setzt ein Anweisungsattribut

add a note

User Contributed Notes 12 notes

down

117

colinganderson [at] gmail [dot] com ¶

17 years ago


Because no examples are provided, and to alleviate any confusion as a result, the setAttribute() method is invoked like so:

setAttribute(ATTRIBUTE, OPTION);

So, if I wanted to ensure that the column names returned from a query were returned in the case the database driver returned them (rather than having them returned in all upper case [as is the default on some of the PDO extensions]), I would do the following:

<?php
// Create a new database connection.
$dbConnection = new PDO($dsn, $user, $pass);

// Set the case in which to return column_names.
$dbConnection->setAttribute(PDO::ATTR_CASE, PDO::CASE_NATURAL);
?>

Hope this helps some of you who learn by example (as is the case with me).

.Colin

down

yeboahnanaosei at gmail dot com ¶

7 years ago


This is an update to a note I wrote earlier concerning how to set multiple attributes when you create you PDO connection string.

You can put all the attributes you want in an associative array and pass that array as the fourth parameter in your connection string. So it goes like this: 
<?php
$options = [
    PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
    PDO::ATTR_CASE => PDO::CASE_NATURAL,
    PDO::ATTR_ORACLE_NULLS => PDO::NULL_EMPTY_STRING
];

// Now you create your connection string
try {
    // Then pass the options as the last parameter in the connection string
    $connection = new PDO("mysql:host=$host; dbname=$dbname", $user, $password, $options);

    // That's how you can set multiple attributes
} catch(PDOException $e) {
    die("Database connection failed: " . $e->getMessage());
}
?>

down

yeboahnanaosei at gmail dot com ¶

7 years ago


Well, I have not seen it mentioned anywhere and thought its worth mentioning. It might help someone. If you are wondering whether you can set multiple attributes then the answer is yes.

You can do it like this:
try {
    $connection = new PDO("mysql:host=$host; dbname=$dbname", $user, $password);
    // You can begin setting all the attributes you want.
    $connection->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
    $connection->setAttribute(PDO::ATTR_CASE, PDO::CASE_NATURAL);
    $connection->setAttribute(PDO::ATTR_ORACLE_NULLS, PDO::NULL_EMPTY_STRING);

    // That's how you can set multiple attributes
}
catch(PDOException $e)
{
    die("Database connection failed: " . $e->getMessage());
}

I hope this helps somebody. :)

down

Anonymous ¶

3 years ago


Note that contrary to most PDO methods, setAttribute does not throw a PDOException when it returns false.

down

gregory dot szorc at gmail dot com ¶

17 years ago


It is worth noting that not all attributes may be settable via setAttribute().  For example, PDO::MYSQL_ATTR_MAX_BUFFER_SIZE is only settable in PDO::__construct().  You must pass PDO::MYSQL_ATTR_MAX_BUFFER_SIZE as part of the optional 4th parameter to the constructor.  This is detailed in http://bugs.php.net/bug.php?id=38015

down

steve at websmithery dot co dot uk ¶

7 years ago


For PDO::ATTR_EMULATE_PREPARES, the manual states a boolean value is required. However, when getAttribute() is used to check this value, an integer (1 or 0) is returned rather than true or false.

This means that if you are checking a PDO object is configured as required then

<?php
        // Check emulate prepares is off
        if ($pdo->getAttribute(\PDO::ATTR_EMULATE_PREPARES) !== false) {
            /* do something */
        }
?>

will always 'do something', regardless.

Either

<?php
        // Check emulate prepares is off
        if ($pdo->getAttribute(\PDO::ATTR_EMULATE_PREPARES) != false) {
            /* do something */
        }
?>

or

<?php
        // Check emulate prepares is off
        if ($pdo->getAttribute(\PDO::ATTR_EMULATE_PREPARES) !== 0) {
            /* do something */
        }
?>

is needed instead.

Also worth noting that setAttribute() does, in fact, accept an integer value if you want to be consistent.

down

antoyo ¶

13 years ago


There is also a way to specifie the default fetch mode :

<?php

$connection = new PDO($connection_string);

$connection->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ);

?>

down

-3

rob51 at mac dot com ¶

6 years ago


Where would I find the default values of attributes?

down

-7

guillaume at thug dot com ¶

7 years ago


function pdo_connect(){
  try {

      $pdo = new PDO('mysql:host=localhost;dbname='.DB_NAME, DB_USER, DB_PASS);
      $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);     
      $pdo->setAttribute( PDO::ATTR_EMULATE_PREPARES, false );           
      $pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_ASSOC);

  } catch (PDOException $e) {

      die("Error!: " . $e->getMessage() . "<br/>");

  }

  return $pdo;
}

down

-9

justinasu at gmail dot com ¶

9 years ago


in v5.5 PDO::MYSQL_ATTR_USE_BUFFERED_QUERY can only be set in PDO constructor, not by passing it into setAttribute. 
If you set it with setAttribute it will not work. getAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY) will return 0.

down

-9

vstoykov at proab dot info ¶

7 years ago


I am using PHP 5.6 and MySQL 5.0 on GoDaddy.
When executing a query like this:
<?php
    $stmt = $this->PDO->query("SHOW CREATE TABLE table");
?>
I get:
Uncaught exception 'PDOException' with message 
'SQLSTATE[HY000]: General error: 2030 This command is not supported in the prepared statement protocol yet' 
After I added:
<?php
    $this->PDO->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
?>
the query was executed successfully.

down

-15

m dot leuffen at gmx dot de ¶

18 years ago


Hi,

if you are wondering about a size-bound (1 MB) on blob and text fields after upgrading to PHP5.1.4. You might try to increase this limit by using the setAttribute() method.

This will fail. Instead use the options array when instantiating the pdo:

$pdo = new PDO ("connection_settings", "user", "pass", array
(PDO::MYSQL_ATTR_MAX_BUFFER_SIZE=>1024*1024*50));

This should fix the problem and increase the limit to 50 MB.

Bye,
  Matthias

add a note