Query

Type
Class
Namespace
craft\db
Inherits
craft\db\Query » yii\db\Query » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable, yii\db\ExpressionInterface, yii\db\QueryInterface
Uses traits
craft\base\ClonefixTrait, yii\db\QueryTrait
Extended by
craft\elements\db\AssetQuery, craft\elements\db\CategoryQuery, craft\elements\db\ElementQuery, craft\elements\db\EntryQuery, craft\elements\db\GlobalSetQuery, craft\elements\db\MatrixBlockQuery, craft\elements\db\TagQuery, craft\elements\db\UserQuery
Since
3.0

Class Query

View source

Public Properties

PropertyDescription
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$distinctboolean – Whether to select distinct rows of data only.
$emulateExecutionboolean – Whether to emulate the actual query execution, returning empty or false results.
$fromarray – The table(s) to be selected from.
$groupByarray – How to group the query results.
$havingstring, array, yii\db\ExpressionInterface – The condition to be applied in the GROUP BY clause.
$indexBystring, callable – The name of the column by which the query results should be indexed by.
$joinarray – How to join with other tables.
$limitinteger, yii\db\ExpressionInterface – Maximum number of records to be returned.
$offsetinteger, yii\db\ExpressionInterface – Zero-based offset from where the records are to be returned.
$orderByarray – How to sort the query results.
$paramsarray – List of query parameter values indexed by parameter placeholders.
$queryCacheDependencyyii\caching\Dependency – The dependency to be associated with the cached query result for this query
$queryCacheDurationinteger, true – The default number of seconds that query results can remain valid in cache.
$rawSqlstring
$selectarray – The columns being selected.
$selectOptionstring – Additional option that should be appended to the 'SELECT' keyword.
$tablesUsedInFromstring[] – Table names indexed by aliases
$unionarray – This is used to construct the UNION clause(s) in a SQL statement.
$wherestring, array – Query condition.

$rawSql

Type
string
Access
Read-only

View source

Signature

public string getRawSql ( yii\db\Connection $db = null )

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__toString()Returns the SQL representation of Query
__unset()Sets an object property to null.
addGroupBy()Adds additional group-by columns to the existing ones.
addOrderBy()Adds additional ORDER BY columns to the query.
addParams()Adds additional parameters to be bound to the query.
addSelect()Add more columns to the SELECT part of the query.
all()Executes the query and returns all results as an array.
andFilterCompare()Adds a filtering condition for a specific column and allow the user to choose a filter operator.
andFilterHaving()Adds an additional HAVING condition to the existing one but ignores empty operands.
andFilterWhere()Adds an additional WHERE condition to the existing one but ignores empty operands.
andHaving()Adds an additional HAVING condition to the existing one.
andWhere()Adds an additional WHERE condition to the existing one.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
average()Returns the average of the specified column values.
batch()Starts a batch query.
behaviors()Returns a list of behaviors that this component should behave as.
cache()Enables query cache for this Query.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
column()Executes the query and returns the first column of the result.
count()Returns the number of records.
create()Creates a new Query object and copies its property values from an existing one.
createCommand()Creates a DB command that can be used to execute this query.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
distinct()Sets the value indicating whether to SELECT DISTINCT or not.
each()Starts a batch query and retrieves data row by row.
emulateExecution()Sets whether to emulate query execution, preventing any interaction with data storage.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
exists()Returns a value indicating whether the query result contains any row of data.
filterHaving()Sets the HAVING part of the query but ignores empty operands.
filterWhere()Sets the WHERE part of the query but ignores empty operands.
from()Sets the FROM part of the query.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getRawSql()Shortcut for createCommand()->getRawSql().
getTablesUsedInFrom()Returns table names used in from() indexed by aliases.
groupBy()Sets the GROUP BY part of the query.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
having()Sets the HAVING part of the query.
indexBy()Sets the indexBy() property.
init()Initializes the object.
innerJoin()Appends an INNER JOIN part to the query.
isJoined()Returns whether a given table has been joined in this query.
join()Appends a JOIN part to the query.
leftJoin()Appends a LEFT OUTER JOIN part to the query.
limit()Sets the LIMIT part of the query.
max()Returns the maximum of the specified column values.
min()Returns the minimum of the specified column values.
noCache()Disables query cache for this Query.
nth()Executes the query and returns a single row of result at a given offset.
off()Detaches an existing event handler from this component.
offset()Sets the OFFSET part of the query.
on()Attaches an event handler to an event.
one()Executes the query and returns a single row of result.
orFilterHaving()Adds an additional HAVING condition to the existing one but ignores empty operands.
orFilterWhere()Adds an additional WHERE condition to the existing one but ignores empty operands.
orHaving()Adds an additional HAVING condition to the existing one.
orWhere()Adds an additional WHERE condition to the existing one.
orderBy()Sets the ORDER BY part of the query.
pairs()Executes the query and returns the first two columns in the results as key/value pairs.
params()Sets the parameters to be bound to the query.
populate()Converts the raw query results into the format as specified by this query.
prepare()Prepares for building SQL.
rightJoin()Appends a RIGHT OUTER JOIN part to the query.
scalar()Returns the query result as a scalar value.
select()Sets the SELECT part of the query.
sum()Returns the sum of the specified column values.
trigger()Triggers an event.
union()Appends a SQL statement using UNION operator.
where()Sets the WHERE part of the query.

