QueryBuilder

API reference › yii › db › mysql › QueryBuilder

class	yii\db\mysql\QueryBuilder
Extends	yii\db\QueryBuilder » yii\base\BaseObject
Implements	yii\base\Configurable
Since	2.0
Source	framework/db/mysql/QueryBuilder.php

QueryBuilder is the query builder for MySQL databases (MySQL 8.0+ and MariaDB 10.6+).

Properties

Property	Type	Description	Defined by
$db	yii\db\Connection	The database connection. Default: null.	yii\db\QueryBuilder
$separator	string	The separator between different fragments of a SQL statement. Default: ' '.	yii\db\QueryBuilder
$typeMap	array	Mapping from abstract column types (keys) to physical column types (values). Default: [\yii\db\mysql\Schema::TYPE_PK => 'int NOT NULL AUTO_INCREMENT PRIMARY KEY', \yii\db\mysql\Schema::TYPE_UPK => 'int UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY', \yii\db\mysql\Schema::TYPE_BIGPK => 'bigint NOT NULL AUTO_INCREMENT PRIMARY KEY', \yii\db\mysql\Schema::TYPE_UBIGPK => 'bigint UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY', \yii\db\mysql\Schema::TYPE_CHAR => 'char(1)', \yii\db\mysql\Schema::TYPE_STRING => 'varchar(255)', \yii\db\mysql\Schema::TYPE_TEXT => 'text', \yii\db\mysql\Schema::TYPE_TINYINT => 'tinyint', \yii\db\mysql\Schema::TYPE_SMALLINT => 'smallint', \yii\db\mysql\Schema::TYPE_INTEGER => 'int', \yii\db\mysql\Schema::TYPE_BIGINT => 'bigint', \yii\db\mysql\Schema::TYPE_FLOAT => 'float', \yii\db\mysql\Schema::TYPE_DOUBLE => 'double', \yii\db\mysql\Schema::TYPE_DECIMAL => 'decimal(10,0)', \yii\db\mysql\Schema::TYPE_DATE => 'date', \yii\db\mysql\Schema::TYPE_BINARY => 'blob', \yii\db\mysql\Schema::TYPE_BOOLEAN => 'tinyint(1)', \yii\db\mysql\Schema::TYPE_MONEY => 'decimal(19,4)', \yii\db\mysql\Schema::TYPE_JSON => 'json'].	QueryBuilder
$conditionClasses protected	array	Map of condition aliases to condition classes. Default: []. Available since 2.0.14.	yii\db\QueryBuilder
$expressionBuilders protected	string[]|yii\db\ExpressionBuilderInterface[]	Maps expression class to expression builder class. Default: []. Available since 2.0.14.	yii\db\QueryBuilder

Methods

