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, mixed $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 configurations supplémentaires. Il est à noter que les attributs spécifiques à un pilote ne doivent pas être utilisés avec d'autres pilotes.

PDO::ATTR_CASE

Force les noms de colonnes à une casse particulière. Peut prendre une des valeurs suivantes :

PDO::CASE_LOWER: Force les noms de colonnes en minuscule.
PDO::CASE_NATURAL: Laisse les noms de colonnes telle que retourné par le pilote de base de données.
PDO::CASE_UPPER: Force les noms de colonnes en majuscule.

PDO::ATTR_ERRMODE

Le mode pour reporter les erreurs de PDO. Peut prendre une des valeurs suivantes :

PDO::ERRMODE_SILENT: Définit juste les codes d'erreurs.
PDO::ERRMODE_WARNING: Émets des diagnostics E_WARNING.
PDO::ERRMODE_EXCEPTION: Lances des PDOExceptions.

PDO::ATTR_ORACLE_NULLS

Note: Cet attribut est disponible avec tout les pilotes, pas juste Oracle.

Détermine si et comment null et les chaînes vides devraient être convertie. Peut prendre une des valeurs suivantes :

PDO::NULL_NATURAL: Aucune conversion est effectuée.
PDO::NULL_EMPTY_STRING: Les chaînes vides sont converties en null.
PDO::NULL_TO_STRING: null est convertie en chaîne vide.

PDO::ATTR_STRINGIFY_FETCHES

Détermine si les valeurs numériques sont à convertir en chaînes de caractères lors de la récupération. Prend une valeur de type bool: true pour activer et false pour désactiver.

PDO::ATTR_STATEMENT_CLASS

Configure la classe de résultat dérivée de PDOStatement et définie par l'utilisateur. Nécessite array(string classname, array(mixed constructor_args)).

Attention

Ne peut être utilisé avec les instances persistantes de PDO.

PDO::ATTR_TIMEOUT

Spécifie la durée du timeout en secondes. Prend une valeur de type int.

Note:
Pas tout les pilotes supportent 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, mais d'autres pilotes peuvent interpréter ceci comme un timeout de connexion ou de lecture.

PDO::ATTR_AUTOCOMMIT

Note: Uniquement disponible pour les pilotes OCI, Firebird, et MySQL.

Détermine si chaque requête est autocommit. Prend une valeur de type bool: true pour activer et false pour désactiver. Par défaut, true.

PDO::ATTR_EMULATE_PREPARES

Note: Uniquement disponible pour les pilotes OCI, Firebird, et MySQL.

Configure l'activation ou désactivation des requêtes préparées émulées. Certains pilotes ne supportent pas les requêtes préparées nativement ou ont un support limité. Si définit à true PDO émulera toujours les requêtes préparées, sinon PDO tentera d'utiliser les requêtes préparées natives. Dans le cas où le pilote ne peut pas préparer la requête courante, PDO se rabattra toujours sur l'émulation des requêtes préparées.

PDO::MYSQL_ATTR_USE_BUFFERED_QUERY

Note: Uniquement disponible pour le pilote MySQL.

Configure l'utilisation des requêtes tampons. Prend une valeur de type bool: true pour activer et false pour désactiver. Par défaut, true.

PDO::ATTR_DEFAULT_FETCH_MODE

Définit le mode de récupération. Une description des modes et comment les utiliser est disponible sur la documentation de PDOStatement::fetch().

Liste de paramètres

attribute: L'attribut à modifier.
value: La valeur à laquelle définir l'attribute, ceci peut nécessiter un type spécifique dépendant de l'attribut.

Valeurs de retour

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

Voir aussi

PDO::getAttribute() - Récupère un attribut d'une connexion à une base de données
PDOStatement::getAttribute() - Récupère un attribut de requête
PDOStatement::setAttribute() - Définit un attribut de requête

Improve This Page

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

＋add a note

User Contributed Notes 8 notes

down

124

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 ¶

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

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

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

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

-1

david at datava dot com ¶

6 months ago

Note that in order for
\PDO::ATTR_TIMEOUT
to have any effect, you must set 

\PDO::ATTR_ERRMODE=>\PDO::ERRMODE_EXCEPTION.

If

\PDO::ATTR_ERRMODE=>\PDO::ERRMODE_WARNING

it doesn't appear to do anything.

＋add a note