1 关注者

类 yii\db\QueryBuilder

继承yii\db\QueryBuilder » yii\base\BaseObject
实现yii\base\Configurable
子类yii\db\cubrid\QueryBuilder, yii\db\mssql\QueryBuilder, yii\db\mysql\QueryBuilder, yii\db\oci\QueryBuilder, yii\db\pgsql\QueryBuilder, yii\db\sqlite\QueryBuilder
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/db/QueryBuilder.php

QueryBuilder 基于给定的 yii\db\Query 对象规范构建 SELECT SQL 语句。

使用 build() 方法,从 yii\db\Query 对象创建 SQL 语句。

QueryBuilder 也用于 yii\db\Command 构建 SQL 语句,如 INSERT、UPDATE、DELETE、CREATE TABLE。

有关 QueryBuilder 的更多详细信息和使用信息,请参阅有关查询生成器的 指南文章

公共属性

隐藏继承的属性

属性 类型 描述 定义
$conditionBuilders array 查询条件到生成器方法的映射。 yii\db\QueryBuilder
$conditionClasses array 条件别名到条件类的映射。 yii\db\QueryBuilder
$db yii\db\Connection 数据库连接。 yii\db\QueryBuilder
$expressionBuilders string[]|yii\db\ExpressionBuilderInterface[] 将表达式类映射到表达式生成器类。 yii\db\QueryBuilder
$separator string SQL 语句中不同片段之间的分隔符。 yii\db\QueryBuilder
$typeMap array 抽象列类型映射到物理列类型。 yii\db\QueryBuilder

受保护的属性

隐藏继承的属性

属性 类型 描述 定义

公共方法

隐藏继承的方法

方法 描述 定义
__call() 调用不是类方法的命名方法。 yii\base\BaseObject
__construct() 构造函数。 yii\db\QueryBuilder
__get() 返回对象属性的值。 yii\base\BaseObject
__isset() 检查属性是否已设置,即已定义且不为空。 yii\base\BaseObject
__set() 设置对象属性的值。 yii\base\BaseObject
__unset() 将对象属性设置为 null。 yii\base\BaseObject
addCheck() 创建将检查约束添加到现有表的 SQL 命令。 yii\db\QueryBuilder
addColumn() 构建添加新数据库列的 SQL 语句。 yii\db\QueryBuilder
addCommentOnColumn() 构建向列添加注释的 SQL 命令。 yii\db\QueryBuilder
addCommentOnTable() 构建向表添加注释的 SQL 命令。 yii\db\QueryBuilder
addDefaultValue() 创建将默认值约束添加到现有表的 SQL 命令。 yii\db\QueryBuilder
addForeignKey() 构建将外键约束添加到现有表的 SQL 语句。 yii\db\QueryBuilder
addPrimaryKey() 构建将主键约束添加到现有表的 SQL 语句。 yii\db\QueryBuilder
addUnique() 创建将唯一约束添加到现有表的 SQL 命令。 yii\db\QueryBuilder
alterColumn() 构建更改列定义的 SQL 语句。 yii\db\QueryBuilder
batchInsert() 生成批处理 INSERT SQL 语句。 yii\db\QueryBuilder
bindParam() 辅助方法,使用 PARAM_PREFIX 将 $value 添加到 $params 数组。 yii\db\QueryBuilder
build() yii\db\Query 对象生成 SELECT SQL 语句。 yii\db\QueryBuilder
buildAndCondition() 使用 ANDOR 运算符连接两个或多个 SQL 表达式。 yii\db\QueryBuilder
buildBetweenCondition() 使用 BETWEEN 运算符创建 SQL 表达式。 yii\db\QueryBuilder
buildColumns() 处理列,并在必要时正确引用它们。 yii\db\QueryBuilder
buildCondition() 解析条件规范并生成相应的 SQL 表达式。 yii\db\QueryBuilder
buildExistsCondition() 使用 EXISTS 运算符创建 SQL 表达式。 yii\db\QueryBuilder
buildExpression() 构建给定的 $expression yii\db\QueryBuilder
buildFrom() yii\db\QueryBuilder
buildGroupBy() yii\db\QueryBuilder
buildHashCondition() 基于列-值对创建条件。 yii\db\QueryBuilder
buildHaving() yii\db\QueryBuilder
buildInCondition() 使用 IN 运算符创建 SQL 表达式。 yii\db\QueryBuilder
buildJoin() yii\db\QueryBuilder
buildLikeCondition() 使用 LIKE 运算符创建 SQL 表达式。 yii\db\QueryBuilder
buildLimit() yii\db\QueryBuilder
buildNotCondition() 使用 NOT 运算符反转 SQL 表达式。 yii\db\QueryBuilder
buildOrderBy() yii\db\QueryBuilder
buildOrderByAndLimit() 构建 ORDER BY 和 LIMIT/OFFSET 子句,并将它们追加到给定的 SQL。 yii\db\QueryBuilder
buildSelect() yii\db\QueryBuilder
buildSimpleCondition() 创建类似于 "column" operator value 的 SQL 表达式。 yii\db\QueryBuilder
buildUnion() yii\db\QueryBuilder
buildWhere() yii\db\QueryBuilder
buildWithQueries() yii\db\QueryBuilder
canGetProperty() 返回一个值,指示属性是否可读。 yii\base\BaseObject
canSetProperty() 返回一个值,指示属性是否可设置。 yii\base\BaseObject
checkIntegrity() 构建启用或禁用完整性检查的 SQL 语句。 yii\db\QueryBuilder
className() 返回此类的完全限定名称。 yii\base\BaseObject
createConditionFromArray() 将 $condition 转换为数组格式(如 yii\db\Query::where() 中所述)中的 $condition,根据 $conditionClasses 映射转换为 yii\db\condition\ConditionInterface 实例。 yii\db\QueryBuilder
createIndex() 构建创建新索引的 SQL 语句。 yii\db\QueryBuilder
createTable() 构建创建新数据库表的 SQL 语句。 yii\db\QueryBuilder
createView() 创建 SQL 视图。 yii\db\QueryBuilder
delete() 创建 DELETE SQL 语句。 yii\db\QueryBuilder
dropCheck() 创建删除检查约束的 SQL 命令。 yii\db\QueryBuilder
dropColumn() 构建删除数据库列的 SQL 语句。 yii\db\QueryBuilder
dropCommentFromColumn() 构建向列添加注释的 SQL 命令。 yii\db\QueryBuilder
dropCommentFromTable() 构建向表添加注释的 SQL 命令。 yii\db\QueryBuilder
dropDefaultValue() 创建删除默认值约束的 SQL 命令。 yii\db\QueryBuilder
dropForeignKey() 构建删除外键约束的 SQL 语句。 yii\db\QueryBuilder
dropIndex() 构建删除索引的 SQL 语句。 yii\db\QueryBuilder
dropPrimaryKey() 构建从现有表中删除主键约束的 SQL 语句。 yii\db\QueryBuilder
dropTable() 构建删除数据库表的 SQL 语句。 yii\db\QueryBuilder
dropUnique() 创建删除唯一约束的 SQL 命令。 yii\db\QueryBuilder
dropView() 删除 SQL 视图。 yii\db\QueryBuilder
executeResetSequence() 执行 SQL 语句以重置表主键的序列值。 yii\db\QueryBuilder
getColumnType() 将抽象列类型转换为物理列类型。 yii\db\QueryBuilder
getExpressionBuilder() 获取适用于 $expression 的 yii\db\ExpressionBuilderInterface 对象。 yii\db\QueryBuilder
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\BaseObject
hasProperty() 返回一个值,指示属性是否已定义。 yii\base\BaseObject
init() 初始化对象。 yii\db\QueryBuilder
insert() 创建 INSERT SQL 语句。 yii\db\QueryBuilder
renameColumn() 构建重命名列的 SQL 语句。 yii\db\QueryBuilder
renameTable() 构建重命名数据库表的 SQL 语句。 yii\db\QueryBuilder
resetSequence() 创建 SQL 语句以重置表主键的序列值。 yii\db\QueryBuilder
selectExists() 创建 SELECT EXISTS() SQL 语句。 yii\db\QueryBuilder
setConditionClasses() 设置 $conditionClasses 属性。 yii\db\QueryBuilder
setExpressionBuilders() 设置 $expressionBuilders 属性。 yii\db\QueryBuilder
truncateTable() 构建截断数据库表的 SQL 语句。 yii\db\QueryBuilder
update() 创建 UPDATE SQL 语句。 yii\db\QueryBuilder
upsert() 创建 SQL 语句,如果数据库表中不存在行(匹配唯一约束),则将行插入数据库表,如果存在,则更新它们。 yii\db\QueryBuilder

