0 追蹤者

類別 yii\db\mysql\QueryBuilder

繼承關係yii\db\mysql\QueryBuilder » yii\db\QueryBuilder » yii\base\BaseObject
實作介面yii\base\Configurable
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/db/mysql/QueryBuilder.php

QueryBuilder 是 MySQL 資料庫的查詢建構器。

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$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\mysql\QueryBuilder

保護屬性

隱藏繼承的屬性

屬性 類型 描述 定義於

公共方法

隱藏繼承的方法

方法 描述 定義於
__call() 調用指定的非類別方法。 yii\base\BaseObject
__construct() 建構子。 yii\db\QueryBuilder
__get() 返回物件屬性的值。 yii\base\BaseObject
__isset() 檢查屬性是否已設定,即已定義且非 null。 yii\base\BaseObject
__set() 設定物件屬性的值。 yii\base\BaseObject
__unset() 將物件屬性設定為 null。 yii\base\BaseObject
addCheck() 建立 SQL 命令以將檢查約束新增到現有表格。 yii\db\mysql\QueryBuilder
addColumn() 建立 SQL 陳述式以新增新的資料庫欄位。 yii\db\QueryBuilder
addCommentOnColumn() 建立 SQL 命令以新增欄位註解。 yii\db\mysql\QueryBuilder
addCommentOnTable() 建立 SQL 命令以新增表格註解。 yii\db\mysql\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\mysql\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\mysql\QueryBuilder
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
createConditionFromArray() 根據 $conditionClasses 對應,將以陣列格式定義的 $condition(如 yii\db\Query::where() 中所述)轉換為 yii\db\condition\ConditionInterface 的實例。 yii\db\QueryBuilder
createIndex() 建立用於建立新索引的 SQL 陳述式。 yii\db\mysql\QueryBuilder
createTable() 建立用於建立新資料庫表格的 SQL 陳述式。 yii\db\QueryBuilder
createView() 建立 SQL 檢視表。 yii\db\QueryBuilder
delete() 建立 DELETE SQL 陳述式。 yii\db\QueryBuilder
dropCheck() 建立用於刪除檢查約束的 SQL 命令。 yii\db\mysql\QueryBuilder
dropColumn() 建立用於刪除資料庫資料行的 SQL 陳述式。 yii\db\QueryBuilder
dropCommentFromColumn() 建立 SQL 命令以新增欄位註解。 yii\db\mysql\QueryBuilder
dropCommentFromTable() 建立 SQL 命令以新增表格註解。 yii\db\mysql\QueryBuilder
dropDefaultValue() 建立用於刪除預設值約束的 SQL 命令。 yii\db\QueryBuilder
dropForeignKey() 建立用於刪除外鍵約束的 SQL 陳述式。 yii\db\mysql\QueryBuilder
dropIndex() 建立用於刪除索引的 SQL 陳述式。 yii\db\QueryBuilder
dropPrimaryKey() 建立用於從現有表格中移除主鍵約束的 SQL 陳述式。 yii\db\mysql\QueryBuilder
dropTable() 建立用於刪除資料庫表格的 SQL 陳述式。 yii\db\QueryBuilder
dropUnique() 建立用於刪除唯一約束的 SQL 命令。 yii\db\mysql\QueryBuilder
dropView() 刪除 SQL 檢視表。 yii\db\QueryBuilder
executeResetSequence() 執行 SQL 陳述式以重設表格主鍵的序號值。 yii\db\QueryBuilder
getColumnType() 將抽象資料行類型轉換為實體資料行類型。 yii\db\QueryBuilder
getExpressionBuilder() 取得 yii\db\ExpressionBuilderInterface 的物件,該物件適用於 $expression。 yii\db\QueryBuilder
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\BaseObject
hasProperty() 傳回一個值,指示是否已定義屬性。 yii\base\BaseObject
init() 初始化物件。 yii\db\mysql\QueryBuilder
insert() 建立 INSERT SQL 陳述式。 yii\db\QueryBuilder
renameColumn() 建立用於重新命名資料行的 SQL 陳述式。 yii\db\mysql\QueryBuilder
renameTable() 建立用於重新命名資料庫表格的 SQL 陳述式。 yii\db\QueryBuilder
resetSequence() 建立用於重設表格主鍵的序號值的 SQL 陳述式。 yii\db\mysql\QueryBuilder
selectExists() 建立 SELECT EXISTS() SQL 陳述式。 yii\db\QueryBuilder
setConditionClasses() 設定 $conditionClasses 屬性的 Setter。 yii\db\QueryBuilder
setExpressionBuilders() 設定 $expressionBuilders 屬性的 Setter。 yii\db\QueryBuilder
truncateTable() 建立用於截斷資料庫表格的 SQL 陳述式。 yii\db\QueryBuilder
update() 建立 UPDATE SQL 陳述式。 yii\db\QueryBuilder
upsert() 建立 SQL 陳述式,用於在資料庫表格中插入資料列(如果它們尚不存在,符合唯一約束),或在它們存在時更新它們。 yii\db\mysql\QueryBuilder

