# Class yii\db\mysql\QueryBuilder

Inheritance | yii\db\mysql\QueryBuilder » yii\db\QueryBuilder » yii\base\BaseObject
Implements | yii\base\Configurable
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/db/mysql/QueryBuilder.php

QueryBuilder is the query builder for MySQL databases.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined 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
$db | yii\db\Connection | The database connection. | yii\db\QueryBuilder
$expressionBuilders | string[]|yii\db\ExpressionBuilderInterface[] | Maps expression class to expression builder class. | yii\db\QueryBuilder
$separator | string | The separator between different fragments of a SQL statement. | yii\db\QueryBuilder
$typeMap | array | Mapping from abstract column types (keys) to physical column types (values). | yii\db\mysql\QueryBuilder

## Protected Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---

## Public Methods

Hide inherited methods

Method | Description | Defined 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\mysql\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\mysql\QueryBuilder
addCommentOnTable() | Builds a SQL command for adding comment to table. | yii\db\mysql\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\mysql\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\mysql\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\mysql\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\mysql\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\mysql\QueryBuilder
dropCommentFromTable() | Builds a SQL command for adding comment to table. | yii\db\mysql\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\mysql\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\mysql\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\mysql\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\mysql\QueryBuilder
insert() | Creates an INSERT SQL statement. | yii\db\QueryBuilder
renameColumn() | Builds a SQL statement for renaming a column. | yii\db\mysql\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\mysql\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\mysql\QueryBuilder

## Protected Methods

Hide inherited methods

Method | Description | Defined 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\mysql\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\mysql\QueryBuilder
hasOffset() | Checks to see if the given offset is effective. | yii\db\mysql\QueryBuilder
prepareInsertSelectSubQuery() | Prepare select-subquery and field names for INSERT INTO ... SELECT SQL statement. | yii\db\QueryBuilder
prepareInsertValues() | Prepares a `VALUES` part for an `INSERT` SQL statement. | yii\db\mysql\QueryBuilder
prepareUpdateSets() | Prepares a `SET` parts for an `UPDATE` SQL statement. | yii\db\QueryBuilder
prepareUpsertColumns() |  | yii\db\QueryBuilder

## Constants

Hide inherited constants

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

## Property Details

Hide inherited properties

$typeMap public property

Mapping from abstract column types (keys) to physical column types (values).

public array $typeMap = [
\yii\db\mysql\Schema::TYPE_PK => 'int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY',
\yii\db\mysql\Schema::TYPE_UPK => 'int(10) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY',
\yii\db\mysql\Schema::TYPE_BIGPK => 'bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY',
\yii\db\mysql\Schema::TYPE_UBIGPK => 'bigint(20) 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(3)',
\yii\db\mysql\Schema::TYPE_SMALLINT => 'smallint(6)',
\yii\db\mysql\Schema::TYPE_INTEGER => 'int(11)',
\yii\db\mysql\Schema::TYPE_BIGINT => 'bigint(20)',
\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',
]

## Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name | string | The method name
$params | array | Method parameters
return | mixed | The method return value
throws | yii\base\UnknownMethodException | when calling unknown method

Source code

                    public function __call($name, $params)
    {
        throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
    }

__construct() public method

Defined in: yii\db\QueryBuilder::__construct()

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

Source code

                    public function __construct($connection, $config = [])
    {
        $this->db = $connection;
        parent::__construct($config);
    }

__get() public method

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `$value = $object->property;`.

See also __set().

public mixed __get ( $name )
$name | string | The property name
return | mixed | The property value
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is write-only

Source code

                    public function __get($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            return $this->$getter();
        } elseif (method_exists($this, 'set' . $name)) {
            throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
        }
        throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
    }

__isset() public method

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `isset($object->property)`.

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name | string | The property name or the event name
return | boolean | Whether the named property is set (not null).

Source code

                    public function __isset($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            return $this->$getter() !== null;
        }
        return false;
    }

__set() public method

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `$object->property = $value;`.

See also __get().

public void __set ( $name, $value )
$name | string | The property name or the event name
$value | mixed | The property value
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is read-only

Source code

                    public function __set($name, $value)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            $this->$setter($value);
        } elseif (method_exists($this, 'get' . $name)) {
            throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
        } else {
            throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
        }
    }

__unset() public method

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `unset($object->property)`.

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name | string | The property name
throws | yii\base\InvalidCallException | if the property is read only.

Source code

                    public function __unset($name)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            $this->$setter(null);
        } elseif (method_exists($this, 'get' . $name)) {
            throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
        }
    }

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.
throws | yii\base\NotSupportedException | this is not supported by MySQL.

Source code

                    public function addCheck($name, $table, $expression)
    {
        throw new NotSupportedException(__METHOD__ . ' is not supported by MySQL.');
    }

addColumn() public method

Defined in: yii\db\QueryBuilder::addColumn()

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.

Source code

                    public function addColumn($table, $column, $type)
    {
        return 'ALTER TABLE ' . $this->db->quoteTableName($table)
            . ' ADD ' . $this->db->quoteColumnName($column) . ' '
            . $this->getColumnType($type);
    }

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

