WireDatabasePDO / $database

prepare()

• Arguments: prepare($statement, $driver_options = [], $note = '')
• Returns: \PDOStatement|WireDatabasePDOStatement
• Purpose: Prepare SQL for bound parameters.

$query = $database->prepare("SELECT * FROM pages WHERE id=:id");
$query->bindValue(':id', 1234, \PDO::PARAM_INT);
$database->execute($query);

The $driver_options argument may be:

execute()

• Arguments: execute(\PDOStatement $query, $throw = true, $maxTries = 3)
• Returns: bool
• Purpose: Execute a prepared statement with ProcessWire retry/error handling.

$ok = $database->execute($query);
$ok = $database->execute($query, false); // return false rather than throw

query()

• Arguments: query($statement, $note = '')
• Returns: \PDOStatement
• Purpose: Execute SQL and return a result set.

$rows = $database->query("SELECT id FROM pages LIMIT 10");
foreach($rows as $row) {
    echo $row['id'];
}

exec()

• Arguments: exec($statement, $note = '')
• Returns: int|bool
• Purpose: Execute SQL and return the number of affected rows when available. If given a PDOStatement, it delegates to execute().

$n = $database->exec("UPDATE pages SET modified=modified WHERE id=1234");

lastInsertId()

• Arguments: lastInsertId($name = null)
• Returns: string
• Purpose: Return the last auto-increment ID from the writer connection.

Schema methods inspect database tables, columns and indexes.

getTables()

• Arguments: getTables($allowCache = true)
• Returns: array of table names

$tables = $database->getTables(false); // bypass cache

tableExists()

• Arguments: tableExists($table)
• Returns: bool

getColumns()

• Arguments: getColumns($table, $verbose = false)
• Returns: array
• Purpose: Get column names or verbose column info.

$names = $database->getColumns('pages');
$info  = $database->getColumns('pages', true);      // indexed by column name
$name  = $database->getColumns('pages', 'name');    // one column info

Verbose modes:

columnExists()

• Arguments: columnExists($table, $column = '', $getInfo = false)
• Returns: bool|array

$ok = $database->columnExists('pages', 'name');
$ok = $database->columnExists('pages.name');
$info = $database->columnExists('pages', 'name', true);

getIndexes()

• Arguments: getIndexes($table, $verbose = false)
• Returns: array

$indexes = $database->getIndexes('pages');
$info = $database->getIndexes('pages', true);
$primary = $database->getIndexes('pages.PRIMARY', true);

indexExists()

• Arguments: indexExists($table, $indexName, $getInfo = false)
• Returns: bool|array

getPrimaryKey()

• Arguments: getPrimaryKey($table, $verbose = false)
• Returns: string|array
• Purpose: Return primary key column(s), or verbose primary-key info.

renameColumn() / renameColumns()

• Arguments: renameColumn($table, $oldName, $newName), renameColumns($table, array $columns)
• Returns: bool for renameColumn(), int count for renameColumns()
• Purpose: Rename columns without changing type.

$database->renameColumn('my_table', 'old_name', 'new_name');
$database->renameColumns('my_table', [
    'old_a' => 'new_a',
    'old_b' => 'new_b',
]);

Use these helpers when building SQL identifiers or operator strings from dynamic values. They sanitize identifiers; they do not quote identifiers with backticks.

escapeTable() / escapeCol()

• Arguments: escapeTable($table), escapeCol($col)
• Returns: string containing only _a-zA-Z0-9

$table = $database->escapeTable($inputName);
$col = $database->escapeCol($inputColumn);

escapeTableCol()

• Arguments: escapeTableCol($str)
• Returns: sanitized table.column, table, or column string

$field = $database->escapeTableCol('pages.name');

isOperator()

• Arguments: isOperator($str, $operatorType = WireDatabasePDO::operatorTypeAny, $get = false)
• Returns: bool|string
• Purpose: Validate comparison or bitwise SQL operators.

if($database->isOperator($operator, WireDatabasePDO::operatorTypeComparison)) {
    // =, !=, <, <=, >, >=, <>
}

Operator type constants:

escapeOperator()

• Arguments: escapeOperator($operator, $operatorType = WireDatabasePDO::operatorTypeComparison, $default = '=')
• Returns: valid operator or fallback

quote()

• Arguments: quote($str)
• Returns: quoted and escaped string value, including surrounding quotes.

$sql = "name=" . $database->quote($name);

Prefer prepared statements for values whenever possible.

escapeStr()

• Arguments: escapeStr($str)
• Returns: escaped string without surrounding quotes.

escapeLike()

• Arguments: escapeLike($like)
• Returns: escaped string suitable for SQL LIKE values.

$like = '%' . $database->escapeLike($term) . '%';

queryLog()

• Arguments: queryLog($sql = '', $note = '')
• Returns: array|bool
• Purpose: Start, stop, reset, retrieve, or append to the in-memory query log.

$database->queryLog(true);          // reset and start
$database->query("SELECT 1", "note");
$log = $database->queryLog();       // retrieve
$database->queryLog(false);         // stop

Argument behavior:

Core automatically populates this log when ProcessWire debug mode is active.