受保護的方法

隱藏繼承的方法

方法 描述 定義於
defaultConditionClasses() 包含預設條件類別的陣列。如果您想要變更查詢建構器的預設條件類別,請擴充此方法。請參閱 $conditionClasses 文件以取得詳細資訊。 yii\db\QueryBuilder
defaultExpressionBuilders() 包含預設運算式建構器的陣列。如果您想要變更此查詢建構器的預設運算式建構器,請擴充並覆寫此方法。請參閱 $expressionBuilders 文件以取得詳細資訊。 yii\db\mysql\QueryBuilder
extractAlias() 如果存在表格別名,則擷取表格別名,否則傳回 false yii\db\QueryBuilder
hasLimit() 檢查給定的限制是否有效。 yii\db\mysql\QueryBuilder
hasOffset() 檢查給定的偏移量是否有效。 yii\db\mysql\QueryBuilder
prepareInsertSelectSubQuery() 為 INSERT INTO ... SELECT SQL 陳述式準備 select-subquery 和欄位名稱。 yii\db\QueryBuilder
prepareInsertValues() INSERT SQL 陳述式準備 VALUES 部分。 yii\db\mysql\QueryBuilder
prepareUpdateSets() UPDATE SQL 陳述式準備 SET 部分。 yii\db\QueryBuilder
prepareUpsertColumns() yii\db\QueryBuilder

常數

隱藏繼承的常數

常數 描述 定義於
PARAM_PREFIX ':qp' 自動產生的查詢繫結參數的前綴。 yii\db\QueryBuilder

屬性詳細資訊

隱藏繼承的屬性

$typeMap 公開屬性

從抽象欄位類型 (鍵) 到物理欄位類型 (值) 的映射。

public array $typeMap = [
    \
yii\db\mysql\Schema::TYPE_PK => 'int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY',
    \
yii\db\mysql\Schema::TYPE_UPK => 'int(10) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY',
    \
yii\db\mysql\Schema::TYPE_BIGPK => 'bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY',
    \
yii\db\mysql\Schema::TYPE_UBIGPK => 'bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY',
    \
yii\db\mysql\Schema::TYPE_CHAR => 'char(1)',
    \
yii\db\mysql\Schema::TYPE_STRING => 'varchar(255)',
    \
yii\db\mysql\Schema::TYPE_TEXT => 'text',
    \
yii\db\mysql\Schema::TYPE_TINYINT => 'tinyint(3)',
    \
yii\db\mysql\Schema::TYPE_SMALLINT => 'smallint(6)',
    \
yii\db\mysql\Schema::TYPE_INTEGER => 'int(11)',
    \
yii\db\mysql\Schema::TYPE_BIGINT => 'bigint(20)',
    \
yii\db\mysql\Schema::TYPE_FLOAT => 'float',
    \
yii\db\mysql\Schema::TYPE_DOUBLE => 'double',
    \
yii\db\mysql\Schema::TYPE_DECIMAL => 'decimal(10,0)',
    \
yii\db\mysql\Schema::TYPE_DATE => 'date',
    \
yii\db\mysql\Schema::TYPE_BINARY => 'blob',
    \
yii\db\mysql\Schema::TYPE_BOOLEAN => 'tinyint(1)',
    \
yii\db\mysql\Schema::TYPE_MONEY => 'decimal(19,4)',
    \
yii\db\mysql\Schema::TYPE_JSON => 'json',
]

方法詳細資訊

隱藏繼承的方法

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

定義於: 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);
}

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

檢查屬性是否已設定,即已定義且非 null。

請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 isset($object->property) 時,將會隱式呼叫此方法。

請注意,如果未定義屬性,則會傳回 false。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱

return boolean

具名屬性是否已設定(非 null)。

                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.dev.org.tw/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 陳述式。

throws yii\base\NotSupportedException

