PHP 8.2.0 Alpha 2 available for testing

PDO::setAttribute

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

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

Описание

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

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

PDO::ATTR_CASE

Принудительное приведение имён столбцов к определённому регистру. Может принимать одно из следующих значений:

PDO::CASE_LOWER
Принудительное приведение имён столбцов к нижнему регистру.
PDO::CASE_NATURAL
Оставить имена столбцов в том виде, в котором их возвращает драйвер базы данных.
PDO::CASE_UPPER
Принудительное приведение имён столбцов к верхнему регистру.
PDO::ATTR_ERRMODE

Режим сообщения об ошибках PDO. Может принимать одно из следующих значений:

PDO::ERRMODE_SILENT
Устанавливает только коды ошибок.
PDO::ERRMODE_WARNING
Вызывает диагностику ошибок уровня E_WARNING.
PDO::ERRMODE_EXCEPTION
Выбрасывает PDOException.
PDO::ATTR_ORACLE_NULLS

Замечание: Атрибут доступен для всех драйверов, а не только для Oracle.

Определяет, следует ли и как преобразовывать null и пустые строки. Может принимать одно из следующих значений:

PDO::NULL_NATURAL
Никакого преобразования не происходит.
PDO::NULL_EMPTY_STRING
Пустые строки преобразуются в null.
PDO::NULL_TO_STRING
null преобразуется в пустую строку.
PDO::ATTR_STRINGIFY_FETCHES

Следует ли преобразовывать числовые значения в строки при выборке. Принимает логическое значение (bool): true для включения и false для выключения.

PDO::ATTR_STATEMENT_CLASS

Установка пользовательского класса оператора, производного от PDOStatement. Требуется array(string classname, array(mixed constructor_args)).

Предостережение

Не может использоваться с постоянными экземплярами PDO.

PDO::ATTR_TIMEOUT

Указывает продолжительность времени ожидания в секундах. Принимает значение в виде целого числа (int).

Замечание:

Не все драйверы поддерживают этот параметр и его значение может отличаться от драйвера к драйверу. Например, SQLite будет ждать до этого значения времени, прежде чем отказаться от получения блокировки на запись, но другие драйверы могут интерпретировать это как интервал ожидания соединения или чтения.

PDO::ATTR_AUTOCOMMIT

Замечание: Доступно только для драйверов OCI, Firebird и MySQL.

Следует ли автоматически фиксировать каждый отдельный оператор. Принимает логическое значение (bool): true для включения и false для отключения. По умолчанию true.

PDO::ATTR_EMULATE_PREPARES

Замечание: Доступно только для драйверов OCI, Firebird и MySQL.

Включить или отключить эмуляцию подготовленных запросов. Некоторые драйверы не поддерживают подготовленные запросы нативно или имеют ограниченную поддержку. Если установлено значение true PDO всегда будет эмулировать подготовленные запросы, в противном случае PDO будет пытаться использовать встроенные подготовленные запросы. Если драйвер не сможет успешно подготовить текущий запрос, PDO всегда будет возвращаться к эмуляции подготовленного запроса.

PDO::MYSQL_ATTR_USE_BUFFERED_QUERY

Замечание: Доступно только для драйвера MySQL.

Определяет, использовать ли буферизованные запросы. Принимает логическое значение (bool): true для включения и false для отключения. По умолчанию false.

PDO::ATTR_DEFAULT_FETCH_MODE

Устанавливает режим выборки по умолчанию. Описание режимов и их использования доступно в документации PDOStatement::fetch().

Список параметров

attribute

Атрибут для изменения.

value

Значение для установки параметра attribute, может потребовать определённого типа в зависимости от атрибута.

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

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

Смотрите также

add a note add a note

User Contributed Notes 12 notes

up
110
colinganderson [at] gmail [dot] com
15 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
up
36
yeboahnanaosei at gmail dot com
4 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());
}
?>
up
17
yeboahnanaosei at gmail dot com
4 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. :)
up
18
gregory dot szorc at gmail dot com
15 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
up
6
steve at websmithery dot co dot uk
4 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.
up
10
antoyo
11 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);
?>
up
1
Anonymous
8 months ago
Note that contrary to most PDO methods, setAttribute does not throw a PDOException when it returns false.
up
-3
rob51 at mac dot com
3 years ago
Where would I find the default values of attributes?
up
-5
guillaume at thug dot com
4 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;
}
up
-9
justinasu at gmail dot com
6 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.
up
-10
vstoykov at proab dot info
4 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.
up
-13
m dot leuffen at gmx dot de
15 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
To Top