$database→execute()
Execute a PDO statement, with retry and error handling
Given a PDOStatement ($query) this method will execute the statement and return true or false as to whether it was successful.
Unlike other PDO methods, this one (native to ProcessWire) will retry queries that
failed due to a transient error such as a deadlock or lost connection. The retry policy
comes from $config->dbOptions['retry'] (see retryOptions()), but you can specify an
explicit max number of retries in the arguments.
Example
// prepare the query
$query = $database->prepare("SELECT id, name FROM pages LIMIT 10");
// you can do the following, rather than native PDO $query->execute();
$database->execute($query);Usage
// basic usage
$bool = $database->execute(\PDOStatement $query);
// usage with all arguments
$bool = $database->execute(\PDOStatement $query, bool $throw = true, $maxTries = null);Arguments
| Name | Type(s) | Description |
|---|---|---|
$query | \PDOStatement | |
$throw (optional) | bool | Whether or not to throw exception on query error Default:true |
$maxTries (optional) | int null | Max number of times to retry the query on a transient error, or null to use the configured retry policy Default:null |
Return value
boolTrue on success, false on failure. Note if you want this, specify $throw=false in your arguments.
Exceptions
Method can throw exceptions on error:
\PDOException
$database methods and properties
API reference based on ProcessWire core version 3.0.275