MySQL 不支援此功能。

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

            
addColumn() 公開方法

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

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

建立 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);
}

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

定義於: 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.');
}

            
addForeignKey() 公開方法

定義於: yii\db\QueryBuilder::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() 公開方法

定義於: 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) . ')';
}

            
addUnique() 公開方法 (自版本 2.0.13 起可用)

定義於: 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) . ')';
}

            
alterColumn() public 方法

定義於: 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);
}

            
batchInsert() public 方法

定義於: 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);
}

            
bindParam() public 方法 (自 2.0.14 版本起可用)

定義於: 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;
}

            
build() public 方法

定義於: 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 語句的對應參數(第二個陣列元素)。傳回的參數包含 $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() public 方法
自 2.0.14 版本起已過時。請改用 buildCondition()

定義於: yii\db\QueryBuilder::buildAndCondition()

使用 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() public 方法
自 2.0.14 版本起已過時。請改用 buildCondition()

定義於: yii\db\QueryBuilder::buildBetweenCondition()

使用 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 方法

定義於: yii\db\QueryBuilder::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() public 方法

定義於: 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;
}

            
buildExistsCondition() public 方法
自 2.0.14 版本起已過時。請改用 buildCondition()

定義於: yii\db\QueryBuilder::buildExistsCondition()

使用 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() public 方法 (自 2.0.14 版本起可用)
public string buildExpression ( yii\db\ExpressionInterface $expression, &$params = [] )
$expression yii\db\ExpressionInterface

要建構的表達式

$params array

要綁定到產生的 SQL 語句的參數。這些參數將會與表達式建構過程中產生的其他參數一起包含在結果中。

return string

SQL 語句將不會在傳遞到 DBMS 之前被加上引號或編碼

throws yii\base\InvalidArgumentException

當此 QueryBuilder 不支援 $expression 建構時。

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

            
buildFrom() public 方法
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 方法
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() public 方法
自 2.0.14 版本起已過時。請改用 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);
}

            
buildHaving() public 方法
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() public 方法
自 2.0.14 版本起已過時。請改用 buildCondition()

定義於: yii\db\QueryBuilder::buildInCondition()

使用 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 方法
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() public 方法
自 2.0.14 版本起已過時。請改用 buildCondition()

定義於: yii\db\QueryBuilder::buildLikeCondition()

使用 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 方法

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;
        }
    } elseif ($this->hasOffset($offset)) {
        // limit is not optional in MySQL
        // https://stackoverflow.com/questions/255517/mysql-offset-infinite-rows/271650#271650
        // https://mysqldev.dev.org.tw/doc/refman/5.7/en/select.html#idm46193796386608
        $sql = "LIMIT $offset, 18446744073709551615"; // 2^64-1
    }
    return $sql;
}

            
buildNotCondition() public 方法
自 2.0.14 版本起已過時。請改用 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);
}

            
buildOrderBy() public 方法
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() public 方法

定義於: 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 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 方法
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);
}

            
buildSimpleCondition() public 方法
自 2.0.14 版本起已過時。請改用 buildCondition()

定義於: yii\db\QueryBuilder::buildSimpleCondition()

建立類似 "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 方法
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 方法
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() public 方法 (自 2.0.35 版本起可用)
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() public 方法

定義於: yii\base\BaseObject::canGetProperty()

傳回一個值,指示是否可以讀取屬性。

屬性可讀取的條件為:

  • 類別具有與指定名稱相關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);

另請參閱 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);
}

            
canSetProperty() public 方法

定義於: yii\base\BaseObject::canSetProperty()

傳回一個值,指示是否可以設定屬性。

屬性可寫入的條件為:

  • 類別具有與指定名稱相關聯的 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);

另請參閱 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);
}

            
checkIntegrity() public method

建立用於啟用或停用完整性檢查的 SQL 陳述式。

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

是否開啟或關閉完整性檢查。

$schema string

資料表的 Schema。對 MySQL 而言無意義。

$table string

資料表名稱。對 MySQL 而言無意義。

return string

用於檢查完整性的 SQL 語句

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

            
className() public static method
自 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() public method (自 2.0.14 版本起可用)

定義於: 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);
}

            
createIndex() public method

建立用於建立新索引的 SQL 陳述式。

另請參閱 https://bugs.mysql.com/bug.php?id=48875

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 'ALTER TABLE '
    . $this->db->quoteTableName($table)
    . ($unique ? ' ADD UNIQUE INDEX ' : ' ADD INDEX ')
    . $this->db->quoteTableName($name)
    . ' (' . $this->buildColumns($columns) . ')';
}

            
createTable() public method