Source code

                    public function addCommentOnColumn($table, $column, $comment)
    {
        // Strip existing comment which may include escaped quotes
        $definition = trim(preg_replace("/COMMENT '(?:''|[^'])*'/i", '', $this->getColumnDefinition($table, $column)));
        $checkRegex = '/CHECK *(\(([^()]|(?-2))*\))/';
        $check = preg_match($checkRegex, $definition, $checkMatches);
        if ($check === 1) {
            $definition = preg_replace($checkRegex, '', $definition);
        }
        $alterSql = 'ALTER TABLE ' . $this->db->quoteTableName($table)
            . ' CHANGE ' . $this->db->quoteColumnName($column)
            . ' ' . $this->db->quoteColumnName($column)
            . (empty($definition) ? '' : ' ' . $definition)
            . ' COMMENT ' . $this->db->quoteValue($comment);
        if ($check === 1) {
            $alterSql .= ' ' . $checkMatches[0];
        }
        return $alterSql;
    }

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

Source code

                    public function addCommentOnTable($table, $comment)
    {
        return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' COMMENT ' . $this->db->quoteValue($comment);
    }

addDefaultValue() public method (available since version 2.0.13)

Defined in: yii\db\QueryBuilder::addDefaultValue()

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.

Source code

                    public function addDefaultValue($name, $table, $column, $value)
    {
        throw new NotSupportedException($this->db->getDriverName() . ' does not support adding default value constraints.');
    }

addForeignKey() public method

Defined in: yii\db\QueryBuilder::addForeignKey()

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|null | The ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
$update | string|null | 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.

Source code

                    public function addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null)
    {
        $sql = 'ALTER TABLE ' . $this->db->quoteTableName($table)
            . ' ADD CONSTRAINT ' . $this->db->quoteColumnName($name)
            . ' FOREIGN KEY (' . $this->buildColumns($columns) . ')'
            . ' REFERENCES ' . $this->db->quoteTableName($refTable)
            . ' (' . $this->buildColumns($refColumns) . ')';
        if ($delete !== null) {
            $sql .= ' ON DELETE ' . $delete;
        }
        if ($update !== null) {
            $sql .= ' ON UPDATE ' . $update;
        }
        return $sql;
    }

addPrimaryKey() public method

Defined in: yii\db\QueryBuilder::addPrimaryKey()

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.

Source code

                    public function addPrimaryKey($name, $table, $columns)
    {
        if (is_string($columns)) {
            $columns = preg_split('/\s*,\s*/', $columns, -1, PREG_SPLIT_NO_EMPTY);
        }
        foreach ($columns as $i => $col) {
            $columns[$i] = $this->db->quoteColumnName($col);
        }
        return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' ADD CONSTRAINT '
            . $this->db->quoteColumnName($name) . ' PRIMARY KEY ('
            . implode(', ', $columns) . ')';
    }

addUnique() public method (available since version 2.0.13)

Defined in: yii\db\QueryBuilder::addUnique()

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.

Source code

                    public function addUnique($name, $table, $columns)
    {
        if (is_string($columns)) {
            $columns = preg_split('/\s*,\s*/', $columns, -1, PREG_SPLIT_NO_EMPTY);
        }
        foreach ($columns as $i => $col) {
            $columns[$i] = $this->db->quoteColumnName($col);
        }
        return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' ADD CONSTRAINT '
            . $this->db->quoteColumnName($name) . ' UNIQUE ('
            . implode(', ', $columns) . ')';
    }

alterColumn() public method

Defined in: yii\db\QueryBuilder::alterColumn()

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.

Source code

                    public function alterColumn($table, $column, $type)
    {
        return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' CHANGE '
            . $this->db->quoteColumnName($column) . ' '
            . $this->db->quoteColumnName($column) . ' '
            . $this->getColumnType($type);
    }

batchInsert() public method

Defined in: yii\db\QueryBuilder::batchInsert()

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

Source code

                    public function batchInsert($table, $columns, $rows, &$params = [])
    {
        if (empty($rows)) {
            return '';
        }
        $schema = $this->db->getSchema();
        if (($tableSchema = $schema->getTableSchema($table)) !== null) {
            $columnSchemas = $tableSchema->columns;
        } else {
            $columnSchemas = [];
        }
        $values = [];
        foreach ($rows as $row) {
            $vs = [];
            foreach ($row as $i => $value) {
                if (isset($columns[$i], $columnSchemas[$columns[$i]])) {
                    $value = $columnSchemas[$columns[$i]]->dbTypecast($value);
                }
                if (is_string($value)) {
                    $value = $schema->quoteValue($value);
                } elseif (is_float($value)) {
                    // ensure type cast always has . as decimal separator in all locales
                    $value = StringHelper::floatToString($value);
                } elseif ($value === false) {
                    $value = 0;
                } elseif ($value === null) {
                    $value = 'NULL';
                } elseif ($value instanceof ExpressionInterface) {
                    $value = $this->buildExpression($value, $params);
                }
                $vs[] = $value;
            }
            $values[] = '(' . implode(', ', $vs) . ')';
        }
        if (empty($values)) {
            return '';
        }
        foreach ($columns as $i => $name) {
            $columns[$i] = $schema->quoteColumnName($name);
        }
        return 'INSERT INTO ' . $schema->quoteTableName($table)
            . ' (' . implode(', ', $columns) . ') VALUES ' . implode(', ', $values);
    }

bindParam() public method (available since version 2.0.14)

Defined in: yii\db\QueryBuilder::bindParam()

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

Source code

                    public function bindParam($value, &$params)
    {
        $phName = self::PARAM_PREFIX . count($params);
        $params[$phName] = $value;
        return $phName;
    }

build() public method

Defined in: yii\db\QueryBuilder::build()

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`.

Source code

                    public function build($query, $params = [])
    {
        $query = $query->prepare($this);
        $params = empty($params) ? $query->params : array_merge($params, $query->params);
        $clauses = [
            $this->buildSelect($query->select, $params, $query->distinct, $query->selectOption),
            $this->buildFrom($query->from, $params),
            $this->buildJoin($query->join, $params),
            $this->buildWhere($query->where, $params),
            $this->buildGroupBy($query->groupBy),
            $this->buildHaving($query->having, $params),
        ];
        $sql = implode($this->separator, array_filter($clauses));
        $sql = $this->buildOrderByAndLimit($sql, $query->orderBy, $query->limit, $query->offset);
        if (!empty($query->orderBy)) {
            foreach ($query->orderBy as $expression) {
                if ($expression instanceof ExpressionInterface) {
                    $this->buildExpression($expression, $params);
                }
            }
        }
        if (!empty($query->groupBy)) {
            foreach ($query->groupBy as $expression) {
                if ($expression instanceof ExpressionInterface) {
                    $this->buildExpression($expression, $params);
                }
            }
        }
        $union = $this->buildUnion($query->union, $params);
        if ($union !== '') {
            $sql = "($sql){$this->separator}$union";
        }
        $with = $this->buildWithQueries($query->withQueries, $params);
        if ($with !== '') {
            $sql = "$with{$this->separator}$sql";
        }
        return [$sql, $params];
    }

buildAndCondition() public method
Deprecated since 2.0.14. Use `buildCondition()` instead.

Defined in: yii\db\QueryBuilder::buildAndCondition()

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

Source code

                    public function buildAndCondition($operator, $operands, &$params)
    {
        array_unshift($operands, $operator);
        return $this->buildCondition($operands, $params);
    }

buildBetweenCondition() public method
Deprecated since 2.0.14. Use `buildCondition()` instead.

Defined in: yii\db\QueryBuilder::buildBetweenCondition()

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.

Source code

                    public function buildBetweenCondition($operator, $operands, &$params)
    {
        array_unshift($operands, $operator);
        return $this->buildCondition($operands, $params);
    }

buildColumns() public method

Defined in: yii\db\QueryBuilder::buildColumns()

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

Source code

                    public function buildColumns($columns)
    {
        if (!is_array($columns)) {
            if (strpos($columns, '(') !== false) {
                return $columns;
            }
            $rawColumns = $columns;
            $columns = preg_split('/\s*,\s*/', $columns, -1, PREG_SPLIT_NO_EMPTY);
            if ($columns === false) {
                throw new InvalidArgumentException("$rawColumns is not valid columns.");
            }
        }
        foreach ($columns as $i => $column) {
            if ($column instanceof ExpressionInterface) {
                $columns[$i] = $this->buildExpression($column);
            } elseif (strpos($column, '(') === false) {
                $columns[$i] = $this->db->quoteColumnName($column);
            }
        }
        return implode(', ', $columns);
    }

buildCondition() public method

Defined in: yii\db\QueryBuilder::buildCondition()

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

Source code

                    public function buildCondition($condition, &$params)
    {
        if (is_array($condition)) {
            if (empty($condition)) {
                return '';
            }
            $condition = $this->createConditionFromArray($condition);
        }
        if ($condition instanceof ExpressionInterface) {
            return $this->buildExpression($condition, $params);
        }
        return (string)$condition;
    }

buildExistsCondition() public method
Deprecated since 2.0.14. Use `buildCondition()` instead.

Defined in: yii\db\QueryBuilder::buildExistsCondition()

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.

Source code

                    public function buildExistsCondition($operator, $operands, &$params)
    {
        array_unshift($operands, $operator);
        return $this->buildCondition($operands, $params);
    }

buildExpression() public method (available since version 2.0.14)

Defined in: yii\db\QueryBuilder::buildExpression()

Builds given $expression

See also:

- yii\db\ExpressionBuilderInterface
- $expressionBuilders
- yii\db\ExpressionInterface

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.

Source code

                    public function buildExpression(ExpressionInterface $expression, &$params = [])
    {
        $builder = $this->getExpressionBuilder($expression);
        return $builder->build($expression, $params);
    }

buildFrom() public method

Defined in: yii\db\QueryBuilder::buildFrom()

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.

Source code

                    public function buildFrom($tables, &$params)
    {
        if (empty($tables)) {
            return '';
        }
        $tables = $this->quoteTableNames($tables, $params);
        return 'FROM ' . implode(', ', $tables);
    }

buildGroupBy() public method

Defined in: yii\db\QueryBuilder::buildGroupBy()

public string buildGroupBy ( $columns )
$columns | array |
return | string | The GROUP BY clause

Source code

                    public function buildGroupBy($columns)
    {
        if (empty($columns)) {
            return '';
        }
        foreach ($columns as $i => $column) {
            if ($column instanceof ExpressionInterface) {
                $columns[$i] = $this->buildExpression($column);
            } elseif (strpos($column, '(') === false) {
                $columns[$i] = $this->db->quoteColumnName($column);
            }
        }
        return 'GROUP BY ' . implode(', ', $columns);
    }

buildHashCondition() public method
Deprecated since 2.0.14. Use `buildCondition()` instead.

Defined in: yii\db\QueryBuilder::buildHashCondition()

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

Source code

                    public function buildHashCondition($condition, &$params)
    {
        return $this->buildCondition(new HashCondition($condition), $params);
    }

buildHaving() public method

Defined in: yii\db\QueryBuilder::buildHaving()

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.

Source code

                    public function buildHaving($condition, &$params)
    {
        $having = $this->buildCondition($condition, $params);
        return $having === '' ? '' : 'HAVING ' . $having;
    }

buildInCondition() public method
Deprecated since 2.0.14. Use `buildCondition()` instead.

Defined in: yii\db\QueryBuilder::buildInCondition()

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.

Source code

                    public function buildInCondition($operator, $operands, &$params)
    {
        array_unshift($operands, $operator);
        return $this->buildCondition($operands, $params);
    }

buildJoin() public method

Defined in: yii\db\QueryBuilder::buildJoin()

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

Source code

                    public function buildJoin($joins, &$params)
    {
        if (empty($joins)) {
            return '';
        }
        foreach ($joins as $i => $join) {
            if (!is_array($join) || !isset($join[0], $join[1])) {
                throw new Exception('A join clause must be specified as an array of join type, join table, and optionally join condition.');
            }
            // 0:join type, 1:join table, 2:on-condition (optional)
            list($joinType, $table) = $join;
            $tables = $this->quoteTableNames((array)$table, $params);
            $table = reset($tables);
            $joins[$i] = "$joinType $table";
            if (isset($join[2])) {
                $condition = $this->buildCondition($join[2], $params);
                if ($condition !== '') {
                    $joins[$i] .= ' ON ' . $condition;
                }
            }
        }
        return implode($this->separator, $joins);
    }

buildLikeCondition() public method
Deprecated since 2.0.14. Use `buildCondition()` instead.

Defined in: yii\db\QueryBuilder::buildLikeCondition()

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.

Source code

                    public function buildLikeCondition($operator, $operands, &$params)
    {
        array_unshift($operands, $operator);
        return $this->buildCondition($operands, $params);
    }

buildLimit() public method

public string buildLimit ( $limit, $offset )
$limit | integer |
$offset | integer |
return | string | The LIMIT and OFFSET clauses

Source code

                    public function buildLimit($limit, $offset)
    {
        $sql = '';
        if ($this->hasLimit($limit)) {
            $sql = 'LIMIT ' . $limit;
            if ($this->hasOffset($offset)) {
                $sql .= ' OFFSET ' . $offset;
            }
        } elseif ($this->hasOffset($offset)) {
            // limit is not optional in MySQL
            // https://stackoverflow.com/questions/255517/mysql-offset-infinite-rows/271650#271650
            // https://dev.mysql.com/doc/refman/5.7/en/select.html#idm46193796386608
            $sql = "LIMIT $offset, 18446744073709551615"; // 2^64-1
        }
        return $sql;
    }

buildNotCondition() public method
Deprecated since 2.0.14. Use `buildCondition()` instead.

Defined in: yii\db\QueryBuilder::buildNotCondition()

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.

Source code

                    public function buildNotCondition($operator, $operands, &$params)
    {
        array_unshift($operands, $operator);
        return $this->buildCondition($operands, $params);
    }

buildOrderBy() public method

Defined in: yii\db\QueryBuilder::buildOrderBy()

public string buildOrderBy ( $columns )
$columns | array |
return | string | The ORDER BY clause built from yii\db\Query::$orderBy.

Source code

                    public function buildOrderBy($columns)
    {
        if (empty($columns)) {
            return '';
        }
        $orders = [];
        foreach ($columns as $name => $direction) {
            if ($direction instanceof ExpressionInterface) {
                $orders[] = $this->buildExpression($direction);
            } else {
                $orders[] = $this->db->quoteColumnName($name) . ($direction === SORT_DESC ? ' DESC' : '');
            }
        }
        return 'ORDER BY ' . implode(', ', $orders);
    }

buildOrderByAndLimit() public method

Defined in: yii\db\QueryBuilder::buildOrderByAndLimit()

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)

Source code

                    public function buildOrderByAndLimit($sql, $orderBy, $limit, $offset)
    {
        $orderBy = $this->buildOrderBy($orderBy);
        if ($orderBy !== '') {
            $sql .= $this->separator . $orderBy;
        }
        $limit = $this->buildLimit($limit, $offset);
        if ($limit !== '') {
            $sql .= $this->separator . $limit;
        }
        return $sql;
    }

buildSelect() public method

Defined in: yii\db\QueryBuilder::buildSelect()

public string buildSelect ( $columns, &$params, $distinct = false, $selectOption = null )
$columns | array |
$params | array | The binding parameters to be populated
$distinct | boolean |
$selectOption | string|null |
return | string | The SELECT clause built from yii\db\Query::$select.

Source code

                    public function buildSelect($columns, &$params, $distinct = false, $selectOption = null)
    {
        $select = $distinct ? 'SELECT DISTINCT' : 'SELECT';
        if ($selectOption !== null) {
            $select .= ' ' . $selectOption;
        }
        if (empty($columns)) {
            return $select . ' *';
        }
        foreach ($columns as $i => $column) {
            if ($column instanceof ExpressionInterface) {
                if (is_int($i)) {
                    $columns[$i] = $this->buildExpression($column, $params);
                } else {
                    $columns[$i] = $this->buildExpression($column, $params) . ' AS ' . $this->db->quoteColumnName($i);
                }
            } elseif ($column instanceof Query) {
                list($sql, $params) = $this->build($column, $params);
                $columns[$i] = "($sql) AS " . $this->db->quoteColumnName($i);
            } elseif (is_string($i) && $i !== $column) {
                if (strpos($column, '(') === false) {
                    $column = $this->db->quoteColumnName($column);
                }
                $columns[$i] = "$column AS " . $this->db->quoteColumnName($i);
            } elseif (strpos($column, '(') === false) {
                if (preg_match('/^(.*?)(?i:\s+as\s+|\s+)([\w\-_\.]+)$/', $column, $matches)) {
                    $columns[$i] = $this->db->quoteColumnName($matches[1]) . ' AS ' . $this->db->quoteColumnName($matches[2]);
                } else {
                    $columns[$i] = $this->db->quoteColumnName($column);
                }
            }
        }
        return $select . ' ' . implode(', ', $columns);
    }

buildSimpleCondition() public method
Deprecated since 2.0.14. Use `buildCondition()` instead.

Defined in: yii\db\QueryBuilder::buildSimpleCondition()

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.

Source code

                    public function buildSimpleCondition($operator, $operands, &$params)
    {
        array_unshift($operands, $operator);
        return $this->buildCondition($operands, $params);
    }

buildUnion() public method

Defined in: yii\db\QueryBuilder::buildUnion()

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.

Source code

                    public function buildUnion($unions, &$params)
    {
        if (empty($unions)) {
            return '';
        }
        $result = '';
        foreach ($unions as $i => $union) {
            $query = $union['query'];
            if ($query instanceof Query) {
                list($unions[$i]['query'], $params) = $this->build($query, $params);
            }
            $result .= 'UNION ' . ($union['all'] ? 'ALL ' : '') . '( ' . $unions[$i]['query'] . ' ) ';
        }
        return trim($result);
    }

buildWhere() public method

Defined in: yii\db\QueryBuilder::buildWhere()

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.

Source code

                    public function buildWhere($condition, &$params)
    {
        $where = $this->buildCondition($condition, $params);
        return $where === '' ? '' : 'WHERE ' . $where;
    }

buildWithQueries() public method (available since version 2.0.35)

Defined in: yii\db\QueryBuilder::buildWithQueries()

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

Source code

                    public function buildWithQueries($withs, &$params)
    {
        if (empty($withs)) {
            return '';
        }
        $recursive = false;
        $result = [];
        foreach ($withs as $i => $with) {
            if ($with['recursive']) {
                $recursive = true;
            }
            $query = $with['query'];
            if ($query instanceof Query) {
                list($with['query'], $params) = $this->build($query, $params);
            }
            $result[] = $with['alias'] . ' AS (' . $with['query'] . ')';
        }
        return 'WITH ' . ($recursive ? 'RECURSIVE ' : '') . implode(', ', $result);
    }

canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable if:

- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
return | boolean | Whether the property can be read

Source code

                    public function canGetProperty($name, $checkVars = true)
    {
        return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
    }

canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable if:

- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
return | boolean | Whether the property can be written

Source code

                    public function canSetProperty($name, $checkVars = true)
    {
        return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
    }

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. Meaningless for MySQL.
$table | string | The table name. Meaningless for MySQL.
return | string | The SQL statement for checking integrity

Source code

                    public function checkIntegrity($check = true, $schema = '', $table = '')
    {
        return 'SET FOREIGN_KEY_CHECKS = ' . ($check ? 1 : 0);
    }

className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use `::class` instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return | string | The fully qualified name of this class.

Source code

                    public static function className()
    {
        return get_called_class();
    }

createConditionFromArray() public method (available since version 2.0.14)

Defined in: yii\db\QueryBuilder::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.

See also $conditionClasses.

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

Source code

                    public function createConditionFromArray($condition)
    {
        if (isset($condition[0])) { // operator format: operator, operand 1, operand 2, ...
            $operator = strtoupper(array_shift($condition));
            if (isset($this->conditionClasses[$operator])) {
                $className = $this->conditionClasses[$operator];
            } else {
                $className = 'yii\db\conditions\SimpleCondition';
            }
            /** @var ConditionInterface $className */
            return $className::fromArrayDefinition($operator, $condition);
        }
        // hash format: 'column1' => 'value1', 'column2' => 'value2', ...
        return new HashCondition($condition);
    }

createIndex() public method

Builds a SQL statement for creating a new index.

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

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.

Source code

                    public function createIndex($name, $table, $columns, $unique = false)
    {
        return 'ALTER TABLE '
        . $this->db->quoteTableName($table)
        . ($unique ? ' ADD UNIQUE INDEX ' : ' ADD INDEX ')
        . $this->db->quoteTableName($name)
        . ' (' . $this->buildColumns($columns) . ')';
    }

createTable() public method

Defined in: yii\db\QueryBuilder::createTable()

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 must 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',
     'column_name double precision null default null', # definition only example
    ]);

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|null | Additional SQL fragment that will be appended to the generated SQL.
return | string | The SQL statement for creating a new DB table.

Source code

                    public function createTable($table, $columns, $options = null)
    {
        $cols = [];
        foreach ($columns as $name => $type) {
            if (is_string($name)) {
                $cols[] = "\t" . $this->db->quoteColumnName($name) . ' ' . $this->getColumnType($type);
            } else {
                $cols[] = "\t" . $type;
            }
        }
        $sql = 'CREATE TABLE ' . $this->db->quoteTableName($table) . " (\n" . implode(",\n", $cols) . "\n)";
        return $options === null ? $sql : $sql . ' ' . $options;
    }

createView() public method (available since version 2.0.14)

Defined in: yii\db\QueryBuilder::createView()

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.

Source code

                    public function createView($viewName, $subQuery)
    {
        if ($subQuery instanceof Query) {
            list($rawQuery, $params) = $this->build($subQuery);
            array_walk(
                $params,
                function (&$param) {
                    $param = $this->db->quoteValue($param);
                }
            );
            $subQuery = strtr($rawQuery, $params);
        }
        return 'CREATE VIEW ' . $this->db->quoteTableName($viewName) . ' AS ' . $subQuery;
    }

defaultConditionClasses() protected method (available since version 2.0.14)

Defined in: yii\db\QueryBuilder::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.

See also $conditionClasses.

protected array defaultConditionClasses ( )

Source code

                    protected function defaultConditionClasses()
    {
        return [
            'NOT' => 'yii\db\conditions\NotCondition',
            'AND' => 'yii\db\conditions\AndCondition',
            'OR' => 'yii\db\conditions\OrCondition',
            'BETWEEN' => 'yii\db\conditions\BetweenCondition',
            'NOT BETWEEN' => 'yii\db\conditions\BetweenCondition',
            'IN' => 'yii\db\conditions\InCondition',
            'NOT IN' => 'yii\db\conditions\InCondition',
            'LIKE' => 'yii\db\conditions\LikeCondition',
            'NOT LIKE' => 'yii\db\conditions\LikeCondition',
            'OR LIKE' => 'yii\db\conditions\LikeCondition',
            'OR NOT LIKE' => 'yii\db\conditions\LikeCondition',
            'EXISTS' => 'yii\db\conditions\ExistsCondition',
            'NOT EXISTS' => 'yii\db\conditions\ExistsCondition',
        ];
    }

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.

protected array defaultExpressionBuilders ( )

Source code

                    protected function defaultExpressionBuilders()
    {
        return array_merge(parent::defaultExpressionBuilders(), [
            'yii\db\JsonExpression' => 'yii\db\mysql\JsonExpressionBuilder',
        ]);
    }

delete() public method

Defined in: yii\db\QueryBuilder::delete()

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

Source code

                    public function delete($table, $condition, &$params)
    {
        $sql = 'DELETE FROM ' . $this->db->quoteTableName($table);
        $where = $this->buildWhere($condition, $params);
        return $where === '' ? $sql : $sql . ' ' . $where;
    }

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.
throws | yii\base\NotSupportedException | this is not supported by MySQL.

Source code

                    public function dropCheck($name, $table)
    {
        throw new NotSupportedException(__METHOD__ . ' is not supported by MySQL.');
    }

dropColumn() public method

Defined in: yii\db\QueryBuilder::dropColumn()

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.

Source code

                    public function dropColumn($table, $column)
    {
        return 'ALTER TABLE ' . $this->db->quoteTableName($table)
            . ' DROP COLUMN ' . $this->db->quoteColumnName($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

Source code

                    public function dropCommentFromColumn($table, $column)
    {
        return $this->addCommentOnColumn($table, $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

Source code

                    public function dropCommentFromTable($table)
    {
        return $this->addCommentOnTable($table, '');
    }

dropDefaultValue() public method (available since version 2.0.13)

Defined in: yii\db\QueryBuilder::dropDefaultValue()

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.

Source code

                    public function dropDefaultValue($name, $table)
    {
        throw new NotSupportedException($this->db->getDriverName() . ' does not support dropping default value constraints.');
    }

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.

Source code

                    public function dropForeignKey($name, $table)
    {
        return 'ALTER TABLE ' . $this->db->quoteTableName($table)
            . ' DROP FOREIGN KEY ' . $this->db->quoteColumnName($name);
    }

dropIndex() public method

Defined in: yii\db\QueryBuilder::dropIndex()

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.

Source code

                    public function dropIndex($name, $table)
    {
        return 'DROP INDEX ' . $this->db->quoteTableName($name) . ' ON ' . $this->db->quoteTableName($table);
    }

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.

Source code

                    public function dropPrimaryKey($name, $table)
    {
        return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' DROP PRIMARY KEY';
    }

dropTable() public method

Defined in: yii\db\QueryBuilder::dropTable()

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.

Source code

                    public function dropTable($table)
    {
        return 'DROP TABLE ' . $this->db->quoteTableName($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.

Source code

                    public function dropUnique($name, $table)
    {
        return $this->dropIndex($name, $table);
    }

dropView() public method (available since version 2.0.14)

Defined in: yii\db\QueryBuilder::dropView()

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.

Source code

                    public function dropView($viewName)
    {
        return 'DROP VIEW ' . $this->db->quoteTableName($viewName);
    }

executeResetSequence() public method (available since version 2.0.16)

Defined in: yii\db\QueryBuilder::executeResetSequence()

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|null | 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

Source code

                    public function executeResetSequence($table, $value = null)
    {
        $this->db->createCommand()->resetSequence($table, $value)->execute();
    }

extractAlias() protected method (available since version 2.0.24)

Defined in: yii\db\QueryBuilder::extractAlias()

Extracts table alias if there is one or returns false

protected boolean|array extractAlias ( $table )
$table |  |

Source code

                    protected function extractAlias($table)
    {
        if (preg_match('/^(.*?)(?i:\s+as|)\s+([^ ]+)$/', $table, $matches)) {
            return $matches;
        }
        return false;
    }

getColumnType() public method

Defined in: yii\db\QueryBuilder::getColumnType()

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.

Source code

                    public function getColumnType($type)
    {
        if ($type instanceof ColumnSchemaBuilder) {
            $type = $type->__toString();
        }
        if (isset($this->typeMap[$type])) {
            return $this->typeMap[$type];
        } elseif (preg_match('/^(\w+)\((.+?)\)(.*)$/', $type, $matches)) {
            if (isset($this->typeMap[$matches[1]])) {
                return preg_replace('/\(.+\)/', '(' . $matches[2] . ')', $this->typeMap[$matches[1]]) . $matches[3];
            }
        } elseif (preg_match('/^(\w+)\s+/', $type, $matches)) {
            if (isset($this->typeMap[$matches[1]])) {
                return preg_replace('/^\w+/', $this->typeMap[$matches[1]], $type);
            }
        }
        return $type;
    }

getExpressionBuilder() public method (available since version 2.0.14)

Defined in: yii\db\QueryBuilder::getExpressionBuilder()

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.

Source code

                    public function getExpressionBuilder(ExpressionInterface $expression)
    {
        $className = get_class($expression);
        if (!isset($this->expressionBuilders[$className])) {
            foreach (array_reverse($this->expressionBuilders) as $expressionClass => $builderClass) {
                if (is_subclass_of($expression, $expressionClass)) {
                    $this->expressionBuilders[$className] = $builderClass;
                    break;
                }
            }
            if (!isset($this->expressionBuilders[$className])) {
                throw new InvalidArgumentException('Expression of class ' . $className . ' can not be built in ' . get_class($this));
            }
        }
        if ($this->expressionBuilders[$className] === __CLASS__) {
            return $this;
        }
        if (!is_object($this->expressionBuilders[$className])) {
            $this->expressionBuilders[$className] = new $this->expressionBuilders[$className]($this);
        }
        return $this->expressionBuilders[$className];
    }

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

Source code

                    protected function hasLimit($limit)
    {
        // In MySQL limit argument must be nonnegative integer constant
        return ctype_digit((string) $limit);
    }

hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function `method_exists()`. You may override this method when you implemented the php magic method `__call()`.

public boolean hasMethod ( $name )
$name | string | The method name
return | boolean | Whether the method is defined

Source code

                    public function hasMethod($name)
    {
        return method_exists($this, $name);
    }

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

Source code

                    protected function hasOffset($offset)
    {
        // In MySQL offset argument must be nonnegative integer constant
        $offset = (string) $offset;
        return ctype_digit($offset) && $offset !== '0';
    }

hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

A property is defined if:

- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);

See also:

- canGetProperty()
- canSetProperty()

public boolean hasProperty ( $name, $checkVars = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
return | boolean | Whether the property is defined

Source code

                    public function hasProperty($name, $checkVars = true)
    {
        return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
    }

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 ( )

Source code

                    public function init()
    {
        parent::init();
        $this->typeMap = array_merge($this->typeMap, $this->defaultTimeTypeMap());
    }

insert() public method

Defined in: yii\db\QueryBuilder::insert()

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

Source code

                    public function insert($table, $columns, &$params)
    {
        list($names, $placeholders, $values, $params) = $this->prepareInsertValues($table, $columns, $params);
        return 'INSERT INTO ' . $this->db->quoteTableName($table)
            . (!empty($names) ? ' (' . implode(', ', $names) . ')' : '')
            . (!empty($placeholders) ? ' VALUES (' . implode(', ', $placeholders) . ')' : $values);
    }

prepareInsertSelectSubQuery() protected method (available since version 2.0.11)

Defined in: yii\db\QueryBuilder::prepareInsertSelectSubQuery()

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.

Source code

                    protected function prepareInsertSelectSubQuery($columns, $schema, $params = [])
    {
        if (!is_array($columns->select) || empty($columns->select) || in_array('*', $columns->select)) {
            throw new InvalidArgumentException('Expected select query object with enumerated (named) parameters');
        }
        list($values, $params) = $this->build($columns, $params);
        $names = [];
        $values = ' ' . $values;
        foreach ($columns->select as $title => $field) {
            if (is_string($title)) {
                $names[] = $schema->quoteColumnName($title);
            } elseif (preg_match('/^(.*?)(?i:\s+as\s+|\s+)([\w\-_\.]+)$/', $field, $matches)) {
                $names[] = $schema->quoteColumnName($matches[2]);
            } else {
                $names[] = $schema->quoteColumnName($field);
            }
        }
        return [$names, $values, $params];
    }

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.

Source code

                    protected function prepareInsertValues($table, $columns, $params = [])
    {
        list($names, $placeholders, $values, $params) = parent::prepareInsertValues($table, $columns, $params);
        if (!$columns instanceof Query && empty($names)) {
            $tableSchema = $this->db->getSchema()->getTableSchema($table);
            if ($tableSchema !== null) {
                if (!empty($tableSchema->primaryKey)) {
                    $columns = $tableSchema->primaryKey;
                    $defaultValue = 'NULL';
                } else {
                    $columns = [reset($tableSchema->columns)->name];
                    $defaultValue = 'DEFAULT';
                }
                foreach ($columns as $name) {
                    $names[] = $this->db->quoteColumnName($name);
                    $placeholders[] = $defaultValue;
                }
            }
        }
        return [$names, $placeholders, $values, $params];
    }

prepareUpdateSets() protected method (available since version 2.0.14)

Defined in: yii\db\QueryBuilder::prepareUpdateSets()

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).

Source code

                    protected function prepareUpdateSets($table, $columns, $params = [])
    {
        $tableSchema = $this->db->getTableSchema($table);
        $columnSchemas = $tableSchema !== null ? $tableSchema->columns : [];
        $sets = [];
        foreach ($columns as $name => $value) {
            $value = isset($columnSchemas[$name]) ? $columnSchemas[$name]->dbTypecast($value) : $value;
            if ($value instanceof ExpressionInterface) {
                $placeholder = $this->buildExpression($value, $params);
            } else {
                $placeholder = $this->bindParam($value, $params);
            }
            $sets[] = $this->db->quoteColumnName($name) . '=' . $placeholder;
        }
        return [$sets, $params];
    }

prepareUpsertColumns() protected method (available since version 2.0.14)

Defined in: yii\db\QueryBuilder::prepareUpsertColumns()

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.

Source code

                    protected function prepareUpsertColumns($table, $insertColumns, $updateColumns, &$constraints = [])
    {
        if ($insertColumns instanceof Query) {
            list($insertNames) = $this->prepareInsertSelectSubQuery($insertColumns, $this->db->getSchema());
        } else {
            $insertNames = array_map([$this->db, 'quoteColumnName'], array_keys($insertColumns));
        }
        $uniqueNames = $this->getTableUniqueColumnNames($table, $insertNames, $constraints);
        $uniqueNames = array_map([$this->db, 'quoteColumnName'], $uniqueNames);
        if ($updateColumns !== true) {
            return [$uniqueNames, $insertNames, null];
        }
        return [$uniqueNames, $insertNames, array_diff($insertNames, $uniqueNames)];
    }

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.
throws | yii\db\Exception |

Source code

                    public function renameColumn($table, $oldName, $newName)
    {
        $quotedTable = $this->db->quoteTableName($table);
        $row = $this->db->createCommand('SHOW CREATE TABLE ' . $quotedTable)->queryOne();
        if ($row === false) {
            throw new Exception("Unable to find column '$oldName' in table '$table'.");
        }
        if (isset($row['Create Table'])) {
            $sql = $row['Create Table'];
        } else {
            $row = array_values($row);
            $sql = $row[1];
        }
        if (preg_match_all('/^\s*[`"](.*?)[`"]\s+(.*?),?$/m', $sql, $matches)) {
            foreach ($matches[1] as $i => $c) {
                if ($c === $oldName) {
                    return "ALTER TABLE $quotedTable CHANGE "
                        . $this->db->quoteColumnName($oldName) . ' '
                        . $this->db->quoteColumnName($newName) . ' '
                        . $matches[2][$i];
                }
            }
        }
        // try to give back a SQL anyway
        return "ALTER TABLE $quotedTable CHANGE "
            . $this->db->quoteColumnName($oldName) . ' '
            . $this->db->quoteColumnName($newName);
    }

