Predefined Constants
The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime.
Warning
PDO uses class constants since PHP 5.1. Prior releases use global constants
in the form PDO_PARAM_BOOL
.
-
PDO::PARAM_BOOL
(integer) - Represents a boolean data type.
-
PDO::PARAM_NULL
(integer) - Represents the SQL NULL data type.
-
PDO::PARAM_INT
(integer) - Represents the SQL INTEGER data type.
-
PDO::PARAM_STR
(integer) - Represents the SQL CHAR, VARCHAR, or other string data type.
-
PDO::PARAM_LOB
(integer) - Represents the SQL large object data type.
-
PDO::PARAM_STMT
(integer) - Represents a recordset type. Not currently supported by any drivers.
-
PDO::PARAM_INPUT_OUTPUT
(integer) - Specifies that the parameter is an INOUT parameter for a stored procedure. You must bitwise-OR this value with an explicit PDO::PARAM_* data type.
-
PDO::FETCH_LAZY
(integer) -
Specifies that the fetch method shall return each row as an object with
variable names that correspond to the column names returned in the result
set.
PDO::FETCH_LAZY
creates the object variable names as they are accessed. Not valid inside PDOStatement::fetchAll(). -
PDO::FETCH_ASSOC
(integer) -
Specifies that the fetch method shall return each row as an array indexed
by column name as returned in the corresponding result set. If the result
set contains multiple columns with the same name,
PDO::FETCH_ASSOC
returns only a single value per column name. -
PDO::FETCH_NAMED
(integer) -
Specifies that the fetch method shall return each row as an array indexed
by column name as returned in the corresponding result set. If the result
set contains multiple columns with the same name,
PDO::FETCH_NAMED
returns an array of values per column name. -
PDO::FETCH_NUM
(integer) - Specifies that the fetch method shall return each row as an array indexed by column number as returned in the corresponding result set, starting at column 0.
-
PDO::FETCH_BOTH
(integer) - Specifies that the fetch method shall return each row as an array indexed by both column name and number as returned in the corresponding result set, starting at column 0.
-
PDO::FETCH_OBJ
(integer) - Specifies that the fetch method shall return each row as an object with property names that correspond to the column names returned in the result set.
-
PDO::FETCH_BOUND
(integer) - Specifies that the fetch method shall return TRUE and assign the values of the columns in the result set to the PHP variables to which they were bound with the PDOStatement::bindParam() or PDOStatement::bindColumn() methods.
-
PDO::FETCH_COLUMN
(integer) - Specifies that the fetch method shall return only a single requested column from the next row in the result set.
-
PDO::FETCH_CLASS
(integer) -
Specifies that the fetch method shall return a new instance of the
requested class, mapping the columns to named properties in the class.
Note: The magic __set() method is called if the property doesn't exist in the requested class
-
PDO::FETCH_INTO
(integer) - Specifies that the fetch method shall update an existing instance of the requested class, mapping the columns to named properties in the class.
-
PDO::FETCH_FUNC
(integer) - Allows completely customize the way data is treated on the fly (only valid inside PDOStatement::fetchAll()).
-
PDO::FETCH_GROUP
(integer) -
Group return by values. Usually combined with
PDO::FETCH_COLUMN
orPDO::FETCH_KEY_PAIR
. -
PDO::FETCH_UNIQUE
(integer) - Fetch only the unique values.
-
PDO::FETCH_KEY_PAIR
(integer) - Fetch a two-column result into an array where the first column is a key and the second column is the value. Available since PHP 5.2.3.
-
PDO::FETCH_CLASSTYPE
(integer) - Determine the class name from the value of first column.
-
PDO::FETCH_SERIALIZE
(integer) -
As
PDO::FETCH_INTO
but object is provided as a serialized string. Available since PHP 5.1.0. Since PHP 5.3.0 the class constructor is never called if this flag is set. -
PDO::FETCH_PROPS_LATE
(integer) - Call the constructor before setting properties. Available since PHP 5.2.0.
-
PDO::ATTR_AUTOCOMMIT
(integer) -
If this value is
FALSE
, PDO attempts to disable autocommit so that the connection begins a transaction. -
PDO::ATTR_PREFETCH
(integer) - Setting the prefetch size allows you to balance speed against memory usage for your application. Not all database/driver combinations support setting of the prefetch size. A larger prefetch size results in increased performance at the cost of higher memory usage.
-
PDO::ATTR_TIMEOUT
(integer) - Sets the timeout value in seconds for communications with the database.
-
PDO::ATTR_ERRMODE
(integer) - See the Errors and error handling section for more information about this attribute.
-
PDO::ATTR_SERVER_VERSION
(integer) - This is a read only attribute; it will return information about the version of the database server to which PDO is connected.
-
PDO::ATTR_CLIENT_VERSION
(integer) - This is a read only attribute; it will return information about the version of the client libraries that the PDO driver is using.
-
PDO::ATTR_SERVER_INFO
(integer) - This is a read only attribute; it will return some meta information about the database server to which PDO is connected.
-
PDO::ATTR_CONNECTION_STATUS
(integer) -
PDO::ATTR_CASE
(integer) - Force column names to a specific case specified by the PDO::CASE_* constants.
-
PDO::ATTR_CURSOR_NAME
(integer) - Get or set the name to use for a cursor. Most useful when using scrollable cursors and positioned updates.
-
PDO::ATTR_CURSOR
(integer) -
Selects the cursor type. PDO currently supports either
PDO::CURSOR_FWDONLY
andPDO::CURSOR_SCROLL
. Stick withPDO::CURSOR_FWDONLY
unless you know that you need a scrollable cursor. -
PDO::ATTR_DRIVER_NAME
(string) -
Returns the name of the driver.
Example #1 using
PDO::ATTR_DRIVER_NAME
<?php
if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
echo "Running on mysql; doing something mysql specific here\n";
}
?> -
PDO::ATTR_ORACLE_NULLS
(integer) - Convert empty strings to SQL NULL values on data fetches.
-
PDO::ATTR_PERSISTENT
(integer) - Request a persistent connection, rather than creating a new connection. See Connections and Connection management for more information on this attribute.
-
PDO::ATTR_STATEMENT_CLASS
(integer) -
PDO::ATTR_FETCH_CATALOG_NAMES
(integer) - Prepend the containing catalog name to each column name returned in the result set. The catalog name and column name are separated by a decimal (.) character. Support of this attribute is at the driver level; it may not be supported by your driver.
-
PDO::ATTR_FETCH_TABLE_NAMES
(integer) - Prepend the containing table name to each column name returned in the result set. The table name and column name are separated by a decimal (.) character. Support of this attribute is at the driver level; it may not be supported by your driver.
-
PDO::ATTR_STRINGIFY_FETCHES
(integer) -
PDO::ATTR_MAX_COLUMN_LEN
(integer) -
PDO::ATTR_DEFAULT_FETCH_MODE
(integer) - Available since PHP 5.2.0
-
PDO::ATTR_EMULATE_PREPARES
(integer) - Available since PHP 5.1.3.
-
PDO::ERRMODE_SILENT
(integer) - Do not raise an error or exception if an error occurs. The developer is expected to explicitly check for errors. This is the default mode. See Errors and error handling for more information about this attribute.
-
PDO::ERRMODE_WARNING
(integer) -
Issue a PHP
E_WARNING
message if an error occurs. See Errors and error handling for more information about this attribute. -
PDO::ERRMODE_EXCEPTION
(integer) - Throw a PDOException if an error occurs. See Errors and error handling for more information about this attribute.
-
PDO::CASE_NATURAL
(integer) - Leave column names as returned by the database driver.
-
PDO::CASE_LOWER
(integer) - Force column names to lower case.
-
PDO::CASE_UPPER
(integer) - Force column names to upper case.
-
PDO::NULL_NATURAL
(integer) -
PDO::NULL_EMPTY_STRING
(integer) -
PDO::NULL_TO_STRING
(integer) -
PDO::FETCH_ORI_NEXT
(integer) - Fetch the next row in the result set. Valid only for scrollable cursors.
-
PDO::FETCH_ORI_PRIOR
(integer) - Fetch the previous row in the result set. Valid only for scrollable cursors.
-
PDO::FETCH_ORI_FIRST
(integer) - Fetch the first row in the result set. Valid only for scrollable cursors.
-
PDO::FETCH_ORI_LAST
(integer) - Fetch the last row in the result set. Valid only for scrollable cursors.
-
PDO::FETCH_ORI_ABS
(integer) - Fetch the requested row by row number from the result set. Valid only for scrollable cursors.
-
PDO::FETCH_ORI_REL
(integer) - Fetch the requested row by relative position from the current position of the cursor in the result set. Valid only for scrollable cursors.
-
PDO::CURSOR_FWDONLY
(integer) - Create a PDOStatement object with a forward-only cursor. This is the default cursor choice, as it is the fastest and most common data access pattern in PHP.
-
PDO::CURSOR_SCROLL
(integer) - Create a PDOStatement object with a scrollable cursor. Pass the PDO::FETCH_ORI_* constants to control the rows fetched from the result set.
-
PDO::ERR_NONE
(string) - Corresponds to SQLSTATE '00000', meaning that the SQL statement was successfully issued with no errors or warnings. This constant is for your convenience when checking PDO::errorCode() or PDOStatement::errorCode() to determine if an error occurred. You will usually know if this is the case by examining the return code from the method that raised the error condition anyway.
-
PDO::PARAM_EVT_ALLOC
(integer) - Allocation event
-
PDO::PARAM_EVT_FREE
(integer) - Deallocation event
-
PDO::PARAM_EVT_EXEC_PRE
(integer) - Event triggered prior to execution of a prepared statement.
-
PDO::PARAM_EVT_EXEC_POST
(integer) - Event triggered subsequent to execution of a prepared statement.
-
PDO::PARAM_EVT_FETCH_PRE
(integer) - Event triggered prior to fetching a result from a resultset.
-
PDO::PARAM_EVT_FETCH_POST
(integer) - Event triggered subsequent to fetching a result from a resultset.
-
PDO::PARAM_EVT_NORMALIZE
(integer) - Event triggered during bound parameter registration allowing the driver to normalize the parameter name.
Коментарии
It should be noted that PDO::FETCH_CLASS will call the constructor *after* setting the values (or calling __set).
Default value for \PDO::ATTR_TIMEOUT is 30 seconds.
Ref.: https://github.com/php/php-src/blob/PHP-7.1.0/ext/pdo_mysql/mysql_driver.c#L600
PDO::PARAM_STR_CHAR and PDO::PARAM_STR_NATL must be combined with PDO::PARAM_STR using bitwise-OR for parameter binding.
These flags control value quoting (e.g. PDO::quote) and, in some situations (see below), parameter binding (e.g. PDO::bindParam, PDO::bindValue) to prefix string literals with N'' as defined in SQL-92. As of PHP 7.3, only dblib and mysql support these flags. For the mysql driver, the flags only affect parameter binding when PDO::ATTR_EMULATE_PREPARES is true (the default).
MySQL and MariaDB interpret string literals prefixed with N as being utf8 (not utf8mb4) regardless of `SET NAMES` or the charset parameter. This can cause problems if the database/table/column charset is not utf8. For example, in a database using utf8mb4, the query "SELECT * FROM table WHERE col = :param" and bindValue(":param", "\u{1F600}", PDO::PARAM_STR | PDO::PARAM_STR_NATL) will cause "PDOException: SQLSTATE[HY000]: General error: 1267 Illegal mix of collations (utf8mb4_general_ci,IMPLICIT) and (utf8_general_ci,COERCIBLE) for operation '='". Using PDO::PARAM_STR without PDO::PARAM_STR_NATL and ensuring the charset DSN parameter is set correctly can avoid this issue.
See:
https://wiki.php.net/rfc/extended-string-types-for-pdo
https://mariadb.com/kb/en/library/string-literals/
https://dev.mysql.com/doc/refman/8.0/en/string-literals.html
Reference to all the PDO::MYSQL_* constants is available in MySQL's documentation for the driver here: https://dev.mysql.com/doc/connectors/en/apis-php-pdo-mysql.html
Such as the ones I was looking for PDO::MYSQL_ATTR_SSL_CA and PDO::MYSQL_ATTR_SSL_CAPATH which are not listed on this page.
PDO::FETCH_UNIQUE not only fetches the unique values, it also uses the first SQL column as array key result, what is very useful for create quickly an index, eg :
<?php
$sql = <<<SQL
SELECT ALL
c1, -- For result indexing
c1, c2
FROM (
VALUES
ROW('ID-1', 'Value 1'),
ROW('ID-2', 'Value 2a'),
ROW('ID-2', 'Value 2b'),
ROW('ID-3', 'Value 3')
) AS t (c1, c2);
SQL;
$result = $pdo->query($sql);
print_r($result->fetchAll(PDO::FETCH_UNIQUE));
/*
Gives :
ID-1 => [c1 => ID-1, c2 => Value 1]
ID-2 => [c1 => ID-2b, c2 => Value 2b]
ID-3 => [c1 => ID-3, c2 => Value 3]
*/
?>
To bind a float, use PDO::PARAM_STR with bindValue. You can skip the PDO::PARAM_STR because it's the default option. Binding with bindParam will change the type of the bound variable to a string, which can lead to type errors.