受保护方法

隐藏继承的方法

方法 描述 定义
defaultConditionClasses() 包含默认条件类数组。如果您想更改查询构建器的默认条件类,请扩展此方法。有关详细信息,请参见 $conditionClasses 文档。 yii\db\QueryBuilder
defaultExpressionBuilders() 包含默认表达式构建器数组。如果您想更改此查询构建器的默认表达式构建器,请扩展此方法并覆盖它。有关详细信息,请参见 $expressionBuilders 文档。 yii\db\QueryBuilder
extractAlias() 如果存在,则提取表别名,否则返回 false yii\db\QueryBuilder
hasLimit() 检查给定的限制是否有效。 yii\db\QueryBuilder
hasOffset() 检查给定的偏移量是否有效。 yii\db\QueryBuilder
prepareInsertSelectSubQuery() 为 INSERT INTO ... SELECT SQL 语句准备 select-subquery 和字段名称。 yii\db\QueryBuilder
prepareInsertValues() 为 INSERT SQL 语句准备 VALUES 部分。 yii\db\QueryBuilder
prepareUpdateSets() 为 UPDATE SQL 语句准备 SET 部分。 yii\db\QueryBuilder
prepareUpsertColumns() yii\db\QueryBuilder

常量

隐藏继承的常量

常量 描述 定义
PARAM_PREFIX ':qp' 自动生成的查询绑定参数的前缀。 yii\db\QueryBuilder

属性详细信息

隐藏继承的属性

$conditionBuilders 受保护属性
自 2.0.14 版起已弃用。不再使用,将在 2.1.0 中删除。

查询条件到构建器方法的映射。这些方法由 buildCondition() 用于从数组语法构建 SQL 条件。

protected array $conditionBuilders = []
$conditionClasses 受保护属性(自版本 2.0.14 起可用)

条件别名到条件类的映射。例如

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

此属性由 createConditionFromArray() 方法使用。请参见 defaultConditionClasses() 方法中的默认条件类列表。

如果您想添加自定义条件支持,请使用 setConditionClasses() 方法。

另请参见

protected array $conditionClasses = []
$db 公共属性

数据库连接。

public yii\db\Connection $db null
$expressionBuilders 受保护属性(自版本 2.0.14 起可用)

将表达式类映射到表达式构建器类。例如

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

此属性主要由 buildExpression() 用于从表达式对象构建 SQL 表达式。请参见 defaultExpressionBuilders() 方法中的默认值。

要覆盖现有构建器或添加自定义构建器,请使用 setExpressionBuilder() 方法。新项目将添加到此数组的末尾。

为了找到构建器,buildExpression() 将检查表达式类在此映射中的确切存在情况。如果不存在,则将以相反方向遍历数组,检查表达式是否扩展了在此映射中定义的类。

另请参见

$separator 公共属性

SQL 语句的不同片段之间的分隔符。默认为空格。这主要由 build() 在生成 SQL 语句时使用。

public string $separator ' '
$typeMap 公共属性

抽象列类型映射到物理列类型。这主要用于支持使用与数据库无关的数据类型规范创建/修改表。子类应该覆盖此属性以声明支持的类型映射。

public array $typeMap = []

方法详细信息

隐藏继承的方法

__call() 公共方法

定义于: yii\base\BaseObject::__call()

调用不是类方法的命名方法。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时将隐式调用。

public mixed __call ( $name, $params )
$name string

方法名称

$params array

方法参数

return mixed

