$database API variable / WireDatabasePDO class

All database operations in ProcessWire are performed via this PDO-style database class.

ProcessWire creates the database connection automatically at boot and this is available from the $database API variable. If you want to create a new connection on your own, choose either option A or B below:

// The following are required to construct a WireDatabasePDO
$dsn = 'mysql:dbname=mydb;host=myhost;port=3306';
$username = 'username';
$password = 'password';
$driver_options = []; // optional

// Construct option A
$db = new WireDatabasePDO($dsn, $username, $password, $driver_options);

// Construct option B
$db = new WireDatabasePDO([
  'dsn' => $dsn,
  'user' => $username,
  'pass' => $password,
  'options' => $driver_options, // optional
  'reader' => [ // optional
    'dsn' => '…',
    …
  ],
  …
]);

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireDatabasePDO class also inherits all the methods and properties of: Wire.

Queries

Name	Return	Summary
$database->exec() $database->exec($statement) $database->exec($statement, string $note = '')	`bool` `int`	Execute an SQL statement string
$database->execute() $database->execute(\PDOStatement $query) $database->execute(\PDOStatement $query, bool $throw = true, int $maxTries = 3)	`bool`	Execute a PDO statement, with retry and error handling
$database->lastInsertId() $database->lastInsertId() $database->lastInsertId($name = null)	`string`	Returns the ID of the last inserted row or sequence value
$database->prepare() $database->prepare(string $statement) $database->prepare(string $statement, $driver_options = [], string $note = '')	`PDOStatement` `WireDatabasePDOStatement`	Prepare an SQL statement for accepting bound parameters
$database->query() $database->query(string $statement) $database->query(string $statement, string $note = '')	`PDOStatement`	Executes an SQL statement, returning a result set as a PDOStatement object

Transactions

Name	Return	Summary
$database->allowTransaction() $database->allowTransaction() $database->allowTransaction(string $table = '')	`bool`	Allow a new transaction to begin right now? (i.e. supported and not already in one)
$database->beginTransaction() $database->beginTransaction() $database->beginTransaction()	`bool`	Initiates a transaction
$database->commit() $database->commit() $database->commit()	`bool`	Commits a transaction
$database->inTransaction() $database->inTransaction() $database->inTransaction()	`bool`	Checks if inside a transaction
$database->rollBack() $database->rollBack() $database->rollBack()	`bool`	Rolls back a transaction
$database->supportsTransaction() $database->supportsTransaction() $database->supportsTransaction(string $table = '')	`bool`	Are transactions available with current DB engine (or table)?

Schema

Name	Return	Summary
$database->columnExists() $database->columnExists(string $table) $database->columnExists(string $table, string $column = '', bool $getInfo = false)	`bool` `array`	Does the given column exist in given table?
$database->getCharset() $database->getCharset() $database->getCharset()	`string`	Get current database charset (lowercase)
$database->getColumns() $database->getColumns(string $table) $database->getColumns(string $table, $verbose = false)	`array`	Get all columns from given table
$database->getEngine() $database->getEngine() $database->getEngine()	`string`	Get current database engine (lowercase)
$database->getIndexes() $database->getIndexes(string $table) $database->getIndexes(string $table, $verbose = false)	`array`	Get all indexes from given table
$database->getMaxIndexLength() $database->getMaxIndexLength() $database->getMaxIndexLength()	`int`	Get max length allowed for a fully indexed varchar column in ProcessWire
$database->getPrimaryKey() $database->getPrimaryKey(string $table) $database->getPrimaryKey(string $table, $verbose = false)	`string` `array`	Get column(s) or info for given table’s primary key/index
$database->getTables() $database->getTables() $database->getTables(bool $allowCache = true)	`array`	Get array of all tables in this database.
$database->indexExists() $database->indexExists(string $table, string $indexName) $database->indexExists(string $table, string $indexName, bool $getInfo = false)	`bool` `array`	Does table have an index with given name?
$database->renameColumn() $database->renameColumn(string $table, string $oldName, string $newName) $database->renameColumn(string $table, string $oldName, string $newName)	`bool`	Rename a table column without changing type
$database->renameColumns() $database->renameColumns(string $table, array $columns) $database->renameColumns(string $table, array $columns)	`int`	Rename table columns without changing type
$database->tableExists() $database->tableExists(string $table) $database->tableExists(string $table)	`bool`	Does the given table exist in this database?