定義於: yii\db\QueryBuilder::createTable()

建立用於建立新資料庫表格的 SQL 陳述式。

新資料表中的欄位應指定為名稱-定義配對(例如 '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;
}

            
createView() public method (自 2.0.14 版本起可用)

定義於: yii\db\QueryBuilder::createView()

建立 SQL 檢視表。

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

要建立的檢視表名稱。

$subQuery string|yii\db\Query

定義檢視表的 select 語句。這可以是字串或 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() protected method (自 2.0.14 版本起可用)

定義於: 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',
    ];
}

            
defaultExpressionBuilders() protected method (自 2.0.14 版本起可用)

包含預設運算式建構器的陣列。如果您想要變更此查詢建構器的預設運算式建構器,請擴充並覆寫此方法。請參閱 $expressionBuilders 文件以取得詳細資訊。

protected array defaultExpressionBuilders ( )

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

            
delete() public method

定義於: 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;
}

            
dropCheck() public method (自 2.0.13 版本起可用)

建立用於刪除檢查約束的 SQL 命令。

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

要刪除的檢查約束名稱。名稱將會被此方法正確地引用。

$table string

要刪除其檢查約束的資料表。名稱將會被此方法正確地引用。

return string

用於刪除檢查約束的 SQL 語句。

throws yii\base\NotSupportedException

MySQL 不支援此功能。

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

            
dropColumn() public method

定義於: yii\db\QueryBuilder::dropColumn()

建立用於刪除資料庫資料行的 SQL 陳述式。

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);
}

            
dropCommentFromColumn() public method (自 2.0.8 版本起可用)

建立 SQL 命令以新增欄位註解。

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

要註解其資料行的表格。表格名稱將由此方法正確地加上引號。

$column string

要註解的資料行名稱。資料行名稱將由此方法正確地加上引號。

return string

用於在資料行上新增註解的 SQL 陳述式

                public function dropCommentFromColumn($table, $column)
{
    return $this->addCommentOnColumn($table, $column, '');
}

            
dropCommentFromTable() public method (自 2.0.8 版本起可用)

建立 SQL 命令以新增表格註解。

public string dropCommentFromTable ( $table )
$table string

要註解其資料行的表格。表格名稱將由此方法正確地加上引號。

return string

用於在資料行上新增註解的 SQL 陳述式

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

            
dropDefaultValue() public method (自 2.0.13 版本起可用)

定義於: 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.');
}

            
dropForeignKey() public method

建立用於刪除外鍵約束的 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 FOREIGN KEY ' . $this->db->quoteColumnName($name);
}

            
dropIndex() public method

定義於: yii\db\QueryBuilder::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() public method

建立用於從現有表格中移除主鍵約束的 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 PRIMARY KEY';
}

            
dropTable() public method

定義於: yii\db\QueryBuilder::dropTable()

建立用於刪除資料庫表格的 SQL 陳述式。

public string dropTable ( $table )
$table string

要刪除的資料表。名稱將會被此方法正確地引用。

return string

用於刪除 DB 資料表的 SQL 語句。

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

            
dropUnique() public method (自 2.0.13 版本起可用)

建立用於刪除唯一約束的 SQL 命令。

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

要刪除的唯一約束名稱。名稱將會被此方法正確地引用。

$table string

要刪除其唯一約束的資料表。名稱將會被此方法正確地引用。

return string

用於刪除唯一約束的 SQL 語句。

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

            
dropView() public method (自 2.0.14 版本起可用)

定義於: yii\db\QueryBuilder::dropView()

刪除 SQL 檢視表。

public string dropView ( $viewName )
$viewName string

要刪除的檢視表名稱。

return string

DROP VIEW SQL 語句。

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

            
executeResetSequence() public method (自 2.0.16 版本起可用)

定義於: yii\db\QueryBuilder::executeResetSequence()

執行 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() protected method (自 2.0.24 版本起可用)

定義於: 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;
}

            
getColumnType() public method

定義於: 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;
}

            
getExpressionBuilder() public method (自 2.0.14 版本起可用)

定義於: yii\db\QueryBuilder::getExpressionBuilder()

取得 yii\db\ExpressionBuilderInterface 的物件,該物件適用於 $expression。

使用 $expressionBuilders 陣列來尋找合適的 builder 類別。

