DatabaseQuery class

Located in file /wire/core/DatabaseQuery.php

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

Show class?             Show args?        

Common

NameReturnSummary 
DatabaseQuery::bindKeys array 
DatabaseQuery::bindOption($optionName)
string int arrayGet or set a bind option 
DatabaseQuery::bindOptions array 
DatabaseQuery::bindValue(string $key, mixed $value)
$thisBind a parameter value 
DatabaseQuery::bindValueGetKey($value)
stringBind value and get unique key that refers to it in one step 
DatabaseQuery::bindValues array 
DatabaseQuery::copyBindValuesTo($query)
intCopy bind values from this query to another given DatabaseQuery or \PDOStatement 
DatabaseQuery::copyTo(DatabaseQuery $query)
intCopy queries from this DatabaseQuery to another DatabaseQuery 
DatabaseQuery::execute()
PDOStatement boolExecute the query with the current database handle 
DatabaseQuery::getBindValues()
array intGet bind values, with options 
DatabaseQuery::getDebugQuery()
stringGet SQL query with bind params populated for debugging purposes (not to be used as actual query) 
DatabaseQuery::getQuery()
stringGenerate the SQL query based on everything set in this DatabaseQuery object 
DatabaseQuery::getQueryMethod(string $method)
stringReturn the generated SQL for specific query method 
DatabaseQuery::getSQL()
stringReturn generated SQL for entire query or specific method 
DatabaseQuery::getUniqueBindKey()
stringGet a unique key to use for bind value 
DatabaseQuery::prepare()
PDOStatementPrepare and return a PDOStatement 
DatabaseQuery::query string 
DatabaseQuery::sql string 
DatabaseQuery::where($sql)
$this)
Can also be used as property: DatabaseQuery::where

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #547
    In the 547th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a couple of new modules, and more. Read on!
    Weekly.pw / 2 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK