类 yii\db\cubrid\QueryBuilder
继承 | yii\db\cubrid\QueryBuilder » yii\db\QueryBuilder » yii\base\BaseObject |
---|---|
实现 | yii\base\Configurable |
可用版本 | 2.0 |
源代码 | https://github.com/yiisoft/yii2/blob/master/framework/db/cubrid/QueryBuilder.php |
QueryBuilder 是 CUBRID 数据库(版本 9.3.x 及更高版本)的查询构建器。
公共属性
属性 | 类型 | 描述 | 定义于 |
---|---|---|---|
$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\cubrid\QueryBuilder |
公共方法
受保护的方法
方法 | 描述 | 定义于 |
---|---|---|
defaultConditionClasses() | 包含默认条件类数组。如果要更改查询生成器的默认条件类,请扩展此方法。有关详细信息,请参阅 $conditionClasses 文档。 | yii\db\QueryBuilder |
defaultExpressionBuilders() | 包含默认表达式生成器数组。如果要更改此查询生成器的默认表达式生成器,请扩展此方法并覆盖它。有关详细信息,请参阅 $expressionBuilders 文档。 | yii\db\cubrid\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 |
属性详情
从抽象列类型(键)到物理列类型(值)的映射。
\yii\db\cubrid\Schema::TYPE_PK => 'int NOT NULL AUTO_INCREMENT PRIMARY KEY',
\yii\db\cubrid\Schema::TYPE_UPK => 'int UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY',
\yii\db\cubrid\Schema::TYPE_BIGPK => 'bigint NOT NULL AUTO_INCREMENT PRIMARY KEY',
\yii\db\cubrid\Schema::TYPE_UBIGPK => 'bigint UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY',
\yii\db\cubrid\Schema::TYPE_CHAR => 'char(1)',
\yii\db\cubrid\Schema::TYPE_STRING => 'varchar(255)',
\yii\db\cubrid\Schema::TYPE_TEXT => 'varchar',
\yii\db\cubrid\Schema::TYPE_TINYINT => 'smallint',
\yii\db\cubrid\Schema::TYPE_SMALLINT => 'smallint',
\yii\db\cubrid\Schema::TYPE_INTEGER => 'int',
\yii\db\cubrid\Schema::TYPE_BIGINT => 'bigint',
\yii\db\cubrid\Schema::TYPE_FLOAT => 'float(7)',
\yii\db\cubrid\Schema::TYPE_DOUBLE => 'double(15)',
\yii\db\cubrid\Schema::TYPE_DECIMAL => 'decimal(10,0)',
\yii\db\cubrid\Schema::TYPE_DATETIME => 'datetime',
\yii\db\cubrid\Schema::TYPE_TIMESTAMP => 'timestamp',
\yii\db\cubrid\Schema::TYPE_TIME => 'time',
\yii\db\cubrid\Schema::TYPE_DATE => 'date',
\yii\db\cubrid\Schema::TYPE_BINARY => 'blob',
\yii\db\cubrid\Schema::TYPE_BOOLEAN => 'smallint',
\yii\db\cubrid\Schema::TYPE_MONEY => 'decimal(19,4)',
]
方法详情
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()");
}
定义于: yii\db\QueryBuilder::__construct()
构造函数。
public void __construct ( $connection, $config = [] ) | ||
$connection | yii\db\Connection |
数据库连接。 |
$config | array |
用于初始化对象属性的名称-值对 |
public function __construct($connection, $config = [])
{
$this->db = $connection;
parent::__construct($config);
}
定义于: 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);
}
定义于: yii\base\BaseObject::__isset()
检查属性是否已设置,即已定义且不为空。
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 isset($object->property)
时会隐式调用。
注意,如果属性未定义,将返回 false。
public boolean __isset ( $name ) | ||
$name | string |
属性名称或事件名称 |
return | boolean |
命名的属性是否已设置(非空)。 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
定义于: 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);
}
}
定义于: yii\base\BaseObject::__unset()
将对象属性设置为 null。
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 unset($object->property)
时会隐式调用。
注意,如果属性未定义,此方法将不做任何操作。如果属性是只读的,它将抛出一个异常。
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);
}
}
创建一个 SQL 命令,用于向现有表添加检查约束。
public string addCheck ( $name, $table, $expression ) | ||
$name | string |
检查约束的名称。名称将由方法正确引用。 |
$table | string |
将添加检查约束的表。名称将由方法正确引用。 |
$expression | string |
|
return | string |
向现有表添加检查约束的 SQL 语句。 |
---|---|---|
throws | yii\base\NotSupportedException |
CUBRID 不支持此功能。 |
public function addCheck($name, $table, $expression)
{
throw new NotSupportedException(__METHOD__ . ' is not supported by CUBRID.');
}
定义于: yii\db\QueryBuilder::addColumn()
构建一个 SQL 语句,用于添加新的 DB 列。
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);
}
构建一个 SQL 命令,用于向列添加注释。
public string addCommentOnColumn ( $table, $column, $comment ) | ||
$table | string |
要对其列进行注释的表。表名将由方法正确引用。 |
$column | string |
要注释的列的名称。列名将由方法正确引用。 |
$comment | string |
要添加的注释文本。注释将由方法正确引用。 |
return | string |
在列上添加注释的 SQL 语句 |
---|
public function addCommentOnColumn($table, $column, $comment)
{
$definition = $this->getColumnDefinition($table, $column);
$definition = trim(preg_replace("/COMMENT '(.*?)'/i", '', $definition));
return 'ALTER TABLE ' . $this->db->quoteTableName($table)
. ' CHANGE ' . $this->db->quoteColumnName($column)
. ' ' . $this->db->quoteColumnName($column)
. (empty($definition) ? '' : ' ' . $definition)
. ' COMMENT ' . $this->db->quoteValue($comment);
}
构建一个 SQL 命令,用于向表添加注释。
public string addCommentOnTable ( $table, $comment ) | ||
$table | string |
要对其列进行注释的表。表名将由方法正确引用。 |
$comment | string |
要添加的注释文本。注释将由方法正确引用。 |
return | string |
在表上添加注释的 SQL 语句 |
---|
public function addCommentOnTable($table, $comment)
{
return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' COMMENT ' . $this->db->quoteValue($comment);
}
定义于: yii\db\QueryBuilder::addDefaultValue()
创建一个 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.');
}
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;
}
定义于: yii\db\QueryBuilder::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) . ')';
}
定义于: yii\db\QueryBuilder::addUnique()
创建一个 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) . ')';
}
定义于: yii\db\QueryBuilder::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);
}
定义于: yii\db\QueryBuilder::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);
}
定义于: yii\db\QueryBuilder::bindParam()
辅助方法,使用 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;
}
定义于: yii\db\QueryBuilder::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 语句的相应参数(第二个数组元素)。返回的参数包括 |
---|
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];
}
buildCondition()
。
定义于: yii\db\QueryBuilder::buildAndCondition()
使用 AND
或 OR
运算符连接两个或多个 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);
}
buildCondition()
。
定义于: yii\db\QueryBuilder::buildBetweenCondition()
使用 BETWEEN
运算符创建一个 SQL 表达式。
public string buildBetweenCondition ( $operator, $operands, &$params ) | ||
$operator | string |
要使用的操作符(例如 |
$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);
}
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);
}
定义于: yii\db\QueryBuilder::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;
}
buildCondition()
。
定义在: yii\db\QueryBuilder::buildExistsCondition()
使用 EXISTS
运算符创建一个 SQL 表达式。
public string buildExistsCondition ( $operator, $operands, &$params ) | ||
$operator | string |
要使用的操作符(例如 |
$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);
}
public string buildExpression ( yii\db\ExpressionInterface $expression, &$params = [] ) | ||
$expression | yii\db\ExpressionInterface |
要构建的表达式 |
$params | array |
要绑定到生成的 SQL 语句的参数。这些参数将包含在结果中,以及在表达式构建过程中生成的附加参数。 |
return | string |
不会在传递给 DBMS 之前被引用或编码的 SQL 语句 |
---|---|---|
throws | yii\base\InvalidArgumentException |
当 $expression 构建不受此 QueryBuilder 支持时。 |
public function buildExpression(ExpressionInterface $expression, &$params = [])
{
$builder = $this->getExpressionBuilder($expression);
return $builder->build($expression, $params);
}
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);
}
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);
}
buildCondition()
。
定义在: yii\db\QueryBuilder::buildHashCondition()
基于列-值对创建条件。
public string buildHashCondition ( $condition, &$params ) | ||
$condition | array |
条件规范。 |
$params | array |
要填充的绑定参数 |
return | string |
生成的 SQL 表达式 |
---|
public function buildHashCondition($condition, &$params)
{
return $this->buildCondition(new HashCondition($condition), $params);
}
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;
}
buildCondition()
。
定义在: yii\db\QueryBuilder::buildInCondition()
使用 IN
运算符创建一个 SQL 表达式。
public string buildInCondition ( $operator, $operands, &$params ) | ||
$operator | string |
要使用的操作符(例如 |
$operands | array |
第一个操作数是列名。如果它是数组,则将生成复合 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);
}
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);
}
buildCondition()
。
定义在: yii\db\QueryBuilder::buildLikeCondition()
使用 LIKE
运算符创建一个 SQL 表达式。
public string buildLikeCondition ( $operator, $operands, &$params ) | ||
$operator | string |
要使用的操作符(例如 |
$operands | array |
包含两个或三个操作数的数组
|
$params | array |
要填充的绑定参数 |
return | string |
生成的 SQL 表达式 |
---|---|---|
throws | yii\base\InvalidArgumentException |
如果给出的操作数数量错误。 |
public function buildLikeCondition($operator, $operands, &$params)
{
array_unshift($operands, $operator);
return $this->buildCondition($operands, $params);
}
public string buildLimit ( $limit, $offset ) | ||
$limit | 整数 | |
$offset | 整数 | |
return | string |
LIMIT 和 OFFSET 子句 |
---|
public function buildLimit($limit, $offset)
{
$sql = '';
// limit is not optional in CUBRID
// https://www.cubrid.org/manual/en/9.3.0/sql/query/select.html#limit-clause
// "You can specify a very big integer for row_count to display to the last row, starting from a specific row."
if ($this->hasLimit($limit)) {
$sql = 'LIMIT ' . $limit;
if ($this->hasOffset($offset)) {
$sql .= ' OFFSET ' . $offset;
}
} elseif ($this->hasOffset($offset)) {
$sql = "LIMIT 9223372036854775807 OFFSET $offset"; // 2^63-1
}
return $sql;
}
buildCondition()
。
定义在: yii\db\QueryBuilder::buildNotCondition()
使用 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);
}
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);
}
定义于: yii\db\QueryBuilder::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 | 整数 |
限制数量。有关更多详细信息,请参见 yii\db\Query::limit()。 |
$offset | 整数 |
偏移量。有关更多详细信息,请参见 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;
}
public string buildSelect ( $columns, &$params, $distinct = false, $selectOption = null ) | ||
$columns | array | |
$params | array |
要填充的绑定参数 |
$distinct | boolean | |
$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);
}
buildCondition()
。
定义于: yii\db\QueryBuilder::buildSimpleCondition()
创建一个 SQL 表达式,如 "column" operator value
。
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);
}
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);
}
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;
}
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);
}
定义于: yii\base\BaseObject::canGetProperty()
返回一个值,指示是否可以读取属性。
属性可读,如果
- 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称匹配的成员变量(当
$checkVars
为真时);
另请参见 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名 |
$checkVars | boolean |
是否将成员变量视为属性 |
return | boolean |
该属性是否可读 |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
定义于: yii\base\BaseObject::canSetProperty()
返回一个值,指示是否可以设置属性。
属性可写,如果
- 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称匹配的成员变量(当
$checkVars
为真时);
另请参见 canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名 |
$checkVars | boolean |
是否将成员变量视为属性 |
return | boolean |
该属性是否可写 |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
定义于: yii\db\QueryBuilder::checkIntegrity()
构建一个 SQL 语句,用于启用或禁用完整性检查。
public string checkIntegrity ( $check = true, $schema = '', $table = '' ) | ||
$check | boolean |
是否开启或关闭完整性检查。 |
$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.');
}
::class
代替。
定义于: yii\base\BaseObject::className()
返回此类的完全限定名称。
public static string className ( ) | ||
return | string |
此类的完全限定名。 |
---|
public static function className()
{
return get_called_class();
}
定义于: yii\db\QueryBuilder::createConditionFromArray()
根据 $conditionClasses 映射,将 $condition 从数组格式(如 yii\db\Query::where() 中所述)转换为 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);
}
定义于: yii\db\QueryBuilder::createIndex()
构建一个 SQL 语句,用于创建新的索引。
public string createIndex ( $name, $table, $columns, $unique = false ) | ||
$name | string |
索引的名称。该名称将由方法正确地引用。 |
$table | string |
将为其创建新索引的表。表名将由方法正确地引用。 |
$columns | string|array |
应包含在索引中的列。如果有多个列,则用逗号分隔或使用数组表示它们。每个列名将由方法正确引用,除非名称中存在括号。 |
$unique | boolean |
是否在创建的索引上添加 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) . ')';
}
定义于: yii\db\QueryBuilder::createTable()
构建一个 SQL 语句,用于创建新的 DB 表。
新表中的列应指定为名称-定义对(例如 'name' => 'string'),其中 name 代表一个列名,该列名将由方法正确引用,而 definition 代表列类型,必须包含抽象 DB 类型。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 |
新表中的列(name => definition)。 |
$options | string|null |
将附加到生成的 SQL 的其他 SQL 片段。 |
return | string |
创建新的 DB 表的 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;
}
定义于: yii\db\QueryBuilder::createView()
创建一个 SQL 视图。
public string createView ( $viewName, $subQuery ) | ||
$viewName | string |
要创建的视图的名称。 |
$subQuery | string|yii\db\Query |
定义视图的 select 语句。这可以是字符串或 yii\db\Query 对象。 |
return | string |
|
---|
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;
}
定义于: yii\db\QueryBuilder::defaultConditionClasses()
包含默认条件类数组。如果要更改查询生成器的默认条件类,请扩展此方法。有关详细信息,请参阅 $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',
];
}
包含默认表达式生成器数组。如果要更改此查询生成器的默认表达式生成器,请扩展此方法并覆盖它。有关详细信息,请参阅 $expressionBuilders 文档。
protected array defaultExpressionBuilders ( ) |
protected function defaultExpressionBuilders()
{
return array_merge(parent::defaultExpressionBuilders(), [
'yii\db\conditions\LikeCondition' => 'yii\db\cubrid\conditions\LikeConditionBuilder',
]);
}
定义于: yii\db\QueryBuilder::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 |
将被此方法修改的绑定参数,以便它们稍后可以绑定到 DB 命令。 |
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;
}
创建一个 SQL 命令,用于删除检查约束。
public string dropCheck ( $name, $table ) | ||
$name | string |
要删除的检查约束的名称。该名称将由方法正确地引用。 |
$table | string |
要删除其检查约束的表。该名称将由方法正确地引用。 |
return | string |
删除检查约束的 SQL 语句。 |
---|---|---|
throws | yii\base\NotSupportedException |
CUBRID 不支持此功能。 |
public function dropCheck($name, $table)
{
throw new NotSupportedException(__METHOD__ . ' is not supported by CUBRID.');
}
定义于: yii\db\QueryBuilder::dropColumn()
构建一个 SQL 语句,用于删除 DB 列。
public string dropColumn ( $table, $column ) | ||
$table | string |
要删除其列的表。该名称将由方法正确地引用。 |
$column | string |
要删除的列的名称。该名称将由方法正确地引用。 |
return | string |
删除 DB 列的 SQL 语句。 |
---|
public function dropColumn($table, $column)
{
return 'ALTER TABLE ' . $this->db->quoteTableName($table)
. ' DROP COLUMN ' . $this->db->quoteColumnName($column);
}
构建一个 SQL 命令,用于向列添加注释。
public string dropCommentFromColumn ( $table, $column ) | ||
$table | string |
要对其列进行注释的表。表名将由方法正确引用。 |
$column | string |
要注释的列的名称。列名将由方法正确引用。 |
return | string |
在列上添加注释的 SQL 语句 |
---|
public function dropCommentFromColumn($table, $column)
{
return $this->addCommentOnColumn($table, $column, '');
}
构建一个 SQL 命令,用于向表添加注释。
public string dropCommentFromTable ( $table ) | ||
$table | string |
要对其列进行注释的表。表名将由方法正确引用。 |
return | string |
在列上添加注释的 SQL 语句 |
---|
public function dropCommentFromTable($table)
{
return $this->addCommentOnTable($table, '');
}
定义于: yii\db\QueryBuilder::dropDefaultValue()
创建一个 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.');
}
定义于: yii\db\QueryBuilder::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);
}
构建一个 SQL 语句,用于删除索引。
另请参见 https://www.cubrid.org/manual/en/9.3.0/sql/schema/table.html#drop-index-clause.
public string dropIndex ( $name, $table ) | ||
$name | string |
要删除的索引的名称。该名称将由该方法正确引用。 |
$table | string |
要删除其索引的表。该名称将由该方法正确引用。 |
return | string |
用于删除索引的 SQL 语句。 |
---|
public function dropIndex($name, $table)
{
/** @var Schema $schema */
$schema = $this->db->getSchema();
foreach ($schema->getTableUniques($table) as $unique) {
if ($unique->name === $name) {
return $this->dropUnique($name, $table);
}
}
return 'DROP INDEX ' . $this->db->quoteTableName($name) . ' ON ' . $this->db->quoteTableName($table);
}
定义于: yii\db\QueryBuilder::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);
}
定义于: yii\db\QueryBuilder::dropTable()
构建一个 SQL 语句,用于删除 DB 表。
public string dropTable ( $table ) | ||
$table | string |
要删除的表。该名称将由该方法正确引用。 |
return | string |
用于删除数据库表的 SQL 语句。 |
---|
public function dropTable($table)
{
return 'DROP TABLE ' . $this->db->quoteTableName($table);
}
定义于: yii\db\QueryBuilder::dropUnique()
创建一个 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);
}
定义于: yii\db\QueryBuilder::dropView()
删除一个 SQL 视图。
public string dropView ( $viewName ) | ||
$viewName | string |
要删除的视图的名称。 |
return | string |
|
---|
public function dropView($viewName)
{
return 'DROP VIEW ' . $this->db->quoteTableName($viewName);
}
定义于: yii\db\QueryBuilder::executeResetSequence()
执行一个 SQL 语句,用于重置表的 primary key 的序列值。
执行的原因是某些数据库(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();
}
定义于: yii\db\QueryBuilder::extractAlias()
如果存在,则提取表别名,否则返回 false。
protected boolean|array extractAlias ( $table ) | ||
$table |
protected function extractAlias($table)
{
if (preg_match('/^(.*?)(?i:\s+as|)\s+([^ ]+)$/', $table, $matches)) {
return $matches;
}
return false;
}
定义于: yii\db\QueryBuilder::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 类型,将转换为“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;
}
定义于: yii\db\QueryBuilder::getExpressionBuilder()
获取适合 $expression 的 yii\db\ExpressionBuilderInterface 对象。
使用 $expressionBuilders 数组查找合适的构建器类。
另请参见 $expressionBuilders。
public yii\db\ExpressionBuilderInterface getExpressionBuilder ( yii\db\ExpressionInterface $expression ) | ||
$expression | yii\db\ExpressionInterface | |
throws | yii\base\InvalidArgumentException |
当 $expression 构建不受此 QueryBuilder 支持时。 |
---|
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];
}
定义于: yii\db\QueryBuilder::hasLimit()
检查给定的限制是否有效。
protected boolean hasLimit ( $limit ) | ||
$limit | mixed |
给定的限制 |
return | boolean |
限制是否有效 |
---|
protected function hasLimit($limit)
{
return ($limit instanceof ExpressionInterface) || ctype_digit((string)$limit);
}
定义于: yii\base\BaseObject::hasMethod()
返回一个值,指示是否定义了方法。
默认实现是调用 php 函数 method_exists()
。当您实现 php 魔术方法 __call()
时,您可以覆盖此方法。
public boolean hasMethod ( $name ) | ||
$name | string |
方法名 |
return | boolean |
方法是否已定义 |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
定义于: yii\db\QueryBuilder::hasOffset()
检查给定的偏移量是否有效。
protected boolean hasOffset ( $offset ) | ||
$offset | mixed |
给定的偏移量 |
return | boolean |
偏移量是否有效 |
---|
protected function hasOffset($offset)
{
return ($offset instanceof ExpressionInterface) || ctype_digit((string)$offset) && (string)$offset !== '0';
}
定义于: yii\base\BaseObject::hasProperty()
返回一个值,指示是否定义了属性。
属性定义如果
- 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称匹配的成员变量(当
$checkVars
为真时);
另请参阅
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名 |
$checkVars | boolean |
是否将成员变量视为属性 |
return | boolean |
属性是否已定义 |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
public void init ( ) |
public function init()
{
parent::init();
$this->expressionBuilders = array_merge($this->defaultExpressionBuilders(), $this->expressionBuilders);
$this->conditionClasses = array_merge($this->defaultConditionClasses(), $this->conditionClasses);
}
定义于: yii\db\QueryBuilder::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);
}
定义于: yii\db\QueryBuilder::prepareInsertSelectSubQuery()
为 INSERT INTO ... SELECT SQL 语句准备 select-subquery 和字段名。
protected array prepareInsertSelectSubQuery ( $columns, $schema, $params = [] ) | ||
$columns | yii\db\Query |
表示选择查询的对象。 |
$schema | yii\db\Schema |
用于引用列名的 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];
}
定义于: yii\db\QueryBuilder::prepareInsertValues()
为 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];
}
定义于: yii\db\QueryBuilder::prepareUpdateSets()
为 UPDATE SQL 语句准备 SET 部分。
受保护 数组 prepareUpdateSets ( $table, $columns, $params = [] ) | ||
$table | string |
要更新的表。 |
$columns | array |
要更新的列数据(名称 => 值)。 |
$params | array |
将被此方法修改的绑定参数,以便它们稍后可以绑定到 DB 命令。 |
return | array |
用于 |
---|
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 ( $table, $insertColumns, $updateColumns, &$constraints = [] ) | ||
$table | string | |
$insertColumns | array|yii\db\Query | |
$updateColumns | 数组|布尔值 | |
$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)];
}
定义于: yii\db\QueryBuilder::renameColumn()
构建一个 SQL 语句,用于重命名列。
公共 字符串 renameColumn ( $table, $oldName, $newName ) | ||
$table | string |
要重命名其列的表。名称将由方法正确引用。 |
$oldName | string |
列的旧名称。名称将由方法正确引用。 |
$newName | string |
列的新名称。名称将由方法正确引用。 |
return | string |
重命名数据库列的 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);
}
定义于: yii\db\QueryBuilder::renameTable()
构建一个 SQL 语句,用于重命名 DB 表。
公共 字符串 renameTable ( $oldName, $newName ) | ||
$oldName | string |
要重命名的表。名称将由方法正确引用。 |
$newName | string |
新的表名称。名称将由方法正确引用。 |
return | string |
重命名数据库表的 SQL 语句。 |
---|
public function renameTable($oldName, $newName)
{
return 'RENAME TABLE ' . $this->db->quoteTableName($oldName) . ' TO ' . $this->db->quoteTableName($newName);
}
创建一个 SQL 语句,用于重置表的 primary key 的序列值。
序列将被重置,以便插入的下一行的新主键将具有指定的值或 1。
公共 字符串 resetSequence ( $tableName, $value = null ) | ||
$tableName | string |
将重置其主键序列的表的名称 |
$value | mixed |
插入的下一行的新主键的值。如果未设置,下一行的新主键将具有值 1。 |
return | string |
重置序列的 SQL 语句 |
---|---|---|
throws | yii\base\InvalidArgumentException |
如果表不存在或与表关联的序列不存在。 |
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 = (int) $this->db->createCommand("SELECT MAX(`$key`) FROM " . $this->db->schema->quoteTableName($tableName))->queryScalar() + 1;
} else {
$value = (int) $value;
}
return 'ALTER TABLE ' . $this->db->schema->quoteTableName($tableName) . " AUTO_INCREMENT=$value;";
} elseif ($table === null) {
throw new InvalidArgumentException("Table not found: $tableName");
}
throw new InvalidArgumentException("There is not sequence associated with table '$tableName'.");
}
创建一个 SELECT EXISTS() SQL 语句。
公共 字符串 selectExists ( $rawSql ) | ||
$rawSql | string |
要从中选择的原始形式的子查询。 |
return | string |
SELECT EXISTS() SQL 语句。 |
---|
public function selectExists($rawSql)
{
return 'SELECT CASE WHEN EXISTS(' . $rawSql . ') THEN 1 ELSE 0 END';
}
公共 void setConditionClasses ( $classes ) | ||
$classes | string[] |
条件别名到条件类的映射。例如
|
public function setConditionClasses($classes)
{
$this->conditionClasses = array_merge($this->conditionClasses, $classes);
}
定义于: yii\db\QueryBuilder::setExpressionBuilders()
为 $expressionBuilders 属性设置值。
另请参见 $expressionBuilders。
公共 void setExpressionBuilders ( $builders ) | ||
$builders | string[] |
应该与 $expressionBuilders 属性中预定义的构建器合并的构建器数组。 |
public function setExpressionBuilders($builders)
{
$this->expressionBuilders = array_merge($this->expressionBuilders, $builders);
}
定义于: yii\db\QueryBuilder::truncateTable()
构建一个 SQL 语句,用于截断 DB 表。
公共 字符串 truncateTable ( $table ) | ||
$table | string |
要截断的表。名称将由方法正确引用。 |
return | string |
截断数据库表的 SQL 语句。 |
---|
public function truncateTable($table)
{
return 'TRUNCATE TABLE ' . $this->db->quoteTableName($table);
}
定义于: yii\db\QueryBuilder::update()
创建一个 UPDATE SQL 语句。
例如,
$params = [];
$sql = $queryBuilder->update('user', ['status' => 1], 'age > 30', $params);
该方法将正确地转义表名和列名。
公共 字符串 update ( $table, $columns, $condition, &$params ) | ||
$table | string |
要更新的表。 |
$columns | array |
要更新的列数据(名称 => 值)。 |
$condition | array|string |
将放在 WHERE 部分中的条件。请参阅 yii\db\Query::where() 以了解如何指定条件。 |
$params | array |
将被此方法修改的绑定参数,以便它们稍后可以绑定到 DB 命令。 |
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;
}
创建一个 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);
该方法将正确地转义表名和列名。
另请参见 https://www.cubrid.org/manual/en/9.3.0/sql/query/merge.html。
公共 字符串 upsert ( $table, $insertColumns, $updateColumns, &$params ) | ||
$table | string |
将新行插入/更新到的表。 |
$insertColumns | array|yii\db\Query |
要插入到表中的列数据(名称 => 值)或 yii\db\Query 的实例,以执行 |
$updateColumns | 数组|布尔值 |
如果列数据已存在,则要更新的列数据(名称 => 值)。如果传递 |
$params | array |
将由此方法生成的绑定参数。稍后应将它们绑定到 DB 命令。 |
return | string |
生成的 SQL。 |
---|---|---|
throws | yii\base\NotSupportedException |
如果底层 DBMS 不支持此功能。 |
public function upsert($table, $insertColumns, $updateColumns, &$params)
{
/** @var Constraint[] $constraints */
list($uniqueNames, $insertNames, $updateNames) = $this->prepareUpsertColumns($table, $insertColumns, $updateColumns, $constraints);
if (empty($uniqueNames)) {
return $this->insert($table, $insertColumns, $params);
}
if ($updateNames === []) {
// there are no columns to update
$updateColumns = false;
}
$onCondition = ['or'];
$quotedTableName = $this->db->quoteTableName($table);
foreach ($constraints as $constraint) {
$constraintCondition = ['and'];
foreach ($constraint->columnNames as $name) {
$quotedName = $this->db->quoteColumnName($name);
$constraintCondition[] = "$quotedTableName.$quotedName=\"EXCLUDED\".$quotedName";
}
$onCondition[] = $constraintCondition;
}
$on = $this->buildCondition($onCondition, $params);
list(, $placeholders, $values, $params) = $this->prepareInsertValues($table, $insertColumns, $params);
$mergeSql = 'MERGE INTO ' . $this->db->quoteTableName($table) . ' '
. 'USING (' . (!empty($placeholders) ? 'VALUES (' . implode(', ', $placeholders) . ')' : ltrim($values, ' ')) . ') AS "EXCLUDED" (' . implode(', ', $insertNames) . ') '
. "ON ($on)";
$insertValues = [];
foreach ($insertNames as $name) {
$quotedName = $this->db->quoteColumnName($name);
if (strrpos($quotedName, '.') === false) {
$quotedName = '"EXCLUDED".' . $quotedName;
}
$insertValues[] = $quotedName;
}
$insertSql = 'INSERT (' . implode(', ', $insertNames) . ')'
. ' VALUES (' . implode(', ', $insertValues) . ')';
if ($updateColumns === false) {
return "$mergeSql WHEN NOT MATCHED THEN $insertSql";
}
if ($updateColumns === true) {
$updateColumns = [];
foreach ($updateNames as $name) {
$quotedName = $this->db->quoteColumnName($name);
if (strrpos($quotedName, '.') === false) {
$quotedName = '"EXCLUDED".' . $quotedName;
}
$updateColumns[$name] = new Expression($quotedName);
}
}
list($updates, $params) = $this->prepareUpdateSets($table, $updateColumns, $params);
$updateSql = 'UPDATE SET ' . implode(', ', $updates);
return "$mergeSql WHEN MATCHED THEN $updateSql WHEN NOT MATCHED THEN $insertSql";
}
注册 或 登录 以发表评论。