另請參閱 $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 method

檢查給定的限制是否有效。

protected boolean hasLimit ( $limit )
$limit mixed

給定的 limit

return boolean

limit 是否有效

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

            
hasMethod() public method

定義於: 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);
}

            
hasOffset() protected method

檢查給定的偏移量是否有效。

protected boolean hasOffset ( $offset )
$offset mixed

給定的 offset

return boolean

offset 是否有效

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

            
hasProperty() public method

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

傳回一個值,指示是否已定義屬性。

屬性在以下情況被定義:

  • 類別具有與指定名稱相關聯的 getter 或 setter 方法 (在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);

另請參閱

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);
}

            
init() public method

初始化物件。

此方法在建構子結束時被調用,在物件以給定配置初始化之後。

public void init ( )

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

            
insert() public method

Defined in: 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);
}

            
prepareInsertSelectSubQuery() protected method (available since version 2.0.11)

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

為 INSERT INTO ... SELECT SQL 陳述式準備 select-subquery 和欄位名稱。

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

代表 select 查詢的物件。

$schema yii\db\Schema

用於引用欄位名稱的 Schema 物件。

$params array

要綁定到產生的 SQL 語句的參數。這些參數將會與查詢建構過程中產生的其他參數一起包含在結果中。

return array

欄位名稱、值和參數的陣列。

throws yii\base\InvalidArgumentException

如果查詢的 select 僅不包含具名參數。

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

            
prepareInsertValues() protected method (available since version 2.0.14)

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

            
prepareUpdateSets() protected method (available since version 2.0.14)

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

UPDATE SQL 陳述式準備 SET 部分。

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

要更新的資料表。

$columns array

要更新的欄位資料 (名稱 => 值)。

$params array

綁定參數,將由此方法修改,以便稍後可以綁定到 DB 命令。

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() protected method (available since version 2.0.14)
protected array prepareUpsertColumns ( $table, $insertColumns, $updateColumns, &$constraints = [] )
$table string
$insertColumns array|yii\db\Query
$updateColumns array|boolean
$constraints yii\db\Constraint[]

此參數接收一個匹配的約束列表。約束將依據其欄位名稱而唯一。

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

            
renameColumn() public method

建立用於重新命名資料行的 SQL 陳述式。

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

要重新命名的欄位所在的資料表。名稱將由該方法正確引用。

$oldName string

欄位的舊名稱。名稱將由該方法正確引用。

$newName string

欄位的新名稱。名稱將由該方法正確引用。

return string

用於重新命名 DB 欄位的 SQL 語句。

throws yii\db\Exception

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

            
renameTable() public method

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

建立用於重新命名資料庫表格的 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() public method

建立用於重設表格主鍵的序號值的 SQL 陳述式。

序列將被重置,使得下一個插入的新列的主鍵將具有指定的值或 1。

public string 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 = $this->db->createCommand("SELECT MAX(`$key`) FROM $tableName")->queryScalar() + 1;
        } else {
            $value = (int) $value;
        }
        return "ALTER TABLE $tableName AUTO_INCREMENT=$value";
    } elseif ($table === null) {
        throw new InvalidArgumentException("Table not found: $tableName");
    }
    throw new InvalidArgumentException("There is no sequence associated with table '$tableName'.");
}

            
selectExists() public method (available since version 2.0.8)

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

建立 SELECT EXISTS() SQL 陳述式。

public string selectExists ( $rawSql )
$rawSql string

要從中選取的原始形式的子查詢。

return string

SELECT EXISTS() SQL 語句。

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

            
setConditionClasses() public method (available since version 2.0.14.2)

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

設定 $conditionClasses 屬性的 Setter。

另請參閱 $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() public method (available since version 2.0.14)

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

設定 $expressionBuilders 屬性的 Setter。

另請參閱 $expressionBuilders

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

應與 $expressionBuilders 屬性中預定義的建構器合併的建構器陣列。

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

            
truncateTable() public method

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

建立用於截斷資料庫表格的 SQL 陳述式。

public string truncateTable ( $table )
$table string

要截斷的資料表。名稱將由該方法正確引用。

return string

用於截斷 DB 資料表的 SQL 語句。

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

            
update() public method

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

綁定參數,將由此方法修改,以便稍後可以綁定到 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;
}

            
upsert() public method (available since version 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);

此方法將正確地跳脫資料表和欄位名稱。

另請參閱 https://downloads.mysql.com/docs/refman-5.1-en.pdf

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