Method	Description	Defined by
__construct()	Constructor.	yii\db\QueryBuilder
__call()	Calls the named method which is not a class method.	yii\base\BaseObject
__get()	Returns the value of an object property.	yii\base\BaseObject
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
__set()	Sets value of an object property.	yii\base\BaseObject
__unset()	Sets an object property to null.	yii\base\BaseObject
addCheck()	Creates a SQL command for adding a check constraint to an existing table.	yii\db\QueryBuilder
addColumn()	Builds a SQL statement for adding a new DB column.	yii\db\QueryBuilder
addCommentOnColumn()	Builds a SQL command for adding comment to column.	QueryBuilder
addCommentOnTable()	Builds a SQL command for adding comment to table.	QueryBuilder
addDefaultValue()	Creates a SQL command for adding a default value constraint to an existing table.	yii\db\QueryBuilder
addForeignKey()	Builds a SQL statement for adding a foreign key constraint to an existing table.	yii\db\QueryBuilder
addPrimaryKey()	Builds a SQL statement for adding a primary key constraint to an existing table.	yii\db\QueryBuilder
addUnique()	Creates a SQL command for adding an unique constraint to an existing table.	yii\db\QueryBuilder
alterColumn()	Builds a SQL statement for changing the definition of a column.	yii\db\QueryBuilder
batchInsert()	Generates a batch INSERT SQL statement.	yii\db\QueryBuilder
bindParam()	Helper method to add $value to $params array using PARAM_PREFIX.	yii\db\QueryBuilder
build()	Generates a SELECT SQL statement from a Query object.	yii\db\QueryBuilder
buildColumns()	Processes columns and properly quotes them if necessary.	yii\db\QueryBuilder
buildCondition()	Parses the condition specification and generates the corresponding SQL expression.	yii\db\QueryBuilder
buildExpression()	Builds given $expression	yii\db\QueryBuilder
buildFrom()		yii\db\QueryBuilder
buildGroupBy()		yii\db\QueryBuilder
buildHaving()		yii\db\QueryBuilder
buildJoin()		yii\db\QueryBuilder
buildLimit()		QueryBuilder
buildOrderBy()		yii\db\QueryBuilder
buildOrderByAndLimit()	Builds the ORDER BY and LIMIT/OFFSET clauses and appends them to the given SQL.	yii\db\QueryBuilder
buildSelect()		yii\db\QueryBuilder
buildUnion()		yii\db\QueryBuilder
buildUnionOrderByAndLimit()	Builds the global ORDER BY and LIMIT/OFFSET clauses for a UNION query.	yii\db\QueryBuilder
buildWhere()		yii\db\QueryBuilder
buildWithQueries()		yii\db\QueryBuilder
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\BaseObject
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\BaseObject
checkIntegrity()	Builds a SQL statement for enabling or disabling integrity check.	QueryBuilder
className() static	Returns the fully qualified name of this class.	yii\base\BaseObject
createConditionFromArray()	Transforms $condition defined in array format (as described in Query::where() to instance of ConditionInterface according to $conditionClasses map.	yii\db\QueryBuilder
createIndex()	Builds a SQL statement for creating a new index.	QueryBuilder
createTable()	Builds a SQL statement for creating a new DB table.	yii\db\QueryBuilder
createView()	Creates a SQL View.	yii\db\QueryBuilder
delete()	Creates a DELETE SQL statement.	yii\db\QueryBuilder
dropCheck()	Creates a SQL command for dropping a check constraint.	yii\db\QueryBuilder
dropColumn()	Builds a SQL statement for dropping a DB column.	yii\db\QueryBuilder
dropCommentFromColumn()	Builds a SQL command for adding comment to column.	QueryBuilder
dropCommentFromTable()	Builds a SQL command for adding comment to table.	QueryBuilder
dropDefaultValue()	Creates a SQL command for dropping a default value constraint.	yii\db\QueryBuilder
dropForeignKey()	Builds a SQL statement for dropping a foreign key constraint.	QueryBuilder
dropIndex()	Builds a SQL statement for dropping an index.	yii\db\QueryBuilder
dropPrimaryKey()	Builds a SQL statement for removing a primary key constraint from an existing table.	QueryBuilder
dropTable()	Builds a SQL statement for dropping a DB table.	yii\db\QueryBuilder
dropUnique()	Creates a SQL command for dropping an unique constraint.	QueryBuilder
dropView()	Drops a SQL View.	yii\db\QueryBuilder
executeResetSequence()	Execute a SQL statement for resetting the sequence value of a table’s primary key.	yii\db\QueryBuilder
getColumnType()	Converts an abstract column type into a physical column type.	yii\db\QueryBuilder
getExpressionBuilder()	Gets object of ExpressionBuilderInterface that is suitable for $expression.	yii\db\QueryBuilder
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\BaseObject
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\BaseObject
init()	Initializes the object.	QueryBuilder
insert()	Creates an INSERT SQL statement.	yii\db\QueryBuilder
isMariaDb()	Returns whether the connected server is MariaDB.	QueryBuilder
renameColumn()	Builds a SQL statement for renaming a column.	yii\db\QueryBuilder
renameTable()	Builds a SQL statement for renaming a DB table.	yii\db\QueryBuilder
resetSequence()	Creates a SQL statement for resetting the sequence value of a table’s primary key.	QueryBuilder
selectExists()	Creates a SELECT EXISTS() SQL statement.	QueryBuilder
setConditionClasses()	Setter for $conditionClasses property.	yii\db\QueryBuilder
setExpressionBuilders()	Setter for $expressionBuilders property.	yii\db\QueryBuilder
truncateTable()	Builds a SQL statement for truncating a DB table.	yii\db\QueryBuilder
update()	Creates an UPDATE SQL statement.	yii\db\QueryBuilder
upsert()	Creates an SQL statement to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.	QueryBuilder
buildOffsetFetch() protected	Builds the OFFSET/FETCH clauses for MariaDB 10.6 or newer.	QueryBuilder
concatUnionSql() protected	Concatenates the first SELECT statement with the UNION clauses built by buildUnion().	yii\db\QueryBuilder
defaultConditionClasses() protected	Contains array of default condition classes. Extend this method, if you want to change default condition classes for the query builder. See $conditionClasses docs for details.	yii\db\QueryBuilder
defaultExpressionBuilders() protected	Contains array of default expression builders. Extend this method and override it, if you want to change default expression builders for this query builder. See $expressionBuilders docs for details.	QueryBuilder
extractAlias() protected	Extracts table alias if there is one or returns false	yii\db\QueryBuilder
hasLimit() protected	Checks to see if the given limit is effective.	QueryBuilder
hasOffset() protected	Checks to see if the given offset is effective.	QueryBuilder
prepareInsertSelectSubQuery() protected	Prepare select-subquery and field names for INSERT INTO … SELECT SQL statement.	yii\db\QueryBuilder
prepareInsertValues() protected	Prepares a VALUES part for an INSERT SQL statement.	QueryBuilder
prepareSelectQuery() protected	Performs driver-specific preparation after Query::prepare().	yii\db\QueryBuilder
prepareUpdateSets() protected	Prepares a SET parts for an UPDATE SQL statement.	yii\db\QueryBuilder
prepareUpsertColumns() protected		yii\db\QueryBuilder
prepareUpsertSets() protected	Prepares the SET assignments for the update branch of an upsert statement.	yii\db\QueryBuilder

Constants

Constant	Value	Description	Defined by
PARAM_PREFIX	':qp'	The prefix for automatically generated query binding parameters.	yii\db\QueryBuilder

Method details

addCommentOnColumn()

public function addCommentOnColumn(mixed $table, mixed $column, mixed $comment): string

Builds a SQL command for adding comment to column.

Parameters

Parameter	Type	Description
$table	mixed	The table whose column is to be commented. The table name will be properly quoted by the method.
$column	mixed	The name of the column to be commented. The column name will be properly quoted by the method.
$comment	mixed	The text of the comment to be added. The comment will be properly quoted by the method.

Returns

string: The SQL statement for adding comment on column

Since

2.0.8

addCommentOnTable()

public function addCommentOnTable(mixed $table, mixed $comment): string

Builds a SQL command for adding comment to table.

Parameters

Parameter	Type	Description
$table	mixed	The table whose column is to be commented. The table name will be properly quoted by the method.
$comment	mixed	The text of the comment to be added. The comment will be properly quoted by the method.

Returns

string: The SQL statement for adding comment on table

Since

2.0.8

buildLimit()

public function buildLimit(mixed $limit, mixed $offset): string

Parameters

Parameter	Type	Description
$limit	mixed
$offset	mixed

Returns

string: The LIMIT and OFFSET clauses

checkIntegrity()

public function checkIntegrity(bool $check = true, string $schema = '', string $table = ''): string

Builds a SQL statement for enabling or disabling integrity check.

Parameters

Parameter	Type	Description
$check	bool	Whether to turn on or off the integrity check.
$schema	string	The schema of the tables. Meaningless for MySQL.
$table	string	The table name. Meaningless for MySQL.

Returns

string: The SQL statement for checking integrity

createIndex()

public function createIndex(string $name, string $table, array|string $columns, bool $unique = false): string

Builds a SQL statement for creating a new index.

MySQL emits ALTER TABLE ... ADD [UNIQUE] INDEX instead of CREATE INDEX.

Parameters

Parameter	Type	Description
$name	string	The name of the index. The name will be properly quoted by the method.
$table	string	The table that the new index will be created for. The name will be properly quoted by the method.
$columns	array|string	The column(s) that should be included in the index. If there are multiple columns, separate them with commas or use an array to represent them. Each column name will be properly quoted by the method, unless a parenthesis is found in the name.
$unique	bool	Whether to add a UNIQUE constraint on the created index.

Returns

string: The SQL statement for creating a new index.

See also

• https://bugs.mysql.com/bug.php?id=48875

dropCommentFromColumn()

public function dropCommentFromColumn(mixed $table, mixed $column): string

Builds a SQL command for adding comment to column.

Parameters

Parameter	Type	Description
$table	mixed	The table whose column is to be commented. The table name will be properly quoted by the method.
$column	mixed	The name of the column to be commented. The column name will be properly quoted by the method.

Returns

string: The SQL statement for adding comment on column

Since

2.0.8

dropCommentFromTable()

public function dropCommentFromTable(mixed $table): string

Builds a SQL command for adding comment to table.

Parameters

Parameter	Type	Description
$table	mixed	The table whose column is to be commented. The table name will be properly quoted by the method.

Returns

string: The SQL statement for adding comment on column

Since

2.0.8

dropForeignKey()

public function dropForeignKey(string $name, string $table): string

Builds a SQL statement for dropping a foreign key constraint.

MySQL emits ALTER TABLE ... DROP FOREIGN KEY instead of the standard DROP CONSTRAINT.

Parameters

Parameter	Type	Description
$name	string	The name of the foreign key constraint to be dropped. The name will be properly quoted by the method.
$table	string	The table whose foreign key is to be dropped. The name will be properly quoted by the method.

Returns

string: The SQL statement for dropping a foreign key constraint.

dropPrimaryKey()

public function dropPrimaryKey(string $name, string $table): string

Builds a SQL statement for removing a primary key constraint from an existing table.

MySQL emits ALTER TABLE ... DROP PRIMARY KEY and ignores the constraint name, since a MySQL primary key is always named PRIMARY.

Parameters

Parameter	Type	Description
$name	string	The name of the primary key constraint to be removed. Ignored by MySQL.
$table	string	The table that the primary key constraint will be removed from. The name will be properly quoted by the method.

Returns

string: The SQL statement for removing a primary key constraint from an existing table.

dropUnique()

public function dropUnique(mixed $name, mixed $table): string

Creates a SQL command for dropping an unique constraint.

Parameters

Parameter	Type	Description
$name	mixed	The name of the unique constraint to be dropped. The name will be properly quoted by the method.
$table	mixed	The table whose unique constraint is to be dropped. The name will be properly quoted by the method.

Returns

string: The SQL statement for dropping an unique constraint.

Since

2.0.13

init()

public function init(): mixed

Initializes the object.

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

Returns

mixed

isMariaDb()

public function isMariaDb(): bool

Returns whether the connected server is MariaDB.

Returns

bool: Whether the connected server is MariaDB.

resetSequence()

public function resetSequence(string $tableName, int|null $value = null): string

Creates a SQL statement for resetting the sequence value of a table’s primary key.

The sequence will be reset such that the primary key of the next new row inserted will have the specified value or the maximum existing value +1.

Parameters

Parameter	Type	Description
$tableName	string	The name of the table whose primary key sequence will be reset.
$value	int|null	The integer value for the primary key of the next new row inserted. If this is not set, the next new row’s primary key will have the maximum existing value +1.

Returns

string: The SQL statement for resetting sequence.

Throws

• yii\base\InvalidArgumentException: if the table does not exist or there is no sequence associated with the table.

selectExists()

public function selectExists(mixed $rawSql): string

Creates a SELECT EXISTS() SQL statement.

Parameters

Parameter	Type	Description
$rawSql	mixed	The subquery in a raw form to select from.

Returns

string: The SELECT EXISTS() SQL statement.

Since

2.0.8

upsert()

public function upsert(mixed $table, mixed $insertColumns, mixed $updateColumns, mixed &$params): string

Creates an SQL statement to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.

For example,

$sql = $queryBuilder->upsert('pages', [
    'name' => 'Front page',
    'url' => 'https://example.com/', // url is unique
    'visits' => 0,
], [
    'visits' => new \yii\db\Expression('visits + 1'),
], $params);

The method will properly escape the table and column names.

Parameters

Parameter	Type	Description
$table	mixed	The table that new rows will be inserted into/updated in.
$insertColumns	mixed	The column data (name => value) to be inserted into the table or instance of Query to perform INSERT INTO ... SELECT SQL statement.
$updateColumns	mixed	The column data (name => value) to be updated if they already exist. If true is passed, the column data will be updated to match the insert column data. If false is passed, no update will be performed if the column data already exists.
$params	mixed	The binding parameters that will be generated by this method. They should be bound to the DB command later.

Returns

string: The resulting SQL.

Throws

• yii\base\NotSupportedException: if this is not supported by the underlying DBMS.

Since

2.0.14

See also

• https://dev.mysql.com/doc/refman/8.0/en/insert-on-duplicate.html

buildOffsetFetch()

protected function buildOffsetFetch(int|yii\db\Expression $limit, int|yii\db\Expression $offset): string

Builds the OFFSET/FETCH clauses for MariaDB 10.6 or newer.

Parameters

Parameter	Type	Description
$limit	int|yii\db\Expression	The limit number. See Query::limit() for more details.
$offset	int|yii\db\Expression	The offset number. See Query::offset() for more details.

Returns

string: SQL statement for OFFSET/FETCH clauses.

defaultExpressionBuilders()

protected function defaultExpressionBuilders(): array

Contains array of default expression builders. Extend this method and override it, if you want to change default expression builders for this query builder. See $expressionBuilders docs for details.

Returns

array

Since

2.0.14

hasLimit()

protected function hasLimit(mixed $limit): bool

Checks to see if the given limit is effective.

Parameters

Parameter	Type	Description
$limit	mixed	The given limit

Returns

bool: Whether the limit is effective

hasOffset()

protected function hasOffset(mixed $offset): bool

Checks to see if the given offset is effective.

Parameters

Parameter	Type	Description
$offset	mixed	The given offset

Returns

bool: Whether the offset is effective

prepareInsertValues()

protected function prepareInsertValues(mixed $table, mixed $columns, mixed $params = []): array

Prepares a VALUES part for an INSERT SQL statement.

Parameters

Parameter	Type	Description
$table	mixed	The table that new rows will be inserted into.
$columns	mixed	The column data (name => value) to be inserted into the table or instance of Query to perform INSERT INTO … SELECT SQL statement.
$params	mixed	The binding parameters that will be generated by this method. They should be bound to the DB command later.

Returns

array: Array of column names, placeholders, values and params.

Since

2.0.14