renameTable() public method

Defined in: yii\db\QueryBuilder::renameTable()

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.

Source code

                    public function renameTable($oldName, $newName)
    {
        return 'RENAME TABLE ' . $this->db->quoteTableName($oldName) . ' TO ' . $this->db->quoteTableName($newName);
    }

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 1.

public string resetSequence ( $tableName, $value = null )
$tableName | string | The name of the table whose primary key sequence will be reset
$value | mixed | 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 a value 1.
return | 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.

Source code

                    public function resetSequence($tableName, $value = null)
    {
        $table = $this->db->getTableSchema($tableName);
        if ($table !== null && $table->sequenceName !== null) {
            $tableName = $this->db->quoteTableName($tableName);
            if ($value === null) {
                $key = reset($table->primaryKey);
                $value = $this->db->createCommand("SELECT MAX(`$key`) FROM $tableName")->queryScalar() + 1;
            } else {
                $value = (int) $value;
            }
            return "ALTER TABLE $tableName AUTO_INCREMENT=$value";
        } elseif ($table === null) {
            throw new InvalidArgumentException("Table not found: $tableName");
        }
        throw new InvalidArgumentException("There is no sequence associated with table '$tableName'.");
    }

selectExists() public method (available since version 2.0.8)

Defined in: yii\db\QueryBuilder::selectExists()

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.