方法返回值

throws yii\base\UnknownMethodException

当调用未知方法时

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

            
__construct() 公共方法

构造函数。

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

数据库连接。

$config array

将用于初始化对象属性的名称-值对

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

            
__get() 公共方法

定义于: yii\base\BaseObject::__get()

返回对象属性的值。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $value = $object->property; 时将隐式调用。

另请参见 __set()

public mixed __get ( $name )
$name string

属性名称

return mixed

属性值

throws yii\base\UnknownPropertyException

如果未定义属性

throws yii\base\InvalidCallException

如果属性是只写属性

                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() 公共方法

定义于: yii\base\BaseObject::__isset()

检查属性是否已设置,即已定义且不为空。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 isset($object->property) 时将隐式调用。

请注意,如果未定义属性,则将返回 false。

另请参见 https://php.ac.cn/manual/en/function.isset.php

public boolean __isset ( $name )
$name string

属性名称或事件名称

return 布尔值

命名的属性是否已设置(非空)。

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

            
__set() 公共方法

定义于: yii\base\BaseObject::__set()

设置对象属性的值。

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $object->property = $value; 时会隐式调用。

另请参阅 __get()

public void __set ( $name, $value )
$name string

属性名称或事件名称

$value mixed

属性值

throws yii\base\UnknownPropertyException

如果未定义属性

throws yii\base\InvalidCallException

如果属性是只读的

                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() 公共方法

定义于: yii\base\BaseObject::__unset()

将对象属性设置为 null。

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 unset($object->property) 时会隐式调用。

请注意,如果属性未定义,此方法将不做任何事情。如果属性是只读的,它将抛出一个异常。

另请参阅 https://php.ac.cn/manual/en/function.unset.php

public void __unset ( $name )
$name string

属性名称

throws yii\base\InvalidCallException

如果属性是只读的。

                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() 公共方法 (自版本 2.0.13 起可用)

创建将检查约束添加到现有表的 SQL 命令。

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

检查约束的名称。该名称将由该方法正确引用。

$table string

将添加检查约束的表。该名称将由该方法正确引用。

$expression string

CHECK 约束的 SQL 语句。

return string

将检查约束添加到现有表的 SQL 语句。

                public function addCheck($name, $table, $expression)
{
    return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' ADD CONSTRAINT '
        . $this->db->quoteColumnName($name) . ' CHECK (' . $this->db->quoteSql($expression) . ')';
}

            
addColumn() 公共方法

构建添加新数据库列的 SQL 语句。

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

将添加新列的表。表名称将由该方法正确引用。

$column string

新列的名称。该名称将由该方法正确引用。

$type string

列类型。将调用 getColumnType() 方法将抽象列类型(如果有)转换为物理类型。任何未被识别为抽象类型的类型将保留在生成的 SQL 中。例如,'string' 将转换为 'varchar(255)',而 'string not null' 将变为 'varchar(255) not null'。

return string

添加新列的 SQL 语句。

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

            
addCommentOnColumn() 公共方法 (自版本 2.0.8 起可用)

构建向列添加注释的 SQL 命令。

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

要添加注释的列所在的表。表名称将由该方法正确引用。

$column string

要添加注释的列的名称。列名称将由该方法正确引用。

$comment string

要添加的注释文本。该注释将由该方法正确引用。

return string

在列上添加注释的 SQL 语句

                public function addCommentOnColumn($table, $column, $comment)
{
    return 'COMMENT ON COLUMN ' . $this->db->quoteTableName($table) . '.' . $this->db->quoteColumnName($column) . ' IS ' . $this->db->quoteValue($comment);
}

            
addCommentOnTable() 公共方法 (自版本 2.0.8 起可用)

构建向表添加注释的 SQL 命令。

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

要添加注释的列所在的表。表名称将由该方法正确引用。

$comment string

要添加的注释文本。该注释将由该方法正确引用。

return string

在表上添加注释的 SQL 语句

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

            
addDefaultValue() 公共方法 (自版本 2.0.13 起可用)

创建将默认值约束添加到现有表的 SQL 命令。

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

默认值约束的名称。该名称将由该方法正确引用。

$table string

将添加默认值约束的表。该名称将由该方法正确引用。

$column string

将添加约束的列的名称。该名称将由该方法正确引用。

$value mixed

默认值。

return string

将默认值约束添加到现有表的 SQL 语句。

throws yii\base\NotSupportedException

如果底层 DBMS 不支持。

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

            
addForeignKey() 公共方法

构建将外键约束添加到现有表的 SQL 语句。

该方法将正确引用表和列名称。

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

外键约束的名称。

$table string

将添加外键约束的表。

$columns string|array

将添加约束的列的名称。如果有多个列,用逗号分隔它们,或使用数组来表示它们。

$refTable string

外键引用的表。

$refColumns string|array

外键引用的列的名称。如果有多个列,用逗号分隔它们,或使用数组来表示它们。

$delete string|null

ON DELETE 选项。大多数 DBMS 支持以下选项:RESTRICT、CASCADE、NO ACTION、SET DEFAULT、SET NULL

$update string|null

ON UPDATE 选项。大多数 DBMS 支持以下选项:RESTRICT、CASCADE、NO ACTION、SET DEFAULT、SET NULL

return string

将外键约束添加到现有表的 SQL 语句。

                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() 公共方法

构建将主键约束添加到现有表的 SQL 语句。

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

主键约束的名称。

$table string

将添加主键约束的表。

$columns string|array

主键将由其组成的列的逗号分隔字符串或数组。

return string

将主键约束添加到现有表的 SQL 语句。

                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() 公共方法 (自版本 2.0.13 起可用)

创建将唯一约束添加到现有表的 SQL 命令。

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

唯一约束的名称。该名称将由方法正确地引用。

$table string

将添加唯一约束的表。该名称将由方法正确地引用。

$columns string|array

将添加约束的列的名称。如果有多个列,则用逗号隔开。该名称将由方法正确地引用。

return string

将唯一约束添加到现有表的 SQL 语句。

                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() 公共方法

构建更改列定义的 SQL 语句。

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

