PHP Data Objects

Table of Contents

Introduction
Installing/Configuring
Predefined Constants
Connections and Connection management
Transactions and auto-commit
Prepared statements and stored procedures
Errors and error handling
Large Objects (LOBs)
PDO — The PDO class
- PDO::beginTransaction — Initiates a transaction
- PDO::commit — Commits a transaction
- 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 — Executes an SQL statement, returning a result set as a PDOStatement object
- PDO::quote — Quotes a string for use in a query.
- PDO::rollBack — Rolls back a transaction
- PDO::setAttribute — Set an attribute
PDOStatement — The PDOStatement class
- PDOStatement::bindColumn — Bind a column to a PHP variable
- PDOStatement::bindParam — Binds a parameter to the specified variable name
- PDOStatement::bindValue — Binds a value to a parameter
- PDOStatement::closeCursor — Closes the cursor, enabling the statement to be executed again.
- PDOStatement::columnCount — Returns the number of columns in the result set
- PDOStatement::debugDumpParams — Dump an SQL prepared command
- PDOStatement::errorCode — Fetch the SQLSTATE associated with the last operation on the statement handle
- PDOStatement::errorInfo — Fetch extended error information associated with the last operation on the statement handle
- PDOStatement::execute — Executes a prepared statement
- PDOStatement::fetch — Fetches the next row from a result set
- PDOStatement::fetchAll — Returns an array containing all of the result set rows
- PDOStatement::fetchColumn — Returns a single column from the next row of a result set
- PDOStatement::fetchObject — Fetches the next row and returns it as an object.
- PDOStatement::getAttribute — Retrieve a statement attribute
- PDOStatement::getColumnMeta — Returns metadata for a column in a result set
- PDOStatement::nextRowset — Advances to the next rowset in a multi-rowset statement handle
- PDOStatement::rowCount — Returns the number of rows affected by the last SQL statement
- PDOStatement::setAttribute — Set a statement attribute
- PDOStatement::setFetchMode — Set the default fetch mode for this statement
PDOException — The PDOException class
PDO Drivers
- CUBRID (PDO) — CUBRID Functions (PDO_CUBRID)
- MS SQL Server (PDO) — Microsoft SQL Server and Sybase Functions (PDO_DBLIB)
- Firebird (PDO) — Firebird Functions (PDO_FIREBIRD)
- IBM (PDO) — IBM Functions (PDO_IBM)
- Informix (PDO) — Informix Functions (PDO_INFORMIX)
- MySQL (PDO) — MySQL Functions (PDO_MYSQL)
- MS SQL Server (PDO) — Microsoft SQL Server Functions (PDO_SQLSRV)
- Oracle (PDO) — Oracle Functions (PDO_OCI)
- ODBC and DB2 (PDO) — ODBC and DB2 Functions (PDO_ODBC)
- PostgreSQL (PDO) — PostgreSQL Functions (PDO_PGSQL)
- SQLite (PDO) — SQLite Functions (PDO_SQLITE)
- 4D (PDO) — 4D Functions (PDO_4D)

The PDO class

Introduction

Represents a connection between PHP and a database server.

Class synopsis

PDO

class PDO {

public __construct ( string $dsn [, string $username [, string $password [, array $driver_options ]]] )

public bool beginTransaction ( void )

public bool commit ( void )

public mixed errorCode ( void )

public array errorInfo ( void )

public int exec ( string $statement )

public mixed getAttribute ( int $attribute )

public static array getAvailableDrivers ( void )

public bool inTransaction ( void )

public string lastInsertId ([ string $name = NULL ] )

public PDOStatement prepare ( string $statement [, array $driver_options = array() ] )

public PDOStatement query ( string $statement )

public string quote ( string $string [, int $parameter_type = PDO::PARAM_STR ] )

public bool rollBack ( void )

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

}

The PDOStatement class

Introduction

Represents a prepared statement and, after the statement is executed, an associated result set.

Class synopsis

PDOStatement

class PDOStatement implements Traversable {

/* Properties */

readonly string$queryString;

/* Methods */

public bool bindColumn ( mixed $column , mixed &$param [, int $type [, int $maxlen [, mixed $driverdata ]]] )

public bool bindParam ( mixed $parameter , mixed &$variable [, int $data_type = PDO::PARAM_STR [, int $length [, mixed $driver_options ]]] )

public bool bindValue ( mixed $parameter , mixed $value [, int $data_type = PDO::PARAM_STR ] )

public bool closeCursor ( void )

public int columnCount ( void )

public void debugDumpParams ( void )

public string errorCode ( void )

public array errorInfo ( void )

public bool execute ([ array $input_parameters ] )

public mixed fetch ([ int $fetch_style [, int $cursor_orientation = PDO::FETCH_ORI_NEXT [, int $cursor_offset = 0 ]]] )

public array fetchAll ([ int $fetch_style [, mixed $fetch_argument [, array $ctor_args = array() ]]] )

public string fetchColumn ([ int $column_number = 0 ] )

public mixed fetchObject ([ string $class_name = "stdClass" [, array $ctor_args ]] )

public mixed getAttribute ( int $attribute )

public array getColumnMeta ( int $column )

public bool nextRowset ( void )

public int rowCount ( void )

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

public bool setFetchMode ( int $mode )

}

Properties

queryString: Used query string.

The PDOException class

Introduction

Represents an error raised by PDO. You should not throw a PDOException from your own code. See Exceptions for more information about Exceptions in PHP.

Class synopsis

PDOException

class PDOException extends RuntimeException {

/* Properties */

public array $errorInfo ;

protected string $code ;

/* Inherited properties */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* Inherited methods */

final public string Exception::getMessage ( void )

final public Exception Exception::getPrevious ( void )

final public mixed Exception::getCode ( void )

final public string Exception::getFile ( void )

final public int Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private void Exception::__clone ( void )

}

Properties

errorInfo: Corresponds to PDO::errorInfo or PDOStatement::errorInfo
code: SQLSTATE error code. Use Exception::getCode to access it.