The PDO class

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

Introduction

Represents a connection between PHP and a database server.

Class synopsis

class PDO {

/* Constants */

public const int PARAM_NULL;

public const int PARAM_BOOL = 5;

public const int PARAM_INT = 1;

public const int PARAM_STR = 2;

public const int PARAM_LOB = 3;

public const int PARAM_STMT = 4;

public const int PARAM_INPUT_OUTPUT;

public const int PARAM_STR_NATL;

public const int PARAM_STR_CHAR;

public const int PARAM_EVT_ALLOC;

public const int PARAM_EVT_FREE;

public const int PARAM_EVT_EXEC_PRE;

public const int PARAM_EVT_EXEC_POST;

public const int PARAM_EVT_FETCH_PRE;

public const int PARAM_EVT_FETCH_POST;

public const int PARAM_EVT_NORMALIZE;

public const int FETCH_DEFAULT;

public const int FETCH_LAZY;

public const int FETCH_ASSOC;

public const int FETCH_NUM;

public const int FETCH_BOTH;

public const int FETCH_OBJ;

public const int FETCH_BOUND;

public const int FETCH_COLUMN;

public const int FETCH_CLASS;

public const int FETCH_INTO;

public const int FETCH_FUNC;

public const int FETCH_GROUP;

public const int FETCH_UNIQUE;

public const int FETCH_KEY_PAIR;

public const int FETCH_CLASSTYPE;

public const int FETCH_SERIALIZE;

public const int FETCH_PROPS_LATE;

public const int FETCH_NAMED;

public const int ATTR_AUTOCOMMIT;

public const int ATTR_PREFETCH;

public const int ATTR_TIMEOUT;

public const int ATTR_ERRMODE;

public const int ATTR_SERVER_VERSION;

public const int ATTR_CLIENT_VERSION;

public const int ATTR_SERVER_INFO;

public const int ATTR_CONNECTION_STATUS;

public const int ATTR_CASE;

public const int ATTR_CURSOR_NAME;

public const int ATTR_CURSOR;

public const int ATTR_ORACLE_NULLS;

public const int ATTR_PERSISTENT;

public const int ATTR_STATEMENT_CLASS;

public const int ATTR_FETCH_TABLE_NAMES;

public const int ATTR_FETCH_CATALOG_NAMES;

public const int ATTR_DRIVER_NAME;

public const int ATTR_STRINGIFY_FETCHES;

public const int ATTR_MAX_COLUMN_LEN;

public const int ATTR_EMULATE_PREPARES;

public const int ATTR_DEFAULT_FETCH_MODE;

public const int ATTR_DEFAULT_STR_PARAM;

public const int ERRMODE_SILENT;

public const int ERRMODE_WARNING;

public const int ERRMODE_EXCEPTION;

public const int CASE_NATURAL;

public const int CASE_LOWER;

public const int CASE_UPPER;

public const int NULL_NATURAL;

public const int NULL_EMPTY_STRING;

public const int NULL_TO_STRING;

public const string ERR_NONE;

public const int FETCH_ORI_NEXT;

public const int FETCH_ORI_PRIOR;

public const int FETCH_ORI_FIRST;

public const int FETCH_ORI_LAST;

public const int FETCH_ORI_ABS;

public const int FETCH_ORI_REL;

public const int CURSOR_FWDONLY;

public const int CURSOR_SCROLL;

/* Methods */

public function __construct(
    string $dsn,
    ?string $username = null,
    #[\SensitiveParameter] ?string $password = null,
    ?array $options = null
)

public function beginTransaction(): bool

public function commit(): bool

public static function connect(
    string $dsn,
    ?string $username = null,
    #[\SensitiveParameter] ?string $password = null,
    ?array $options = null
): static

public function errorCode(): ?string

public function errorInfo(): array

public function exec(string $statement): int|false

public function getAttribute(int $attribute): mixed

public static function getAvailableDrivers(): array

public function inTransaction(): bool

public function lastInsertId(?string $name = null): string|false

public function prepare(string $query, array $options = []): PDOStatement|false

public function query(string $query, ?int $fetchMode = null): PDOStatement|false

public function query(string $query, ?int $fetchMode = PDO::FETCH_COLUMN, int $colno): PDOStatement|false

public function query(
    string $query,
    ?int $fetchMode = PDO::FETCH_CLASS,
    string $classname,
    array $constructorArgs
): PDOStatement|false

public function query(string $query, ?int $fetchMode = PDO::FETCH_INTO, object $object): PDOStatement|false

public function quote(string $string, int $type = PDO::PARAM_STR): string|false

public function rollBack(): bool

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

}

Changelog

Version	Description
8.5.0	Driver-specific constants of the PDO class have been deprecated in favor of the equivalent constants of the driver-specific subclasses (Pdo\Dblib, Pdo\Firebird, Pdo\Mysql, Pdo\Odbc, Pdo\Pgsql, Pdo\Sqlite).
8.4.0	The class constants are now typed.

PDO::beginTransaction — Initiates a transaction
PDO::commit — Commits a transaction
PDO::connect — Connect to a database and return a PDO subclass for drivers that support it
PDO::__construct — Creates a PDO instance representing a connection to a database
PDO::errorCode — Fetch the SQLSTATE associated with the last operation on the database handle
PDO::errorInfo — Fetch extended error information associated with the last operation on the database handle
PDO::exec — Execute an SQL statement and return the number of affected rows
PDO::getAttribute — Retrieve a database connection attribute
PDO::getAvailableDrivers — Return an array of available PDO drivers
PDO::inTransaction — Checks if inside a transaction
PDO::lastInsertId — Returns the ID of the last inserted row or sequence value
PDO::prepare — Prepares a statement for execution and returns a statement object
PDO::query — Prepares and executes an SQL statement without placeholders
PDO::quote — Quotes a string for use in a query
PDO::rollBack — Rolls back a transaction
PDO::setAttribute — Set an attribute

The PDO class

Introduction

Class synopsis

Changelog

Table of Contents