要更改其列的表。表名将由方法正确地引用。

$column string

要更改的列的名称。该名称将由方法正确地引用。

$type string

新的列类型。将调用 getColumnType() 方法将抽象列类型(如果有)转换为物理类型。任何不被识别为抽象类型的类型都将保留在生成的 SQL 中。例如,'string' 将被转换为 'varchar(255)',而 'string not null' 将变为 'varchar(255) not null'。

return string

更改列定义的 SQL 语句。

                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() 公共方法

生成批处理 INSERT SQL 语句。

例如,

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

请注意,每行中的值必须与相应的列名匹配。

该方法将正确地转义列名,并引用要插入的值。

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

将插入新行的表。

$columns array

列名

$rows array|Generator

要批量插入到表中的行

$params array

绑定参数。此参数自 2.0.14 起存在

return string

批量 INSERT SQL 语句

                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() 公共方法 (自版本 2.0.14 起可用)

辅助方法,使用 PARAM_PREFIX 将 $value 添加到 $params 数组。

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

按引用传递

return string

$params 数组中的占位符名称

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

            
build() 公共方法

yii\db\Query 对象生成 SELECT SQL 语句。

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

将从中生成 SQL 语句的 yii\db\Query 对象。

$params array

要绑定到生成的 SQL 语句的参数。这些参数将包含在结果中,以及在查询构建过程中生成的额外参数。

return array

生成的 SQL 语句(第一个数组元素)以及要绑定到 SQL 语句的相应参数(第二个数组元素)。返回的参数包括在 $params 中提供的参数。

                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() 公共方法
自 2.0.14 起弃用。请使用 buildCondition() 代替。

使用 ANDOR 运算符连接两个或多个 SQL 表达式。

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

用于连接给定操作数的操作符

$operands array

要连接的 SQL 表达式。

$params array

要填充的绑定参数

return string

生成的 SQL 表达式

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

            
buildBetweenCondition() 公共方法
自 2.0.14 起弃用。请使用 buildCondition() 代替。

使用 BETWEEN 运算符创建 SQL 表达式。

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

要使用的操作符(例如 BETWEENNOT BETWEEN

$operands array

第一个操作数是列名。第二个和第三个操作数描述列值应该在的区间。

$params array

要填充的绑定参数

return string

生成的 SQL 表达式

throws yii\base\InvalidArgumentException

如果给出错误的操作数数量。

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

            
buildColumns() 公共方法

处理列,并在必要时正确引用它们。

它将所有列连接成一个字符串,以逗号作为分隔符。

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

要处理的列

return string

处理结果

                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() 公共方法

解析条件规范并生成相应的 SQL 表达式。

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

条件规范。请参阅 yii\db\Query::where() 了解如何指定条件。

$params array

要填充的绑定参数

return string

生成的 SQL 表达式

                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() 公共方法
自 2.0.14 起弃用。请使用 buildCondition() 代替。

使用 EXISTS 运算符创建 SQL 表达式。

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

要使用的操作符(例如 EXISTSNOT EXISTS

$operands array

仅包含一个元素,该元素是一个 yii\db\Query 对象,代表子查询。

$params array

要填充的绑定参数

return string

生成的 SQL 表达式

throws yii\base\InvalidArgumentException

如果操作数不是 yii\db\Query 对象。

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

            
buildExpression() 公共方法 (自版本 2.0.14 起可用)
public string buildExpression ( yii\db\ExpressionInterface $expression, &$params = [] )
$expression yii\db\ExpressionInterface

要构建的表达式

$params array

要绑定到生成的 SQL 语句的参数。这些参数将在表达式构建过程中生成的附加参数中包含在结果中。

return string

将不会在传递给 DBMS 之前被引用或编码的 SQL 语句

throws yii\base\InvalidArgumentException

当此 QueryBuilder 不支持 $expression 构建时。

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

            
buildFrom() 公共方法

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

要填充的绑定参数

return string

yii\db\Query::$from 构建的 FROM 子句。

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

            
buildGroupBy() 公共方法

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

GROUP BY 子句

                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() 公共方法
自 2.0.14 起弃用。请使用 buildCondition() 代替。

基于列-值对创建条件。

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

条件规范。

$params array

要填充的绑定参数

return string

生成的 SQL 表达式

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

            
buildHaving() 公共方法

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

要填充的绑定参数

return string

yii\db\Query::$having 构建的 HAVING 子句。

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

            
buildInCondition() 公共方法
自 2.0.14 起弃用。请使用 buildCondition() 代替。

使用 IN 运算符创建 SQL 表达式。

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

要使用的运算符(例如 INNOT IN

$operands array

第一个操作数是列名。如果它是一个数组,则将生成一个复合 IN 条件。第二个操作数是一个值数组,列值应该在其中。如果它是一个空数组,则如果运算符为 IN,则生成的表达式将是一个 false 值,如果运算符为 NOT IN,则为空。

$params array

要填充的绑定参数

return string

生成的 SQL 表达式

throws yii\db\Exception

如果给出错误的操作数数量。

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

            
buildJoin() 公共方法

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

要填充的绑定参数

return string

yii\db\Query::$join 构建的 JOIN 子句。

throws yii\db\Exception

如果 $joins 参数格式不正确

                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() 公共方法
自 2.0.14 起弃用。请使用 buildCondition() 代替。

使用 LIKE 运算符创建 SQL 表达式。

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

要使用的运算符(例如 LIKENOT LIKEOR LIKEOR NOT LIKE

$operands array

包含两个或三个操作数的数组

  • 第一个操作数是列名。
  • 第二个操作数是一个单一值或一个值数组,列值应该与之比较。如果它是一个空数组,则如果运算符为 LIKEOR LIKE,则生成的表达式将是一个 false 值,如果运算符为 NOT LIKEOR NOT LIKE,则为空。
  • 还可以提供一个可选的第三个操作数来指定如何转义值中的特殊字符。操作数应该是特殊字符与其转义对应项之间映射的数组。如果没有提供此操作数,将使用默认转义映射。可以使用 false 或空数组来表示值已经转义,不需要应用转义。请注意,使用转义映射(或未提供第三个操作数)时,值将自动用一对百分号括起来。
$params array

要填充的绑定参数

return string

生成的 SQL 表达式

throws yii\base\InvalidArgumentException

如果给出错误的操作数数量。

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

            
buildLimit() 公共方法

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

LIMIT 和 OFFSET 子句

                public function buildLimit($limit, $offset)
{
    $sql = '';
    if ($this->hasLimit($limit)) {
        $sql = 'LIMIT ' . $limit;
    }
    if ($this->hasOffset($offset)) {
        $sql .= ' OFFSET ' . $offset;
    }
    return ltrim($sql);
}

            
buildNotCondition() 公共方法
自 2.0.14 起弃用。请使用 buildCondition() 代替。

使用 NOT 运算符反转 SQL 表达式。

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

用于连接给定操作数的操作符

$operands array

要连接的 SQL 表达式。

$params array

要填充的绑定参数

return string

生成的 SQL 表达式

throws yii\base\InvalidArgumentException

如果给出错误的操作数数量。

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

            
buildOrderBy() 公共方法

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

yii\db\Query::$orderBy 构建的 ORDER BY 子句。

                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() 公共方法

构建 ORDER BY 和 LIMIT/OFFSET 子句,并将它们追加到给定的 SQL。

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

现有的 SQL(没有 ORDER BY/LIMIT/OFFSET)

$orderBy array

排序列。有关如何指定此参数的更多详细信息,请参见 yii\db\Query::orderBy()

$limit integer

限制数量。有关更多详细信息,请参见 yii\db\Query::limit()

$offset integer

偏移量。有关更多详细信息,请参见 yii\db\Query::offset()

return string

完成 ORDER BY/LIMIT/OFFSET(如果有)的 SQL

                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 string buildSelect ( $columns, &$params, $distinct false, $selectOption null )
$columns array
$params array

要填充的绑定参数

$distinct 布尔值
$selectOption string|null
return string

yii\db\Query::$select 生成的 SELECT 语句。

                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() 公共方法
自 2.0.14 起弃用。请使用 buildCondition() 代替。

创建类似于 "column" operator value 的 SQL 表达式。

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

要使用的运算符。任何内容都可以使用,例如 ><= 等。

$operands array

包含两个列名。

$params array

要填充的绑定参数

return string

生成的 SQL 表达式

throws yii\base\InvalidArgumentException

如果给出错误的操作数数量。

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

            
buildUnion() 公共方法

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

要填充的绑定参数

return string

yii\db\Query::$union 生成的 UNION 子句。

                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 string buildWhere ( $condition, &$params )
$condition string|array
$params array

要填充的绑定参数

return string

yii\db\Query::$where 生成的 WHERE 子句。

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

            
buildWithQueries() 公共方法 (version 2.0.35 及更高版本可用)

另请参阅 yii\db\Query::withQuery()

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

每个 WITH 查询的配置

$params array

要填充的绑定参数

return string

编译后的 WITH 查询的前缀,包括嵌套查询

                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() 公共方法

定义于: yii\base\BaseObject::canGetProperty()

返回一个值,指示属性是否可读。

如果属性可读,则

  • 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为真时);

另请参阅 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true )
$name string

属性名称

$checkVars 布尔值

是否将成员变量视为属性

return 布尔值

属性是否可读

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

            
canSetProperty() 公共方法

定义于: yii\base\BaseObject::canSetProperty()

返回一个值,指示属性是否可设置。

如果属性可写,则

  • 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为真时);

另请参阅 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true )
$name string

