PDO::setAttribute

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

PDO::setAttribute — Установка атрибута

Описание

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

Устанавливает атрибут объекту PDO. Некоторые основные атрибуты приведены ниже; отдельные драйверы могут имеет свои дополнительные атрибуты.

PDO::ATTR_CASE: Приводить имена столбцов к заданному регистру.
- PDO::CASE_LOWER: Приводить имена столбцов к нижнему регистру.
- PDO::CASE_NATURAL: Оставлять имена столбцов в том виде, в котором они были возвращены драйвером.
- PDO::CASE_UPPER: Приводить имена столбцов к верхнему регистру.
PDO::ATTR_ERRMODE: Режим сообщений об ошибках.
- PDO::ERRMODE_SILENT: Только установка кодов ошибок.
- PDO::ERRMODE_WARNING: Вызывать E_WARNING.
- PDO::ERRMODE_EXCEPTION: Выбрасывать исключения.
PDO::ATTR_ORACLE_NULLS (доступен для всех драйверов, не только для Oracle): Преобразование NULL в пустые строки.
- PDO::NULL_NATURAL: Без преобразования.
- PDO::NULL_EMPTY_STRING: Пустые строки преобразовывать в null.
- PDO::NULL_TO_STRING: NULL преобразовывать в пустые строки.
PDO::ATTR_STRINGIFY_FETCHES: Преобразовывать числовые значения в строки во время выборки. Требует значение типа bool.
PDO::ATTR_STATEMENT_CLASS: Задаёт пользовательский класс, производный от PDOStatement. Не может использоваться с объектами PDO, использующими постоянные соединения. Принимает массив array(string classname, array(mixed constructor_args)).
PDO::ATTR_TIMEOUT: Задаёт тайм-аут в секундах. Не все драйверы поддерживают эту опцию. Также назначение этого тайм-аута может отличаться в разных драйверах. Например, sqlite будет ждать это количество времени для получения блокировки на запись. А другие драйверы могут использовать его, как тайм-аут подключения или чтения. Атрибут принимает значение типа int.
PDO::ATTR_AUTOCOMMIT (доступен в OCI, Firebird и MySQL): Требуется ли автоматическая фиксация каждого отдельного выражения в запросе.
PDO::ATTR_EMULATE_PREPARES Включение или выключение эмуляции подготавливаемых запросов. Некоторые драйверы не поддерживают подготавливаемые запросы, либо их поддержка ограничена. Эта настройка указывает PDO всегда эмулировать подготавливаемые запросы (если true и эмуляция поддерживается драйвером) или пытаться использовать собственные подготавливаемые запросы (если false). Если драйвер не сможет подготовить запрос, эта настройка сбросится в режим эмуляции. Требует значение типа bool.
PDO::MYSQL_ATTR_USE_BUFFERED_QUERY (доступен в MySQL): Использовать буферизованные запросы.
PDO::ATTR_DEFAULT_FETCH_MODE: Устанавливает режим выборки данных по умолчанию. Описание возможных режимов приведено в документации к методу PDOStatement::fetch().

Возвращаемые значения

Возвращает true в случае успешного завершения или false в случае возникновения ошибки.

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