CakeFest 2024: The Official CakePHP Conference

PDO::setAttribute

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

PDO::setAttribute Define um atributo

Descrição

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

Define um atributo no identificador do banco de dados. Alguns atributos genéricos disponíveis estão listados abaixo; alguns drivers podem fazer uso de atributos adicionais específicos do driver. Observe que os atributos específicos do driver não devem ser usados ​​com outros drivers.

PDO::ATTR_CASE

Força os nomes das colunas para uma combinação específica de maiúsculas/minúsculas. Pode ser um dos seguintes valores:

PDO::CASE_LOWER
Força os nomes das colunas para minúsculas.
PDO::CASE_NATURAL
Deixa os nomes das colunas como retornados pelo driver do banco de dados.
PDO::CASE_UPPER
Força os nomes das colunas para maiúsculas.
PDO::ATTR_ERRMODE

Modo de relatório de erros do PDO. Pode ser um dos seguintes valores:

PDO::ERRMODE_SILENT
Define somente códigos de erro.
PDO::ERRMODE_WARNING
Emite diagnósticos E_WARNING.
PDO::ERRMODE_EXCEPTION
Lança exceções PDOException.
PDO::ATTR_ORACLE_NULLS

Nota: Este atributo está disponível em todos os drivers, não somente no Oracle.

Determina se e como strings null e vazias devem ser convertidas. Pode ser um dos seguintes valores:

PDO::NULL_NATURAL
Nenhuma conversão acontece.
PDO::NULL_EMPTY_STRING
Strings vazias são convertidas para null.
PDO::NULL_TO_STRING
null é convertido para uma string vazia.
PDO::ATTR_STRINGIFY_FETCHES

Define se os valores numéricos devem ser convertidos em strings durante a busca. Recebe um valor do tipo bool: true para habilitar e false para desabilitar.

PDO::ATTR_STATEMENT_CLASS

Defina a classe de instrução fornecida pelo usuário derivada de PDOStatement. Requer array(string classname, array(mixed constructor_args)).

Cuidado

Não pode ser usado com instâncias persistentes de PDO.

PDO::ATTR_TIMEOUT

Especifica a duração do tempo limite em segundos. Recebe um valor do tipo int.

Nota:

Nem todos os drivers suportam esta opção e seu significado pode variar de driver para driver. Por exemplo, o SQLite irá esperar até esse valor de tempo antes de desistir de obter uma trava para escrita, mas outros drivers podem interpretar isso como intervalo de tempo limite de conexão ou de leitura.

PDO::ATTR_AUTOCOMMIT

Nota: Disponível apenas para drivers OCI, Firebird e MySQL.

Define se cada instrução deve ser confirmada automaticamente. Recebe um valor do tipo bool: true para habilitar e false para desabilitar. Por padrão, true.

PDO::ATTR_EMULATE_PREPARES

Nota: Disponível apenas para drivers OCI, Firebird e MySQL.

Define se a emulação de instruções preparadas será habilitada ou desabilitada. Alguns drivers não oferecem suporte nativo a instruções preparadas ou têm suporte limitado para elas. Se definido como true O PDO sempre emulará instruções preparadas, caso contrário, o PDO tentará usar instruções preparadas nativas. Caso o driver não consiga preparar com êxito a instrução atual, o PDO sempre voltará a emular a instrução preparada.

PDO::MYSQL_ATTR_USE_BUFFERED_QUERY

Nota: Disponível apenas para o driver MySQL.

Define se consultas com buffer devem ser usadas. Recebe um valor do tipo bool: true para habilitar e false para desabilitar. Por padrão, true.

PDO::ATTR_DEFAULT_FETCH_MODE

Define o modo de busca padrão. Uma descrição dos modos e de como utilizá-los está disponível na documentação do método PDOStatement::fetch().

Parâmetros

attribute

O atributo a modificar.

value

O valor para o qual o attribute será definido, pode requerer um tipo específico dependendo do atributo.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Veja Também

add a note

User Contributed Notes 12 notes

up
124
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
up
29
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());
}
?>
up
16
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. :)
up
18
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
up
1
Anonymous
2 years ago
Note that contrary to most PDO methods, setAttribute does not throw a PDOException when it returns false.
up
5
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.
up
12
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);
?>
up
-4
rob51 at mac dot com
5 years ago
Where would I find the default values of attributes?
up
-6
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;
}
up
-8
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.
up
-10
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.
up
-15
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
To Top