all()

Executes the query and returns all results as an array.

View source

Arguments

  • $db (yii\db\Connection) – The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Returns

array – The query results. If the query results in nothing, an empty array will be returned.

Signature

public array all ( $db = null )

andWhere()

Adds an additional WHERE condition to the existing one.

The new condition and the existing one will be joined using the AND operator.

View source

Arguments

Returns

$this – The query object itself

Signature

public $this andWhere ( $condition, $params = [] )

behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from \craft\db\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

View source

Returns

array – The behavior configurations.

Signature

public array behaviors ( )

column()

Executes the query and returns the first column of the result.

View source

Arguments

  • $db (yii\db\Connection) – The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Returns

array – The first column of the query result. An empty array is returned if the query results in nothing.

Signature

public array column ( $db = null )

exists()

Returns a value indicating whether the query result contains any row of data.

View source

Arguments

  • $db (yii\db\Connection) – The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Returns

boolean – Whether the query result contains any row of data.

Signature

public boolean exists ( $db = null )

getRawSql()

Shortcut for createCommand()->getRawSql().

See also:

View source

Arguments

  • $db (yii\db\Connection, null) – The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Returns

string

Signature

public string getRawSql ( yii\db\Connection $db = null )

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

Signature

public void init ( )

isJoined()

Returns whether a given table has been joined in this query.

View source

Arguments

Returns

boolean

Signature

public boolean isJoined ( \craft\db\string $table )

nth()

Executes the query and returns a single row of result at a given offset.

View source

Arguments

  • $n (integer) – The offset of the row to return. If offset() is set, $offset will be added to it.
  • $db (yii\db\Connection, null) – The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Returns

array, null – The row (in terms of an array) of the query result. Null is returned if the query results in nothing.

Signature

public array, null nth ( \craft\db\int $n, yii\db\Connection $db = null )

one()

Executes the query and returns a single row of result.

View source

Arguments

  • $db (yii\db\Connection) – The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Returns

array, null – The first row (in terms of an array) of the query result. Null is returned if the query results in nothing.

Signature

public array, null one ( $db = null )

orWhere()

Adds an additional WHERE condition to the existing one.

The new condition and the existing one will be joined using the OR operator.

View source

Arguments

Returns

$this – The query object itself

Signature

public $this orWhere ( $condition, $params = [] )

pairs()

Executes the query and returns the first two columns in the results as key/value pairs.

View source

Arguments

  • $db (yii\db\Connection, null) – The database connection used to execute the query. If this parameter is not given, the db application component will be used.

Returns

array – The query results. If the query results in nothing, an empty array will be returned.

Throws

Signature

public array pairs ( yii\db\Connection $db = null )

scalar()

Returns the query result as a scalar value.

The value returned will be the first column in the first row of the query results.

View source

Arguments

  • $db (yii\db\Connection) – The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Returns

string, null, false – The value of the first column in the first row of the query result. False is returned if the query result is empty.

Signature

public string, null, false scalar ( $db = null )

where()

Sets the WHERE part of the query.

The method requires a $condition parameter, and optionally a $params parameter specifying the values to be bound to the query.

The $condition parameter should be either a string (e.g. 'id=1') or an array.

{@inheritdoc}

View source

Arguments

Returns

$this – The query object itself

Signature

public $this where ( $condition, $params = [] )

Protected Methods

MethodDescription
cleanUpTableNames()Clean up table names and aliases Both aliases and names are enclosed into .
filterCondition()Removes empty operands from the given query condition.
getUnaliasedColumnsFromSelect()
getUniqueColumns()Returns unique column names excluding duplicates.
isEmpty()Returns a value indicating whether the give value is "empty".
normalizeOrderBy()Normalizes format of ORDER BY data.
queryScalar()Queries a scalar value by setting select() first.
setCommandCache()Sets $command cache, if this query has enabled caching.

queryScalar()

Queries a scalar value by setting select() first.

Restores the value of select to make this query reusable.

View source

Arguments

Returns

boolean, string

Signature

protected boolean, string queryScalar ( $selectExpression, $db )

Events

EVENT_DEFINE_BEHAVIORS

Type
craft\events\DefineBehaviorsEvent

The event that is triggered when defining the class behaviors

See also behaviors()

EVENT_INIT

Type
yii\base\Event

The event that is triggered after the query's init cycle

See also init()