属性名称

$checkVars 布尔值

是否将成员变量视为属性

return 布尔值

属性是否可写

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

            
checkIntegrity() 公共方法

构建启用或禁用完整性检查的 SQL 语句。

public string checkIntegrity ( $check true, $schema '', $table '' )
$check 布尔值

是否启用或禁用完整性检查。

$schema string

表的模式。默认为空字符串,表示当前或默认模式。

$table string

表名。默认为空字符串,表示不会更改任何表。

return string

用于检查完整性的 SQL 语句

throws yii\base\NotSupportedException

如果底层 DBMS 不支持该语句

                public function checkIntegrity($check = true, $schema = '', $table = '')
{
    throw new NotSupportedException($this->db->getDriverName() . ' does not support enabling/disabling integrity check.');
}

            
className() 公共静态方法
自 2.0.14 版本起已弃用。在 PHP >=5.5 中,请使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
return string

此类的完全限定名称。

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

            
createConditionFromArray() 公共方法 (version 2.0.14 及更高版本可用)

将 $condition 转换为数组格式(如 yii\db\Query::where() 中所述)中的 $condition,根据 $conditionClasses 映射转换为 yii\db\condition\ConditionInterface 实例。

另请参阅 $conditionClasses

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

                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() 公共方法

构建创建新索引的 SQL 语句。

public string createIndex ( $name, $table, $columns, $unique false )
$name string

索引的名称。该名称将由方法正确地引用。

$table string

将创建新索引的表。表名将由方法正确地引用。

$columns string|array

应包含在索引中的列。如果有多个列,请用逗号分隔或使用数组表示它们。每个列名将由方法正确地引用,除非在名称中找到括号。

$unique 布尔值

是否在创建的索引上添加 UNIQUE 约束。

return string

创建新索引的 SQL 语句。

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

            
createTable() 公共方法

构建创建新数据库表的 SQL 语句。

新表中的列应指定为名称-定义对(例如 'name' => 'string'),其中名称代表列名,该列名将由方法正确引用,而定义代表必须包含抽象数据库类型的列类型。getColumnType() 方法将被调用以将任何抽象类型转换为物理类型。

如果列仅用定义指定(例如 'PRIMARY KEY (name, type)'),它将直接插入到生成的 SQL 中。

例如,

$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

要创建的表的名称。该名称将由方法正确引用。

$columns array

新表中的列(名称 => 定义)。

$options string|null

将附加到生成的 SQL 的其他 SQL 片段。

return string

创建新数据库表的 SQL 语句。

                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() 公共方法 (版本 2.0.14 及更高版本可用)

