PDO::setAttribute

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

PDO::setAttribute — Configure un attribut PDO

Description

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

Configure un attribut du gestionnaire de base de données. Certains des attributs génériques sont listés ci-dessous : certains pilotes disposent de configuration supplémentaires.

PDO::ATTR_CASE: force les noms de colonnes à une casse particulière.
- PDO::CASE_LOWER : force les noms de colonnes à être en minuscules.
- PDO::CASE_NATURAL : laisse les noms de colonnes inchangées.
- PDO::CASE_UPPER : force les noms de colonnes à être en majuscules.
PDO::ATTR_ERRMODE : rapport d'erreurs.
- PDO::ERRMODE_SILENT : assigne simplement les codes d'erreur.
- PDO::ERRMODE_WARNING: émet une alerte E_WARNING.
- PDO::ERRMODE_EXCEPTION : émet une exception.
PDO::ATTR_ORACLE_NULLS (disponible pour tous les pilotes, et pas juste Oracle ) : Conversion des valeurs NULL et chaînes vides.
- PDO::NULL_NATURAL : Pas de conversion.
- PDO::NULL_EMPTY_STRING : Chaîne vide convertie en null.
- PDO::NULL_TO_STRING : NULL est converti en chaîne vide.
PDO::ATTR_STRINGIFY_FETCHES : Convertit une valeur numérique en chaîne lors de la lecture. Requiert bool.
PDO::ATTR_STATEMENT_CLASS : Configure une classe de résultat, définie par l'utilisateur, et dérivée de PDOStatement. Ne peut pas être utilisée avec les instances persistantes de PDO. Requiert array(string classname, array(mixed constructor_args)).
PDO::ATTR_TIMEOUT: Précise la durée de timeout en secondes. Tous les pilotes ne supportent pas cette option et sa signification peut différer en fonctions des pilotes. Par exemple, sqlite attendra pendant cette période pour obtenir un verrou en écriture sur le fichier, mais les autres pilotes considèreront ceci comme un timeout de connexion ou de lecture. Requiert int.
PDO::ATTR_AUTOCOMMIT (disponible en OCI, Firebird et MySQL) : activation de l'autocommit pour chaque commande.
PDO::ATTR_EMULATE_PREPARES Active ou désactive la simulation des requêtes préparées. Certainspilotes ne supportent pas nativement les requêtes préparées ou en ont un support limité. Ce paramètre force PDO à émuler (true et la simulation des requêtes préparées sont pris en charge par le pilote) les requêtes préparées ou (false) à utiliser l'interface native. Il tentera toujours une émulation si le pilote n'a pas de support natif. bool requis.
PDO::MYSQL_ATTR_USE_BUFFERED_QUERY (disponible en MySQL) : utilisation des requêtes bufferisées.
PDO::ATTR_DEFAULT_FETCH_MODE : Définit le mode de récupération par défaut. Les différentes descriptions des modes sont disponibles dans la documentation de la méthode PDOStatement::fetch().

Valeurs de retour

Cette fonction retourne true en cas de succès ou false si une erreur survient.

add a note

User Contributed Notes 11 notes

down

colinganderson [at] gmail [dot] com ¶

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

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

6 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

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

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

steve at websmithery dot co dot uk ¶

6 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

rob51 at mac dot com ¶

5 years ago


Where would I find the default values of attributes?

down

-4

guillaume at thug dot com ¶

6 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

-10

justinasu at gmail dot com ¶

8 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

-6

vstoykov at proab dot info ¶

6 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

-12

m dot leuffen at gmx dot de ¶

17 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