Class yii\db\QueryBuilder

All Classes | Properties | Methods | Constants
Inheritanceyii\db\QueryBuilder » yii\base\BaseObject
Implementsyii\base\Configurable
Subclassesyii\db\cubrid\QueryBuilder, yii\db\mssql\QueryBuilder, yii\db\mysql\QueryBuilder, yii\db\oci\QueryBuilder, yii\db\pgsql\QueryBuilder, yii\db\sqlite\QueryBuilder
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/db/QueryBuilder.php

QueryBuilder builds a SELECT SQL statement based on the specification given as a yii\db\Query object.

SQL statements are created from yii\db\Query objects using the build()-method.

QueryBuilder is also used by yii\db\Command to build SQL statements such as INSERT, UPDATE, DELETE, CREATE TABLE.

For more details and usage information on QueryBuilder, see the guide article on query builders.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$db yii\db\Connection The database connection. yii\db\QueryBuilder
$separator string The separator between different fragments of a SQL statement. yii\db\QueryBuilder
$typeMap array The abstract column types mapped to physical column types. yii\db\QueryBuilder

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$conditionBuilders array Map of query condition to builder methods. yii\db\QueryBuilder
$conditionClasses array Map of condition aliases to condition classes. yii\db\QueryBuilder
$expressionBuilders string[]|yii\db\ExpressionBuilderInterface[] Maps expression class to expression builder class. yii\db\QueryBuilder

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\db\QueryBuilder
__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. yii\db\QueryBuilder
addCommentOnTable() Builds a SQL command for adding comment to table. yii\db\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 yii\db\Query object. yii\db\QueryBuilder
buildAndCondition() Connects two or more SQL expressions with the AND or OR operator. yii\db\QueryBuilder
buildBetweenCondition() Creates an SQL expressions with the BETWEEN operator. 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
buildExistsCondition() Creates an SQL expressions with the EXISTS operator. yii\db\QueryBuilder
buildExpression() Builds given $expression yii\db\QueryBuilder
buildFrom() yii\db\QueryBuilder
buildGroupBy() yii\db\QueryBuilder
buildHashCondition() Creates a condition based on column-value pairs. yii\db\QueryBuilder
buildHaving() yii\db\QueryBuilder
buildInCondition() Creates an SQL expressions with the IN operator. yii\db\QueryBuilder
buildJoin() yii\db\QueryBuilder
buildLikeCondition() Creates an SQL expressions with the LIKE operator. yii\db\QueryBuilder
buildLimit() yii\db\QueryBuilder
buildNotCondition() Inverts an SQL expressions with NOT operator. yii\db\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
buildSimpleCondition() Creates an SQL expressions like "column" operator value. yii\db\QueryBuilder
buildUnion() 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. yii\db\QueryBuilder
className() Returns the fully qualified name of this class. yii\base\BaseObject
createConditionFromArray() Transforms $condition defined in array format (as described in yii\db\Query::where() to instance of yii\db\condition\ConditionInterface according to $conditionClasses map. yii\db\QueryBuilder
createIndex() Builds a SQL statement for creating a new index. yii\db\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. yii\db\QueryBuilder
dropCommentFromTable() Builds a SQL command for adding comment to table. yii\db\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. yii\db\QueryBuilder
dropIndex() Builds a SQL statement for dropping an index. yii\db\QueryBuilder
dropPrimaryKey() Builds a SQL statement for removing a primary key constraint to an existing table. yii\db\QueryBuilder
dropTable() Builds a SQL statement for dropping a DB table. yii\db\QueryBuilder
dropUnique() Creates a SQL command for dropping an unique constraint. yii\db\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 yii\db\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. yii\db\QueryBuilder
insert() Creates an INSERT SQL statement. yii\db\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. yii\db\QueryBuilder
selectExists() Creates a SELECT EXISTS() SQL statement. yii\db\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. yii\db\QueryBuilder

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
defaultConditionClasses() 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() 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. yii\db\QueryBuilder
extractAlias() Extracts table alias if there is one or returns false yii\db\QueryBuilder
hasLimit() Checks to see if the given limit is effective. yii\db\QueryBuilder
hasOffset() Checks to see if the given offset is effective. yii\db\QueryBuilder
prepareInsertSelectSubQuery() Prepare select-subquery and field names for INSERT INTO . yii\db\QueryBuilder
prepareInsertValues() Prepares a VALUES part for an INSERT SQL statement. yii\db\QueryBuilder
prepareUpdateSets() Prepares a SET parts for an UPDATE SQL statement. yii\db\QueryBuilder
prepareUpsertColumns() yii\db\QueryBuilder

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
PARAM_PREFIX ':qp' The prefix for automatically generated query binding parameters. yii\db\QueryBuilder

Property Details

$conditionBuilders protected property
Deprecated since 2.0.14. Is not used, will be dropped in 2.1.0.

Map of query condition to builder methods. These methods are used by buildCondition() to build SQL conditions from array syntax.

protected array $conditionBuilders = []
$conditionClasses protected property (available since version 2.0.14)

Map of condition aliases to condition classes. For example:

return [
    'LIKE' => yii\db\condition\LikeCondition::class,
];

This property is used by createConditionFromArray() method. See default condition classes list in defaultConditionClasses() method.

In case you want to add custom conditions support, use the setConditionClasses() method.

See also:

protected array $conditionClasses = []
$db public property

The database connection.

public yii\db\Connection $db = null
$expressionBuilders protected property (available since version 2.0.14)

Maps expression class to expression builder class. For example:

[
   yii\db\Expression::class => yii\db\ExpressionBuilder::class
]

This property is mainly used by buildExpression() to build SQL expressions form expression objects. See default values in defaultExpressionBuilders() method.

To override existing builders or add custom, use setExpressionBuilder() method. New items will be added to the end of this array.

To find a builder, buildExpression() will check the expression class for its exact presence in this map. In case it is NOT present, the array will be iterated in reverse direction, checking whether the expression extends the class, defined in this map.

See also:

protected string[]|yii\db\ExpressionBuilderInterface[] $expressionBuilders = []
$separator public property

The separator between different fragments of a SQL statement. Defaults to an empty space. This is mainly used by build() when generating a SQL statement.

public string $separator = ' '
$typeMap public property

The abstract column types mapped to physical column types. This is mainly used to support creating/modifying tables using DB-independent data type specifications. Child classes should override this property to declare supported type mappings.

public array $typeMap = []

Method Details

__construct() public method

Constructor.

public void __construct ( $connection, $config = [] )
$connection yii\db\Connection

The database connection.
$config array

Name-value pairs that will be used to initialize the object properties
addCheck() public method (available since version 2.0.13)

Creates a SQL command for adding a check constraint to an existing table.

public string addCheck ( $name, $table, $expression )
$name string

The name of the check constraint. The name will be properly quoted by the method.
$table string

The table that the check constraint will be added to. The name will be properly quoted by the method.
$expression string

The SQL of the CHECK constraint.
return string

The SQL statement for adding a check constraint to an existing table.
addColumn() public method

Builds a SQL statement for adding a new DB column.

public string addColumn ( $table, $column, $type )
$table string

The table that the new column will be added to. The table name will be properly quoted by the method.
$column string

The name of the new column. The name will be properly quoted by the method.
$type string

The column type. The getColumnType() method will be invoked to convert abstract column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'.
return string

The SQL statement for adding a new column.
addCommentOnColumn() public method (available since version 2.0.8)

Builds a SQL command for adding comment to column.

public string addCommentOnColumn ( $table, $column, $comment )
$table string

The table whose column is to be commented. The table name will be properly quoted by the method.
$column string

The name of the column to be commented. The column name will be properly quoted by the method.
$comment string

The text of the comment to be added. The comment will be properly quoted by the method.
return string

The SQL statement for adding comment on column
addCommentOnTable() public method (available since version 2.0.8)

Builds a SQL command for adding comment to table.

public string addCommentOnTable ( $table, $comment )
$table string

The table whose column is to be commented. The table name will be properly quoted by the method.
$comment string

The text of the comment to be added. The comment will be properly quoted by the method.
return string

The SQL statement for adding comment on table
addDefaultValue() public method (available since version 2.0.13)

Creates a SQL command for adding a default value constraint to an existing table.

public string addDefaultValue ( $name, $table, $column, $value )
$name string

The name of the default value constraint. The name will be properly quoted by the method.
$table string

The table that the default value constraint will be added to. The name will be properly quoted by the method.
$column string

The name of the column to that the constraint will be added on. The name will be properly quoted by the method.
$value mixed

Default value.
return string

The SQL statement for adding a default value constraint to an existing table.
throws yii\base\NotSupportedException

if this is not supported by the underlying DBMS.
addForeignKey() public method

Builds a SQL statement for adding a foreign key constraint to an existing table.

The method will properly quote the table and column names.

public string addForeignKey ( $name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null )
$name string

The name of the foreign key constraint.
$table string

The table that the foreign key constraint will be added to.
$columns string|array

The name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array to represent them.
$refTable string

The table that the foreign key references to.
$refColumns string|array

The name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array to represent them.
$delete string

The ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
$update string

The ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
return string

The SQL statement for adding a foreign key constraint to an existing table.
addPrimaryKey() public method

Builds a SQL statement for adding a primary key constraint to an existing table.

public string addPrimaryKey ( $name, $table, $columns )
$name string

The name of the primary key constraint.
$table string

The table that the primary key constraint will be added to.
$columns string|array

Comma separated string or array of columns that the primary key will consist of.
return string

The SQL statement for adding a primary key constraint to an existing table.
addUnique() public method (available since version 2.0.13)

Creates a SQL command for adding an unique constraint to an existing table.

public string addUnique ( $name, $table, $columns )
$name string

The name of the unique constraint. The name will be properly quoted by the method.
$table string

The table that the unique constraint will be added to. The name will be properly quoted by the method.
$columns string|array

The name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas. The name will be properly quoted by the method.
return string

The SQL statement for adding an unique constraint to an existing table.
alterColumn() public method

Builds a SQL statement for changing the definition of a column.

public string alterColumn ( $table, $column, $type )
$table string

The table whose column is to be changed. The table name will be properly quoted by the method.
$column string

The name of the column to be changed. The name will be properly quoted by the method.
$type string

The new column type. The getColumnType() method will be invoked to convert abstract column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'.
return string

The SQL statement for changing the definition of a column.
batchInsert() public method

Generates a batch INSERT SQL statement.

For example,

$sql = $queryBuilder->batchInsert('user', ['name', 'age'], [
    ['Tom', 30],
    ['Jane', 20],
    ['Linda', 25],
]);

Note that the values in each row must match the corresponding column names.

The method will properly escape the column names, and quote the values to be inserted.

public string batchInsert ( $table, $columns, $rows, &$params = [] )
$table string

The table that new rows will be inserted into.
$columns array

The column names
$rows array|Generator

The rows to be batch inserted into the table
$params array

The binding parameters. This parameter exists since 2.0.14
return string

The batch INSERT SQL statement
bindParam() public method (available since version 2.0.14)

Helper method to add $value to $params array using PARAM_PREFIX.

public string bindParam ( $value, &$params )
$value string|null
$params array

Passed by reference
return string

The placeholder name in $params array
build() public method

Generates a SELECT SQL statement from a yii\db\Query object.

public array build ( $query, $params = [] )
$query yii\db\Query

The yii\db\Query object from which the SQL statement will be generated.
$params array

The parameters to be bound to the generated SQL statement. These parameters will be included in the result with the additional parameters generated during the query building process.
return array

The generated SQL statement (the first array element) and the corresponding parameters to be bound to the SQL statement (the second array element). The parameters returned include those provided in $params.
buildAndCondition() public method
Deprecated since 2.0.14. Use buildCondition() instead.

Connects two or more SQL expressions with the AND or OR operator.

public string buildAndCondition ( $operator, $operands, &$params )
$operator string

The operator to use for connecting the given operands
$operands array

The SQL expressions to connect.
$params array

The binding parameters to be populated
return string

The generated SQL expression
buildBetweenCondition() public method
Deprecated since 2.0.14. Use buildCondition() instead.

Creates an SQL expressions with the BETWEEN operator.

public string buildBetweenCondition ( $operator, $operands, &$params )
$operator string

The operator to use (e.g. BETWEEN or NOT BETWEEN)
$operands array

The first operand is the column name. The second and third operands describe the interval that column value should be in.
$params array

The binding parameters to be populated
return string

The generated SQL expression
throws yii\base\InvalidArgumentException

if wrong number of operands have been given.
buildColumns() public method

Processes columns and properly quotes them if necessary.

It will join all columns into a string with comma as separators.

public string buildColumns ( $columns )
$columns string|array

The columns to be processed
return string

The processing result
buildCondition() public method

Parses the condition specification and generates the corresponding SQL expression.

public string buildCondition ( $condition, &$params )
$condition string|array|yii\db\ExpressionInterface

The condition specification. Please refer to yii\db\Query::where() on how to specify a condition.
$params array

The binding parameters to be populated
return string

The generated SQL expression
buildExistsCondition() public method
Deprecated since 2.0.14. Use buildCondition() instead.

Creates an SQL expressions with the EXISTS operator.

public string buildExistsCondition ( $operator, $operands, &$params )
$operator string

The operator to use (e.g. EXISTS or NOT EXISTS)
$operands array

Contains only one element which is a yii\db\Query object representing the sub-query.
$params array

The binding parameters to be populated
return string

The generated SQL expression
throws yii\base\InvalidArgumentException

if the operand is not a yii\db\Query object.
buildExpression() public method (available since version 2.0.14)

Builds given $expression

See also:

public string buildExpression ( yii\db\ExpressionInterface $expression, &$params = [] )
$expression yii\db\ExpressionInterface

The expression to be built
$params array

The parameters to be bound to the generated SQL statement. These parameters will be included in the result with the additional parameters generated during the expression building process.
return string

The SQL statement that will not be neither quoted nor encoded before passing to DBMS
throws yii\base\InvalidArgumentException

when $expression building is not supported by this QueryBuilder.
buildFrom() public method

public string buildFrom ( $tables, &$params )
$tables array
$params array

The binding parameters to be populated
return string

The FROM clause built from yii\db\Query::$from.
buildGroupBy() public method

public string buildGroupBy ( $columns )
$columns array
return string

The GROUP BY clause
buildHashCondition() public method
Deprecated since 2.0.14. Use buildCondition() instead.

Creates a condition based on column-value pairs.

public string buildHashCondition ( $condition, &$params )
$condition array

The condition specification.
$params array

The binding parameters to be populated
return string

The generated SQL expression
buildHaving() public method

public string buildHaving ( $condition, &$params )
$condition string|array
$params array

The binding parameters to be populated
return string

The HAVING clause built from yii\db\Query::$having.
buildInCondition() public method
Deprecated since 2.0.14. Use buildCondition() instead.

Creates an SQL expressions with the IN operator.

public string buildInCondition ( $operator, $operands, &$params )
$operator string

The operator to use (e.g. IN or NOT IN)
$operands array

The first operand is the column name. If it is an array a composite IN condition will be generated. The second operand is an array of values that column value should be among. If it is an empty array the generated expression will be a false value if operator is IN and empty if operator is NOT IN.
$params array

The binding parameters to be populated
return string

The generated SQL expression
throws yii\db\Exception

if wrong number of operands have been given.
buildJoin() public method

public string buildJoin ( $joins, &$params )
$joins array
$params array

The binding parameters to be populated
return string

The JOIN clause built from yii\db\Query::$join.
throws yii\db\Exception

if the $joins parameter is not in proper format
buildLikeCondition() public method
Deprecated since 2.0.14. Use buildCondition() instead.

Creates an SQL expressions with the LIKE operator.

public string buildLikeCondition ( $operator, $operands, &$params )
$operator string

The operator to use (e.g. LIKE, NOT LIKE, OR LIKE or OR NOT LIKE)
$operands array

An array of two or three operands

  • The first operand is the column name.
  • The second operand is a single value or an array of values that column value should be compared with. If it is an empty array the generated expression will be a false value if operator is LIKE or OR LIKE, and empty if operator is NOT LIKE or OR NOT LIKE.
  • An optional third operand can also be provided to specify how to escape special characters in the value(s). The operand should be an array of mappings from the special characters to their escaped counterparts. If this operand is not provided, a default escape mapping will be used. You may use false or an empty array to indicate the values are already escaped and no escape should be applied. Note that when using an escape mapping (or the third operand is not provided), the values will be automatically enclosed within a pair of percentage characters.
$params array

The binding parameters to be populated
return string

The generated SQL expression
throws yii\base\InvalidArgumentException

if wrong number of operands have been given.
buildLimit() public method

public string buildLimit ( $limit, $offset )
$limit integer
$offset integer
return string

The LIMIT and OFFSET clauses
buildNotCondition() public method
Deprecated since 2.0.14. Use buildCondition() instead.

Inverts an SQL expressions with NOT operator.

public string buildNotCondition ( $operator, $operands, &$params )
$operator string

The operator to use for connecting the given operands
$operands array

The SQL expressions to connect.
$params array

The binding parameters to be populated
return string

The generated SQL expression
throws yii\base\InvalidArgumentException

if wrong number of operands have been given.
buildOrderBy() public method

public string buildOrderBy ( $columns )
$columns array
return string

The ORDER BY clause built from yii\db\Query::$orderBy.
buildOrderByAndLimit() public method

Builds the ORDER BY and LIMIT/OFFSET clauses and appends them to the given SQL.

public string buildOrderByAndLimit ( $sql, $orderBy, $limit, $offset )
$sql string

The existing SQL (without ORDER BY/LIMIT/OFFSET)
$orderBy array

The order by columns. See yii\db\Query::orderBy() for more details on how to specify this parameter.
$limit integer

The limit number. See yii\db\Query::limit() for more details.
$offset integer

The offset number. See yii\db\Query::offset() for more details.
return string

The SQL completed with ORDER BY/LIMIT/OFFSET (if any)
buildSelect() public method

public string buildSelect ( $columns, &$params, $distinct = false, $selectOption = null )
$columns array
$params array

The binding parameters to be populated
$distinct boolean
$selectOption string
return string

The SELECT clause built from yii\db\Query::$select.
buildSimpleCondition() public method
Deprecated since 2.0.14. Use buildCondition() instead.

Creates an SQL expressions like "column" operator value.

public string buildSimpleCondition ( $operator, $operands, &$params )
$operator string

The operator to use. Anything could be used e.g. >, <=, etc.
$operands array

Contains two column names.
$params array

The binding parameters to be populated
return string

The generated SQL expression
throws yii\base\InvalidArgumentException

if wrong number of operands have been given.
buildUnion() public method

public string buildUnion ( $unions, &$params )
$unions array
$params array

The binding parameters to be populated
return string

The UNION clause built from yii\db\Query::$union.
buildWhere() public method

public string buildWhere ( $condition, &$params )
$condition string|array
$params array

The binding parameters to be populated
return string

The WHERE clause built from yii\db\Query::$where.
buildWithQueries() public method (available since version 2.0.35)

See also yii\db\Query::withQuery().

public string buildWithQueries ( $withs, &$params )
$withs array

Of configurations for each WITH query
$params array

The binding parameters to be populated
return string

Compiled WITH prefix of query including nested queries
checkIntegrity() public method

Builds a SQL statement for enabling or disabling integrity check.

public string checkIntegrity ( $check = true, $schema = '', $table = '' )
$check boolean

Whether to turn on or off the integrity check.
$schema string

The schema of the tables. Defaults to empty string, meaning the current or default schema.
$table string

The table name. Defaults to empty string, meaning that no table will be changed.
return string

The SQL statement for checking integrity
throws yii\base\NotSupportedException

if this is not supported by the underlying DBMS
createConditionFromArray() public method (available since version 2.0.14)

Transforms $condition defined in array format (as described in yii\db\Query::where() to instance of yii\db\condition\ConditionInterface according to $conditionClasses map.

See also $conditionClasses.

public yii\db\conditions\ConditionInterface createConditionFromArray ( $condition )
$condition string|array
createIndex() public method

Builds a SQL statement for creating a new index.

public string createIndex ( $name, $table, $columns, $unique = false )
$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 table name will be properly quoted by the method.
$columns string|array

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 boolean

Whether to add UNIQUE constraint on the created index.
return string

The SQL statement for creating a new index.
createTable() public method

Builds a SQL statement for creating a new DB table.

The columns in the new table should be specified as name-definition pairs (e.g. 'name' => 'string'), where name stands for a column name which will be properly quoted by the method, and definition stands for the column type which can contain an abstract DB type. The getColumnType() method will be invoked to convert any abstract type into a physical one.

If a column is specified with definition only (e.g. 'PRIMARY KEY (name, type)'), it will be directly inserted into the generated SQL.

For example,

$sql = $queryBuilder->createTable('user', [
 'id' => 'pk',
 'name' => 'string',
 'age' => 'integer',
]);
public string createTable ( $table, $columns, $options = null )
$table string

The name of the table to be created. The name will be properly quoted by the method.
$columns array

The columns (name => definition) in the new table.
$options string

Additional SQL fragment that will be appended to the generated SQL.
return string

The SQL statement for creating a new DB table.
createView() public method (available since version 2.0.14)

Creates a SQL View.

public string createView ( $viewName, $subQuery )
$viewName string

The name of the view to be created.
$subQuery string|yii\db\Query

The select statement which defines the view. This can be either a string or a yii\db\Query object.
return string

The CREATE VIEW SQL statement.
defaultConditionClasses() protected method (available since version 2.0.14)

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.

See also $conditionClasses.

protected array defaultConditionClasses ( )
defaultExpressionBuilders() protected method (available since version 2.0.14)

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.

See also $expressionBuilders.

protected array defaultExpressionBuilders ( )
delete() public method

Creates a DELETE SQL statement.

For example,

$sql = $queryBuilder->delete('user', 'status = 0');

The method will properly escape the table and column names.

public string delete ( $table, $condition, &$params )
$table string

The table where the data will be deleted from.
$condition array|string

The condition that will be put in the WHERE part. Please refer to yii\db\Query::where() on how to specify condition.
$params array

The binding parameters that will be modified by this method so that they can be bound to the DB command later.
return string

The DELETE SQL
dropCheck() public method (available since version 2.0.13)

Creates a SQL command for dropping a check constraint.

public string dropCheck ( $name, $table )
$name string

The name of the check constraint to be dropped. The name will be properly quoted by the method.
$table string

The table whose check constraint is to be dropped. The name will be properly quoted by the method.
return string

The SQL statement for dropping a check constraint.
dropColumn() public method

Builds a SQL statement for dropping a DB column.

public string dropColumn ( $table, $column )
$table string

The table whose column is to be dropped. The name will be properly quoted by the method.
$column string

The name of the column to be dropped. The name will be properly quoted by the method.
return string

The SQL statement for dropping a DB column.
dropCommentFromColumn() public method (available since version 2.0.8)

Builds a SQL command for adding comment to column.

public string dropCommentFromColumn ( $table, $column )
$table string

The table whose column is to be commented. The table name will be properly quoted by the method.
$column string

The name of the column to be commented. The column name will be properly quoted by the method.
return string

The SQL statement for adding comment on column
dropCommentFromTable() public method (available since version 2.0.8)

Builds a SQL command for adding comment to table.

public string dropCommentFromTable ( $table )
$table string

The table whose column is to be commented. The table name will be properly quoted by the method.
return string

The SQL statement for adding comment on column
dropDefaultValue() public method (available since version 2.0.13)

Creates a SQL command for dropping a default value constraint.

public string dropDefaultValue ( $name, $table )
$name string

The name of the default value constraint to be dropped. The name will be properly quoted by the method.
$table string

The table whose default value constraint is to be dropped. The name will be properly quoted by the method.
return string

The SQL statement for dropping a default value constraint.
throws yii\base\NotSupportedException

if this is not supported by the underlying DBMS.
dropForeignKey() public method

Builds a SQL statement for dropping a foreign key constraint.

public string dropForeignKey ( $name, $table )
$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 is to be dropped. The name will be properly quoted by the method.
return string

The SQL statement for dropping a foreign key constraint.
dropIndex() public method

Builds a SQL statement for dropping an index.

public string dropIndex ( $name, $table )
$name string

The name of the index to be dropped. The name will be properly quoted by the method.
$table string

The table whose index is to be dropped. The name will be properly quoted by the method.
return string

The SQL statement for dropping an index.
dropPrimaryKey() public method

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

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

The name of the primary key constraint to be removed.
$table string

The table that the primary key constraint will be removed from.
return string

The SQL statement for removing a primary key constraint from an existing table.
dropTable() public method

Builds a SQL statement for dropping a DB table.

public string dropTable ( $table )
$table string

The table to be dropped. The name will be properly quoted by the method.
return string

The SQL statement for dropping a DB table.
dropUnique() public method (available since version 2.0.13)

Creates a SQL command for dropping an unique constraint.

public string dropUnique ( $name, $table )
$name string

The name of the unique constraint to be dropped. The name will be properly quoted by the method.
$table string

The table whose unique constraint is to be dropped. The name will be properly quoted by the method.
return string

The SQL statement for dropping an unique constraint.
dropView() public method (available since version 2.0.14)

Drops a SQL View.

public string dropView ( $viewName )
$viewName string

The name of the view to be dropped.
return string

The DROP VIEW SQL statement.
executeResetSequence() public method (available since version 2.0.16)

Execute a SQL statement for resetting the sequence value of a table's primary key.

Reason for execute is that some databases (Oracle) need several queries to do so. The sequence is reset such that the primary key of the next new row inserted will have the specified value or the maximum existing value +1.

public void executeResetSequence ( $table, $value = null )
$table string

The name of the table whose primary key sequence is reset
$value array|string

The 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.
throws yii\base\NotSupportedException

if this is not supported by the underlying DBMS
extractAlias() protected method (available since version 2.0.24)

Extracts table alias if there is one or returns false

protected boolean|array extractAlias ( $table )
$table
getColumnType() public method

Converts an abstract column type into a physical column type.

The conversion is done using the type map specified in $typeMap. The following abstract column types are supported (using MySQL as an example to explain the corresponding physical types):

  • pk: an auto-incremental primary key type, will be converted into "int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY"
  • bigpk: an auto-incremental primary key type, will be converted into "bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY"
  • upk: an unsigned auto-incremental primary key type, will be converted into "int(10) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY"
  • char: char type, will be converted into "char(1)"
  • string: string type, will be converted into "varchar(255)"
  • text: a long string type, will be converted into "text"
  • smallint: a small integer type, will be converted into "smallint(6)"
  • integer: integer type, will be converted into "int(11)"
  • bigint: a big integer type, will be converted into "bigint(20)"
  • boolean: boolean type, will be converted into "tinyint(1)"
  • float`: float number type, will be converted into "float"
  • decimal: decimal number type, will be converted into "decimal"
  • datetime: datetime type, will be converted into "datetime"
  • timestamp: timestamp type, will be converted into "timestamp"
  • time: time type, will be converted into "time"
  • date: date type, will be converted into "date"
  • money: money type, will be converted into "decimal(19,4)"
  • binary: binary data type, will be converted into "blob"

If the abstract type contains two or more parts separated by spaces (e.g. "string NOT NULL"), then only the first part will be converted, and the rest of the parts will be appended to the converted result. For example, 'string NOT NULL' is converted to 'varchar(255) NOT NULL'.

For some of the abstract types you can also specify a length or precision constraint by appending it in round brackets directly to the type. For example string(32) will be converted into "varchar(32)" on a MySQL database. If the underlying DBMS does not support these kind of constraints for a type it will be ignored.

If a type cannot be found in $typeMap, it will be returned without any change.

public string getColumnType ( $type )
$type string|yii\db\ColumnSchemaBuilder

Abstract column type
return string

Physical column type.
getExpressionBuilder() public method (available since version 2.0.14)

Gets object of yii\db\ExpressionBuilderInterface that is suitable for $expression.

Uses $expressionBuilders array to find a suitable builder class.

See also $expressionBuilders.

public yii\db\ExpressionBuilderInterface getExpressionBuilder ( yii\db\ExpressionInterface $expression )
$expression yii\db\ExpressionInterface
throws yii\base\InvalidArgumentException

when $expression building is not supported by this QueryBuilder.
hasLimit() protected method

Checks to see if the given limit is effective.

protected boolean hasLimit ( $limit )
$limit mixed

The given limit
return boolean

Whether the limit is effective
hasOffset() protected method

Checks to see if the given offset is effective.

protected boolean hasOffset ( $offset )
$offset mixed

The given offset
return boolean

Whether the offset is effective
init() public method

Initializes the object.

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

public void init ( )
insert() public method

Creates an INSERT SQL statement.

For example, `php $sql = $queryBuilder->insert('user', [

'name' => 'Sam',
'age' => 30,

], $params); ` The method will properly escape the table and column names.

public string insert ( $table, $columns, &$params )
$table string

The table that new rows will be inserted into.
$columns array|yii\db\Query

The column data (name => value) to be inserted into the table or instance of Query to perform INSERT INTO ... SELECT SQL statement. Passing of Query is available since version 2.0.11.
$params array

The binding parameters that will be generated by this method. They should be bound to the DB command later.
return string

The INSERT SQL
prepareInsertSelectSubQuery() protected method (available since version 2.0.11)

Prepare select-subquery and field names for INSERT INTO .

.. SELECT SQL statement.

protected array prepareInsertSelectSubQuery ( $columns, $schema, $params = [] )
$columns yii\db\Query

Object, which represents select query.
$schema yii\db\Schema

Schema object to quote column name.
$params array

The parameters to be bound to the generated SQL statement. These parameters will be included in the result with the additional parameters generated during the query building process.
return array

Array of column names, values and params.
throws yii\base\InvalidArgumentException

if query's select does not contain named parameters only.
prepareInsertValues() protected method (available since version 2.0.14)

Prepares a VALUES part for an INSERT SQL statement.

protected array prepareInsertValues ( $table, $columns, $params = [] )
$table string

The table that new rows will be inserted into.
$columns array|yii\db\Query

The column data (name => value) to be inserted into the table or instance of Query to perform INSERT INTO ... SELECT SQL statement.
$params array

The binding parameters that will be generated by this method. They should be bound to the DB command later.
return array

Array of column names, placeholders, values and params.
prepareUpdateSets() protected method (available since version 2.0.14)

Prepares a SET parts for an UPDATE SQL statement.

protected array prepareUpdateSets ( $table, $columns, $params = [] )
$table string

The table to be updated.
$columns array

The column data (name => value) to be updated.
$params array

The binding parameters that will be modified by this method so that they can be bound to the DB command later.
return array

An array SET parts for an UPDATE SQL statement (the first array element) and params (the second array element).
prepareUpsertColumns() protected method (available since version 2.0.14)

protected array prepareUpsertColumns ( $table, $insertColumns, $updateColumns, &$constraints = [] )
$table string
$insertColumns array|yii\db\Query
$updateColumns array|boolean
$constraints yii\db\Constraint[]

This parameter recieves a matched constraint list. The constraints will be unique by their column names.
renameColumn() public method

Builds a SQL statement for renaming a column.

public string renameColumn ( $table, $oldName, $newName )
$table string

The table whose column is to be renamed. The name will be properly quoted by the method.
$oldName string

The old name of the column. The name will be properly quoted by the method.
$newName string

The new name of the column. The name will be properly quoted by the method.
return string

The SQL statement for renaming a DB column.
renameTable() public method

Builds a SQL statement for renaming a DB table.

public string renameTable ( $oldName, $newName )
$oldName string

The table to be renamed. The name will be properly quoted by the method.
$newName string

The new table name. The name will be properly quoted by the method.
return string

The SQL statement for renaming a DB table.
resetSequence() public method

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.

public string resetSequence ( $table, $value = null )
$table string

The name of the table whose primary key sequence will be reset
$value array|string

The 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.
return string

The SQL statement for resetting sequence
throws yii\base\NotSupportedException

if this is not supported by the underlying DBMS
selectExists() public method (available since version 2.0.8)

Creates a SELECT EXISTS() SQL statement.

public string selectExists ( $rawSql )
$rawSql string

The subquery in a raw form to select from.
return string

The SELECT EXISTS() SQL statement.
setConditionClasses() public method (available since version 2.0.14.2)

Setter for $conditionClasses property.

See also $conditionClasses.

public void setConditionClasses ( $classes )
$classes string[]

Map of condition aliases to condition classes. For example:

['LIKE' => yii\db\condition\LikeCondition::class]
setExpressionBuilders() public method (available since version 2.0.14)

Setter for $expressionBuilders property.

See also $expressionBuilders.

public void setExpressionBuilders ( $builders )
$builders string[]

Array of builders that should be merged with the pre-defined ones in $expressionBuilders property.
truncateTable() public method

Builds a SQL statement for truncating a DB table.

public string truncateTable ( $table )
$table string

The table to be truncated. The name will be properly quoted by the method.
return string

The SQL statement for truncating a DB table.
update() public method

Creates an UPDATE SQL statement.

For example,

$params = [];
$sql = $queryBuilder->update('user', ['status' => 1], 'age > 30', $params);

The method will properly escape the table and column names.

public string update ( $table, $columns, $condition, &$params )
$table string

The table to be updated.
$columns array

The column data (name => value) to be updated.
$condition array|string

The condition that will be put in the WHERE part. Please refer to yii\db\Query::where() on how to specify condition.
$params array

The binding parameters that will be modified by this method so that they can be bound to the DB command later.
return string

The UPDATE SQL
upsert() public method (available since version 2.0.14)

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' => 'http://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.

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

The table that new rows will be inserted into/updated in.
$insertColumns array|yii\db\Query

The column data (name => value) to be inserted into the table or instance of yii\db\Query to perform INSERT INTO ... SELECT SQL statement.
$updateColumns array|boolean

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 array

The binding parameters that will be generated by this method. They should be bound to the DB command later.
return string

The resulting SQL.
throws yii\base\NotSupportedException

if this is not supported by the underlying DBMS.