创建 SQL 视图。

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

要创建的视图的名称。

$subQuery string|yii\db\Query

定义视图的选择语句。这可以是字符串或yii\db\Query对象。

return string

CREATE VIEW SQL 语句。

                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() 受保护方法 (版本 2.0.14 及更高版本可用)

包含默认条件类数组。如果您想更改查询构建器的默认条件类,请扩展此方法。有关详细信息,请参见 $conditionClasses 文档。

另请参阅 $conditionClasses

protected array defaultConditionClasses ( )

                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() 受保护方法 (版本 2.0.14 及更高版本可用)

包含默认表达式构建器数组。如果您想更改此查询构建器的默认表达式构建器,请扩展此方法并覆盖它。有关详细信息,请参见 $expressionBuilders 文档。

另请参阅$expressionBuilders

protected array defaultExpressionBuilders ( )

                protected function defaultExpressionBuilders()
{
    return [
        'yii\db\Query' => 'yii\db\QueryExpressionBuilder',
        'yii\db\PdoValue' => 'yii\db\PdoValueBuilder',
        'yii\db\Expression' => 'yii\db\ExpressionBuilder',
        'yii\db\conditions\ConjunctionCondition' => 'yii\db\conditions\ConjunctionConditionBuilder',
        'yii\db\conditions\NotCondition' => 'yii\db\conditions\NotConditionBuilder',
        'yii\db\conditions\AndCondition' => 'yii\db\conditions\ConjunctionConditionBuilder',
        'yii\db\conditions\OrCondition' => 'yii\db\conditions\ConjunctionConditionBuilder',
        'yii\db\conditions\BetweenCondition' => 'yii\db\conditions\BetweenConditionBuilder',
        'yii\db\conditions\InCondition' => 'yii\db\conditions\InConditionBuilder',
        'yii\db\conditions\LikeCondition' => 'yii\db\conditions\LikeConditionBuilder',
        'yii\db\conditions\ExistsCondition' => 'yii\db\conditions\ExistsConditionBuilder',
        'yii\db\conditions\SimpleCondition' => 'yii\db\conditions\SimpleConditionBuilder',
        'yii\db\conditions\HashCondition' => 'yii\db\conditions\HashConditionBuilder',
        'yii\db\conditions\BetweenColumnsCondition' => 'yii\db\conditions\BetweenColumnsConditionBuilder',
    ];
}

            
delete() 公共方法

创建 DELETE SQL 语句。

例如,

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

该方法将正确转义表名和列名。

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

将从中删除数据的表。

$condition array|string

将放在 WHERE 部分中的条件。请参考yii\db\Query::where()了解如何指定条件。

$params array

将由此方法修改的绑定参数,以便它们可以稍后绑定到数据库命令。

return string

DELETE SQL

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

            
dropCheck() 公共方法 (版本 2.0.13 及更高版本可用)

创建删除检查约束的 SQL 命令。

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

要删除的检查约束的名称。该名称将由方法正确引用。

$table string

要删除检查约束的表。该名称将由方法正确引用。

return string

删除检查约束的 SQL 语句。

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

            
dropColumn() 公共方法

构建删除数据库列的 SQL 语句。

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

要删除其列的表。该名称将由方法正确引用。

$column string

要删除的列的名称。该名称将由方法正确引用。

return string

删除数据库列的 SQL 语句。

                public function dropColumn($table, $column)
{
    return 'ALTER TABLE ' . $this->db->quoteTableName($table)
        . ' DROP COLUMN ' . $this->db->quoteColumnName($column);
}

            
dropCommentFromColumn() 公共方法 (版本 2.0.8 及更高版本可用)

构建向列添加注释的 SQL 命令。

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

要添加注释的列所在的表。表名称将由该方法正确引用。

$column string

要添加注释的列的名称。列名称将由该方法正确引用。

return string

在列上添加注释的 SQL 语句

                public function dropCommentFromColumn($table, $column)
{
    return 'COMMENT ON COLUMN ' . $this->db->quoteTableName($table) . '.' . $this->db->quoteColumnName($column) . ' IS NULL';
}

            
dropCommentFromTable() 公共方法 (版本 2.0.8 及更高版本可用)

构建向表添加注释的 SQL 命令。

public string dropCommentFromTable ( $table )
$table string

要添加注释的列所在的表。表名称将由该方法正确引用。

return string

在列上添加注释的 SQL 语句

                public function dropCommentFromTable($table)
{
    return 'COMMENT ON TABLE ' . $this->db->quoteTableName($table) . ' IS NULL';
}

            
dropDefaultValue() 公共方法 (版本 2.0.13 及更高版本可用)

创建删除默认值约束的 SQL 命令。

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

要删除的默认值约束的名称。该名称将由方法正确引用。

$table string

要删除其默认值约束的表。该名称将由方法正确引用。

return string

删除默认值约束的 SQL 语句。

throws yii\base\NotSupportedException

如果底层 DBMS 不支持。

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

            
dropForeignKey() 公共方法

构建删除外键约束的 SQL 语句。

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

要删除的外键约束的名称。该名称将由方法正确引用。

$table string

要删除外键的表。该名称将由方法正确引用。

return string

删除外键约束的 SQL 语句。

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

            
dropIndex() 公共方法

构建删除索引的 SQL 语句。

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

要删除的索引的名称。该名称将由方法正确引用。

$table string

要删除其索引的表。该名称将由方法正确引用。

return string

删除索引的 SQL 语句。

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

            
dropPrimaryKey() 公共方法

构建从现有表中删除主键约束的 SQL 语句。

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

要移除的主键约束名称。

$table string

将移除主键约束的表。

return string

从现有表中移除主键约束的 SQL 语句。

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

            
dropTable() 公共方法

构建删除数据库表的 SQL 语句。

public string dropTable ( $table )
$table string

要删除的表。方法将正确引用名称。

return string

删除数据库表的 SQL 语句。

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

            
dropUnique() 公共方法 (自版本 2.0.13 起可用)

创建删除唯一约束的 SQL 命令。

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

要删除的唯一约束名称。方法将正确引用名称。