Info

Name	Return	Summary
$database->getRegexEngine() $database->getRegexEngine() $database->getRegexEngine()	`string`	Get the regular expression engine used by database
$database->getServerType() $database->getServerType() $database->getServerType()	`string`	Get server type, one of MySQL, MariDB, Percona, etc.
$database->getStopwords() $database->getStopwords() $database->getStopwords(string $engine = '', bool $flip = false)	`array`	Get all fulltext stopwords for database engine
$database->getTime() $database->getTime() $database->getTime(bool $getTimestamp = false)	`string` `int`	Get current date/time ISO-8601 string or UNIX timestamp according to database
$database->getVariable() $database->getVariable(string $name) $database->getVariable(string $name, bool $cache = true, bool $sub = true)	`string` `null`	Get the value of a MySQL variable
$database->getVersion() $database->getVersion() $database->getVersion(bool $getNumberOnly = false)	`string`	Get MySQL/MariaDB version
$database->isOperator() $database->isOperator(string $str) $database->isOperator(string $str, $operatorType = 2, bool $get = false)	`bool`	Is the given string a database comparison operator?
$database->isStopword() $database->isStopword(string $word) $database->isStopword(string $word, string $engine = '')	`bool`	Is given word a fulltext stopword for database engine?
$database->lastInsertId() $database->lastInsertId() $database->lastInsertId($name = null)	`string`	Returns the ID of the last inserted row or sequence value

Sanitization

Name	Return	Summary
$database->escapeCol() $database->escapeCol(string $col) $database->escapeCol(string $col)	`string`	Sanitize a column name for _a-zA-Z0-9
$database->escapeLike() $database->escapeLike(string $like) $database->escapeLike(string $like)	`string`	Escape a string value, plus escape characters necessary for a MySQL 'LIKE' phrase
$database->escapeOperator() $database->escapeOperator(string $operator) $database->escapeOperator(string $operator, $operatorType = 0, string $default = '=')	`string`	Sanitize comparison operator
$database->escapeStr() $database->escapeStr(string $str) $database->escapeStr(string $str)	`string`	Escape a string value, same as $database->quote() but without surrounding quotes
$database->escapeTable() $database->escapeTable(string $table) $database->escapeTable(string $table)	`string`	Sanitize a table name for _a-zA-Z0-9
$database->escapeTableCol() $database->escapeTableCol(string $str) $database->escapeTableCol(string $str)	`string`	Sanitize a table.column string, where either part is optional
$database->quote() $database->quote(string $str) $database->quote(string $str)	`string`	Quote and escape a string value

Connection

Name	Return	Summary
$database->closeConnection() $database->closeConnection() $database->closeConnection()	(nothing)	Close the PDO connection
$database->errorCode() $database->errorCode() $database->errorCode()	`string`	Fetch the SQLSTATE associated with the last operation on the statement handle
$database->errorInfo() $database->errorInfo() $database->errorInfo()	`array`	Fetch extended error information associated with the last operation on the database handle
$database->getAttribute() $database->getAttribute(int $attribute) $database->getAttribute(int $attribute)	`mixed`	Retrieve a database connection attribute
$database->reset() $database->reset() $database->reset($type = null)	`self`	Reset the current PDO connection(s)
$database->setAttribute() $database->setAttribute(int $attribute, mixed $value) $database->setAttribute(int $attribute, mixed $value)	`bool`	Sets an attribute on the database handle

Custom

Name	Return	Summary
$database->backups() $database->backups() $database->backups()	`WireDatabaseBackup`	Retrieve new instance of WireDatabaseBackups ready to use with this connection
$database->queryLog() $database->queryLog() $database->queryLog($sql = '', string $note = '')	`array` `bool`	Log a query, start/stop query logging, or return logged queries
$database->sqlMode() $database->sqlMode() $database->sqlMode(string $action = 'get', string $mode = '', string $minVersion = '', $pdo = null)	`string` `bool`	Get SQL mode, set SQL mode, add to existing SQL mode, or remove from existing SQL mode

Additional methods and properties

In addition to the methods and properties above, WireDatabasePDO also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.248