Source code

                    public function selectExists($rawSql)
    {
        return 'SELECT EXISTS(' . $rawSql . ')';
    }

setConditionClasses() public method (available since version 2.0.14.2)

Defined in: yii\db\QueryBuilder::setConditionClasses()

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]

Source code

                    public function setConditionClasses($classes)
    {
        $this->conditionClasses = array_merge($this->conditionClasses, $classes);
    }

setExpressionBuilders() public method (available since version 2.0.14)

Defined in: yii\db\QueryBuilder::setExpressionBuilders()

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.

Source code

                    public function setExpressionBuilders($builders)
    {
        $this->expressionBuilders = array_merge($this->expressionBuilders, $builders);
    }

truncateTable() public method

Defined in: yii\db\QueryBuilder::truncateTable()

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.

Source code

                    public function truncateTable($table)
    {
        return 'TRUNCATE TABLE ' . $this->db->quoteTableName($table);
    }

update() public method

Defined in: yii\db\QueryBuilder::update()

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

Source code

                    public function update($table, $columns, $condition, &$params)
    {
        list($lines, $params) = $this->prepareUpdateSets($table, $columns, $params);
        $sql = 'UPDATE ' . $this->db->quoteTableName($table) . ' SET ' . implode(', ', $lines);
        $where = $this->buildWhere($condition, $params);
        return $where === '' ? $sql : $sql . ' ' . $where;
    }

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' => '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.

See also https://downloads.mysql.com/docs/refman-5.1-en.pdf.

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.

Source code

                    public function upsert($table, $insertColumns, $updateColumns, &$params)
    {
        $insertSql = $this->insert($table, $insertColumns, $params);
        list($uniqueNames, , $updateNames) = $this->prepareUpsertColumns($table, $insertColumns, $updateColumns);
        if (empty($uniqueNames)) {
            return $insertSql;
        }
        if ($updateNames === []) {
            // there are no columns to update
            $updateColumns = false;
        }
        if ($updateColumns === true) {
            $updateColumns = [];
            foreach ($updateNames as $name) {
                $updateColumns[$name] = new Expression('VALUES(' . $this->db->quoteColumnName($name) . ')');
            }
        } elseif ($updateColumns === false) {
            $name = $this->db->quoteColumnName(reset($uniqueNames));
            $updateColumns = [$name => new Expression($this->db->quoteTableName($table) . '.' . $name)];
        }
        list($updates, $params) = $this->prepareUpdateSets($table, $updateColumns, $params);
        return $insertSql . ' ON DUPLICATE KEY UPDATE ' . implode(', ', $updates);
    }