$table string

要删除其唯一约束的表。方法将正确引用名称。

return string

删除唯一约束的 SQL 语句。

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

            
dropView() 公共方法 (自版本 2.0.14 起可用)

删除 SQL 视图。

public string dropView ( $viewName )
$viewName string

要删除的视图名称。

return string

DROP VIEW SQL 语句。

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

            
executeResetSequence() 公共方法 (自版本 2.0.16 起可用)

执行 SQL 语句以重置表主键的序列值。

执行的原因是某些数据库 (Oracle) 需要多个查询才能做到。序列将重置,以便插入的下一个新行的主键将具有指定的值或最大现有值 +1。

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

主键序列将被重置的表的名称

$value array|string|null

插入的下一个新行的主键的值。如果未设置,则下一个新行的主键将具有最大现有值 +1。

throws yii\base\NotSupportedException

如果底层 DBMS 不支持该语句

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

            
extractAlias() 受保护方法 (自版本 2.0.24 起可用)

如果存在,则提取表别名,否则返回 false

protected boolean|array extractAlias ( $table )
$table

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

            
getColumnType() 公共方法

将抽象列类型转换为物理列类型。

转换是使用在 $typeMap 中指定的类型映射完成的。以下抽象列类型受支持(使用 MySQL 作为示例来解释相应的物理类型)

  • pk: 自增主键类型,将转换为 "int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY"
  • bigpk: 自增主键类型,将转换为 "bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY"
  • upk: 无符号自增主键类型,将转换为 "int(10) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY"
  • char: 字符类型,将转换为 "char(1)"
  • string: 字符串类型,将转换为 "varchar(255)"
  • text: 长字符串类型,将转换为 "text"
  • smallint: 小整数类型,将转换为 "smallint(6)"
  • integer: 整数类型,将转换为 "int(11)"
  • bigint: 大整数类型,将转换为 "bigint(20)"
  • boolean: 布尔类型,将转换为 "tinyint(1)"
  • float`: 浮点数类型,将转换为 "float"
  • decimal: 十进制数类型,将转换为 "decimal"
  • datetime: 日期时间类型,将转换为 "datetime"
  • timestamp: 时间戳类型,将转换为 "timestamp"
  • time: 时间类型,将转换为 "time"
  • date: 日期类型,将转换为 "date"
  • money: 金钱类型,将转换为 "decimal(19,4)"
  • binary: 二进制数据类型,将转换为 "blob"

如果抽象类型包含用空格分隔的两个或多个部分(例如 "string NOT NULL"),则只会转换第一个部分,其余部分将追加到转换后的结果。例如,'string NOT NULL' 将转换为 'varchar(255) NOT NULL'。

对于某些抽象类型,您还可以通过将长度或精度约束直接附加到类型的圆括号中来指定该约束。例如,string(32) 将在 MySQL 数据库中转换为 "varchar(32)"。如果底层 DBMS 不支持此类类型约束,则该约束将被忽略。

如果在 $typeMap 中找不到类型,则将直接返回该类型,不作任何更改。

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

抽象列类型

return string

物理列类型。

                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() 公共方法 (自版本 2.0.14 起可用)

获取适用于 $expression 的 yii\db\ExpressionBuilderInterface 对象。

使用 $expressionBuilders 数组查找合适的构建器类。

另请参阅$expressionBuilders

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

当此 QueryBuilder 不支持 $expression 构建时。

                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 boolean hasLimit ( $limit )
$limit mixed

给定的限制

return 布尔值

限制是否有效

                protected function hasLimit($limit)
{
    return ($limit instanceof ExpressionInterface) || ctype_digit((string)$limit);
}

            
hasMethod() 公共方法

定义在: yii\base\BaseObject::hasMethod()

返回一个值,指示方法是否已定义。

默认实现是调用 php 函数 method_exists()。当您实现 php 魔术方法 __call() 时,您可以覆盖此方法。

public boolean hasMethod ( $name )
$name string

方法名称

return 布尔值

方法是否已定义

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

            
hasOffset() 受保护方法

检查给定的偏移量是否有效。

protected boolean hasOffset ( $offset )
$offset mixed

给定的偏移量

return 布尔值

偏移量是否有效

                protected function hasOffset($offset)
{
    return ($offset instanceof ExpressionInterface) || ctype_digit((string)$offset) && (string)$offset !== '0';
}

            
hasProperty() 公共方法

定义在: yii\base\BaseObject::hasProperty()

返回一个值,指示属性是否已定义。

如果属性被定义,则

  • 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为真时);

另请参见

public boolean hasProperty ( $name, $checkVars true )
$name string

属性名称

$checkVars 布尔值

是否将成员变量视为属性

return 布尔值

属性是否已定义

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

            
init() 公共方法

初始化对象。

此方法在对象使用给定配置初始化后,在构造函数结束时调用。

public void init ( )

                public function init()
{
    parent::init();
    $this->expressionBuilders = array_merge($this->defaultExpressionBuilders(), $this->expressionBuilders);
    $this->conditionClasses = array_merge($this->defaultConditionClasses(), $this->conditionClasses);
}

            
insert() 公共方法

创建 INSERT SQL 语句。

例如,`php $sql = $queryBuilder->insert('user', [

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

], $params); ` 该方法将正确地转义表名和列名。

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

将插入新行的表。

$columns array|yii\db\Query

要插入到表中的列数据(名称 => 值)或 Query 实例,以执行 INSERT INTO ... SELECT SQL 语句。从 2.0.11 版开始,可以传递 Query

$params array

此方法将生成的绑定参数。它们应该稍后绑定到 DB 命令。

return string

INSERT SQL

                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() 受保护方法(自版本 2.0.11 起可用)

为 INSERT INTO ... SELECT SQL 语句准备 select-subquery 和字段名称。

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

表示选择查询的对象。

$schema yii\db\Schema

用于引用列名的模式对象。

$params array

要绑定到生成的 SQL 语句的参数。这些参数将包含在结果中,以及在查询构建过程中生成的额外参数。

return array

列名、值和参数数组。

throws yii\base\InvalidArgumentException

如果查询的选择不包含仅命名的参数。

                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() 受保护方法(自版本 2.0.14 起可用)

为 INSERT SQL 语句准备 VALUES 部分。

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

将插入新行的表。

$columns array|yii\db\Query

要插入到表中的列数据(名称 => 值)或 Query 实例,以执行 INSERT INTO ... SELECT SQL 语句。

$params array

此方法将生成的绑定参数。它们应该稍后绑定到 DB 命令。

return array

列名、占位符、值和参数数组。

                protected function prepareInsertValues($table, $columns, $params = [])
{
    $schema = $this->db->getSchema();
    $tableSchema = $schema->getTableSchema($table);
    $columnSchemas = $tableSchema !== null ? $tableSchema->columns : [];
    $names = [];
    $placeholders = [];
    $values = ' DEFAULT VALUES';
    if ($columns instanceof Query) {
        list($names, $values, $params) = $this->prepareInsertSelectSubQuery($columns, $schema, $params);
    } else {
        foreach ($columns as $name => $value) {
            $names[] = $schema->quoteColumnName($name);
            $value = isset($columnSchemas[$name]) ? $columnSchemas[$name]->dbTypecast($value) : $value;
            if ($value instanceof ExpressionInterface) {
                $placeholders[] = $this->buildExpression($value, $params);
            } elseif ($value instanceof \yii\db\Query) {
                list($sql, $params) = $this->build($value, $params);
                $placeholders[] = "($sql)";
            } else {
                $placeholders[] = $this->bindParam($value, $params);
            }
        }
    }
    return [$names, $placeholders, $values, $params];
}

            
prepareUpdateSets() 受保护方法(自版本 2.0.14 起可用)

为 UPDATE SQL 语句准备 SET 部分。

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

要更新的表。

$columns array

要更新的列数据(名称 => 值)。

$params array

将由此方法修改的绑定参数,以便它们可以稍后绑定到数据库命令。

return array

UPDATE SQL 语句的 SET 部分数组(第一个数组元素)和参数(第二个数组元素)。

                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() 受保护方法(自版本 2.0.14 起可用)

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

此参数接收匹配的约束列表。约束将按其列名进行唯一识别。

                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() 公共方法

构建重命名列的 SQL 语句。

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

要重命名其列的表。该名称将被方法正确地引用。

$oldName string

列的旧名称。该名称将被方法正确地引用。

$newName string

列的新名称。该名称将被方法正确地引用。

return string

重命名 DB 列的 SQL 语句。

                public function renameColumn($table, $oldName, $newName)
{
    return 'ALTER TABLE ' . $this->db->quoteTableName($table)
        . ' RENAME COLUMN ' . $this->db->quoteColumnName($oldName)
        . ' TO ' . $this->db->quoteColumnName($newName);
}

            
renameTable() 公共方法

构建重命名数据库表的 SQL 语句。

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

要重命名的表。该名称将被方法正确地引用。

$newName string

新表名。该名称将被方法正确地引用。

return string

重命名 DB 表的 SQL 语句。

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

            
resetSequence() 公共方法

创建 SQL 语句以重置表主键的序列值。

序列将被重置,以便插入的下一行新行的主键将具有指定的值或最大现有值 +1。

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

将重置其主键序列的表的名称

$value array|string|null

插入的下一个新行的主键的值。如果未设置,则下一个新行的主键将具有最大现有值 +1。

return string

重置序列的 SQL 语句

throws yii\base\NotSupportedException

如果底层 DBMS 不支持该语句

                public function resetSequence($table, $value = null)
{
    throw new NotSupportedException($this->db->getDriverName() . ' does not support resetting sequence.');
}

            
selectExists() 公共方法(自版本 2.0.8 起可用)

创建 SELECT EXISTS() SQL 语句。

public string selectExists ( $rawSql )
$rawSql string

以原始形式选择的子查询。

return string

SELECT EXISTS() SQL 语句。

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

            
setConditionClasses() 公共方法 (自版本 2.0.14.2 起可用)

设置 $conditionClasses 属性。

另请参阅 $conditionClasses

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

条件别名到条件类的映射。例如

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

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

            
setExpressionBuilders() 公共方法 (自版本 2.0.14 起可用)

设置 $expressionBuilders 属性。

另请参阅$expressionBuilders

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

应该与 $expressionBuilders 属性中预定义的构建器合并的构建器数组。

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

            
truncateTable() 公共方法

构建截断数据库表的 SQL 语句。

public string truncateTable ( $table )
$table string

要截断的表。该名称将由方法正确引用。

return string

截断 DB 表的 SQL 语句。

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

            
update() 公共方法

创建 UPDATE SQL 语句。

例如,

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

该方法将正确转义表名和列名。

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

要更新的表。

$columns array

要更新的列数据(名称 => 值)。

$condition array|string

将放在 WHERE 部分中的条件。请参考yii\db\Query::where()了解如何指定条件。

$params array

将由此方法修改的绑定参数,以便它们可以稍后绑定到数据库命令。

return string

UPDATE SQL

                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() 公共方法 (自版本 2.0.14 起可用)

创建 SQL 语句,如果数据库表中不存在行(匹配唯一约束),则将行插入数据库表,如果存在,则更新它们。

例如,

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

该方法将正确转义表名和列名。

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

将新行插入/更新到的表。

$insertColumns array|yii\db\Query

要插入到表中的列数据 (名称 => 值),或 yii\db\Query 的实例,用于执行 INSERT INTO ... SELECT SQL 语句。

$updateColumns array|boolean

如果列数据已存在,要更新的列数据 (名称 => 值)。如果传递 true,列数据将更新为与插入列数据匹配。如果传递 false,如果列数据已存在,则不会执行更新。

$params array

此方法将生成的绑定参数。它们应该稍后绑定到 DB 命令。

return string

生成的 SQL。

throws yii\base\NotSupportedException

如果底层 DBMS 不支持。

                public function upsert($table, $insertColumns, $updateColumns, &$params)
{
    throw new NotSupportedException($this->db->getDriverName() . ' does not support upsert statements.');
}