mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-01 03:26:36 +08:00
572 lines
22 KiB
PHP
572 lines
22 KiB
PHP
<?php
|
|
/**
|
|
* @link https://www.yiiframework.com/
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
* @license https://www.yiiframework.com/license/
|
|
*/
|
|
|
|
namespace yii\db\sqlite;
|
|
|
|
use yii\base\InvalidArgumentException;
|
|
use yii\base\NotSupportedException;
|
|
use yii\db\Connection;
|
|
use yii\db\Constraint;
|
|
use yii\db\Expression;
|
|
use yii\db\ExpressionInterface;
|
|
use yii\db\Query;
|
|
use yii\helpers\StringHelper;
|
|
|
|
/**
|
|
* QueryBuilder is the query builder for SQLite databases.
|
|
*
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
* @since 2.0
|
|
*/
|
|
class QueryBuilder extends \yii\db\QueryBuilder
|
|
{
|
|
/**
|
|
* @var array mapping from abstract column types (keys) to physical column types (values).
|
|
*/
|
|
public $typeMap = [
|
|
Schema::TYPE_PK => 'integer PRIMARY KEY AUTOINCREMENT NOT NULL',
|
|
Schema::TYPE_UPK => 'integer PRIMARY KEY AUTOINCREMENT NOT NULL',
|
|
Schema::TYPE_BIGPK => 'integer PRIMARY KEY AUTOINCREMENT NOT NULL',
|
|
Schema::TYPE_UBIGPK => 'integer PRIMARY KEY AUTOINCREMENT NOT NULL',
|
|
Schema::TYPE_CHAR => 'char(1)',
|
|
Schema::TYPE_STRING => 'varchar(255)',
|
|
Schema::TYPE_TEXT => 'text',
|
|
Schema::TYPE_TINYINT => 'tinyint',
|
|
Schema::TYPE_SMALLINT => 'smallint',
|
|
Schema::TYPE_INTEGER => 'integer',
|
|
Schema::TYPE_BIGINT => 'bigint',
|
|
Schema::TYPE_FLOAT => 'float',
|
|
Schema::TYPE_DOUBLE => 'double',
|
|
Schema::TYPE_DECIMAL => 'decimal(10,0)',
|
|
Schema::TYPE_DATETIME => 'datetime',
|
|
Schema::TYPE_TIMESTAMP => 'timestamp',
|
|
Schema::TYPE_TIME => 'time',
|
|
Schema::TYPE_DATE => 'date',
|
|
Schema::TYPE_BINARY => 'blob',
|
|
Schema::TYPE_BOOLEAN => 'boolean',
|
|
Schema::TYPE_MONEY => 'decimal(19,4)',
|
|
];
|
|
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function defaultExpressionBuilders()
|
|
{
|
|
return array_merge(parent::defaultExpressionBuilders(), [
|
|
'yii\db\conditions\LikeCondition' => 'yii\db\sqlite\conditions\LikeConditionBuilder',
|
|
'yii\db\conditions\InCondition' => 'yii\db\sqlite\conditions\InConditionBuilder',
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @see https://stackoverflow.com/questions/15277373/sqlite-upsert-update-or-insert/15277374#15277374
|
|
*/
|
|
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;
|
|
}
|
|
|
|
list(, $placeholders, $values, $params) = $this->prepareInsertValues($table, $insertColumns, $params);
|
|
$insertSql = 'INSERT OR IGNORE INTO ' . $this->db->quoteTableName($table)
|
|
. (!empty($insertNames) ? ' (' . implode(', ', $insertNames) . ')' : '')
|
|
. (!empty($placeholders) ? ' VALUES (' . implode(', ', $placeholders) . ')' : $values);
|
|
if ($updateColumns === false) {
|
|
return $insertSql;
|
|
}
|
|
|
|
$updateCondition = ['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=(SELECT $quotedName FROM `EXCLUDED`)";
|
|
}
|
|
$updateCondition[] = $constraintCondition;
|
|
}
|
|
if ($updateColumns === true) {
|
|
$updateColumns = [];
|
|
foreach ($updateNames as $name) {
|
|
$quotedName = $this->db->quoteColumnName($name);
|
|
if (strrpos($quotedName, '.') === false) {
|
|
$quotedName = "(SELECT $quotedName FROM `EXCLUDED`)";
|
|
}
|
|
$updateColumns[$name] = new Expression($quotedName);
|
|
}
|
|
}
|
|
$updateSql = 'WITH "EXCLUDED" (' . implode(', ', $insertNames)
|
|
. ') AS (' . (!empty($placeholders) ? 'VALUES (' . implode(', ', $placeholders) . ')' : ltrim($values, ' ')) . ') '
|
|
. $this->update($table, $updateColumns, $updateCondition, $params);
|
|
return "$updateSql; $insertSql;";
|
|
}
|
|
|
|
/**
|
|
* Generates a batch INSERT SQL statement.
|
|
*
|
|
* For example,
|
|
*
|
|
* ```php
|
|
* $connection->createCommand()->batchInsert('user', ['name', 'age'], [
|
|
* ['Tom', 30],
|
|
* ['Jane', 20],
|
|
* ['Linda', 25],
|
|
* ])->execute();
|
|
* ```
|
|
*
|
|
* Note that the values in each row must match the corresponding column names.
|
|
*
|
|
* @param string $table the table that new rows will be inserted into.
|
|
* @param array $columns the column names
|
|
* @param array|\Generator $rows the rows to be batch inserted into the table
|
|
* @return string the batch INSERT SQL statement
|
|
*/
|
|
public function batchInsert($table, $columns, $rows, &$params = [])
|
|
{
|
|
if (empty($rows)) {
|
|
return '';
|
|
}
|
|
|
|
// SQLite supports batch insert natively since 3.7.11
|
|
// https://www.sqlite.org/releaselog/3_7_11.html
|
|
$this->db->open(); // ensure pdo is not null
|
|
if (version_compare($this->db->getServerVersion(), '3.7.11', '>=')) {
|
|
return parent::batchInsert($table, $columns, $rows, $params);
|
|
}
|
|
|
|
$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($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) . ') SELECT ' . implode(' UNION SELECT ', $values);
|
|
}
|
|
|
|
/**
|
|
* Creates a SQL statement for resetting the sequence value of a table's primary key.
|
|
* The sequence will be reset such that the primary key of the next new row inserted
|
|
* will have the specified value or 1.
|
|
* @param string $tableName the name of the table whose primary key sequence will be reset
|
|
* @param mixed $value the value for the primary key of the next new row inserted. If this is not set,
|
|
* the next new row's primary key will have a value 1.
|
|
* @return string the SQL statement for resetting sequence
|
|
* @throws InvalidArgumentException if the table does not exist or there is no sequence associated with the table.
|
|
*/
|
|
public function resetSequence($tableName, $value = null)
|
|
{
|
|
$db = $this->db;
|
|
$table = $db->getTableSchema($tableName);
|
|
if ($table !== null && $table->sequenceName !== null) {
|
|
$tableName = $db->quoteTableName($tableName);
|
|
if ($value === null) {
|
|
$key = $this->db->quoteColumnName(reset($table->primaryKey));
|
|
$value = $this->db->useMaster(function (Connection $db) use ($key, $tableName) {
|
|
return $db->createCommand("SELECT MAX($key) FROM $tableName")->queryScalar();
|
|
});
|
|
} else {
|
|
$value = (int) $value - 1;
|
|
}
|
|
|
|
return "UPDATE sqlite_sequence SET seq='$value' WHERE name='{$table->name}'";
|
|
} elseif ($table === null) {
|
|
throw new InvalidArgumentException("Table not found: $tableName");
|
|
}
|
|
|
|
throw new InvalidArgumentException("There is not sequence associated with table '$tableName'.'");
|
|
}
|
|
|
|
/**
|
|
* Enables or disables integrity check.
|
|
* @param bool $check whether to turn on or off the integrity check.
|
|
* @param string $schema the schema of the tables. Meaningless for SQLite.
|
|
* @param string $table the table name. Meaningless for SQLite.
|
|
* @return string the SQL statement for checking integrity
|
|
* @throws NotSupportedException this is not supported by SQLite
|
|
*/
|
|
public function checkIntegrity($check = true, $schema = '', $table = '')
|
|
{
|
|
return 'PRAGMA foreign_keys=' . (int) $check;
|
|
}
|
|
|
|
/**
|
|
* Builds a SQL statement for truncating a DB table.
|
|
* @param string $table the table to be truncated. The name will be properly quoted by the method.
|
|
* @return string the SQL statement for truncating a DB table.
|
|
*/
|
|
public function truncateTable($table)
|
|
{
|
|
return 'DELETE FROM ' . $this->db->quoteTableName($table);
|
|
}
|
|
|
|
/**
|
|
* Builds a SQL statement for dropping an index.
|
|
* @param string $name the name of the index to be dropped. The name will be properly quoted by the method.
|
|
* @param string $table the table whose index is to be dropped. The name will be properly quoted by the method.
|
|
* @return string the SQL statement for dropping an index.
|
|
*/
|
|
public function dropIndex($name, $table)
|
|
{
|
|
return 'DROP INDEX ' . $this->db->quoteTableName($name);
|
|
}
|
|
|
|
/**
|
|
* Builds a SQL statement for dropping a DB column.
|
|
* @param string $table the table whose column is to be dropped. The name will be properly quoted by the method.
|
|
* @param string $column the name of the column to be dropped. The name will be properly quoted by the method.
|
|
* @return string the SQL statement for dropping a DB column.
|
|
* @throws NotSupportedException this is not supported by SQLite
|
|
*/
|
|
public function dropColumn($table, $column)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* Builds a SQL statement for renaming a column.
|
|
* @param string $table the table whose column is to be renamed. The name will be properly quoted by the method.
|
|
* @param string $oldName the old name of the column. The name will be properly quoted by the method.
|
|
* @param string $newName the new name of the column. The name will be properly quoted by the method.
|
|
* @return string the SQL statement for renaming a DB column.
|
|
* @throws NotSupportedException this is not supported by SQLite
|
|
*/
|
|
public function renameColumn($table, $oldName, $newName)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* Builds a SQL statement for adding a foreign key constraint to an existing table.
|
|
* The method will properly quote the table and column names.
|
|
* @param string $name the name of the foreign key constraint.
|
|
* @param string $table the table that the foreign key constraint will be added to.
|
|
* @param string|array $columns the name of the column to that the constraint will be added on.
|
|
* If there are multiple columns, separate them with commas or use an array to represent them.
|
|
* @param string $refTable the table that the foreign key references to.
|
|
* @param string|array $refColumns the name of the column that the foreign key references to.
|
|
* If there are multiple columns, separate them with commas or use an array to represent them.
|
|
* @param string|null $delete the ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
|
|
* @param string|null $update the ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
|
|
* @return string the SQL statement for adding a foreign key constraint to an existing table.
|
|
* @throws NotSupportedException this is not supported by SQLite
|
|
*/
|
|
public function addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* Builds a SQL statement for dropping a foreign key constraint.
|
|
* @param string $name the name of the foreign key constraint to be dropped. The name will be properly quoted by the method.
|
|
* @param string $table the table whose foreign is to be dropped. The name will be properly quoted by the method.
|
|
* @return string the SQL statement for dropping a foreign key constraint.
|
|
* @throws NotSupportedException this is not supported by SQLite
|
|
*/
|
|
public function dropForeignKey($name, $table)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* Builds a SQL statement for renaming a DB table.
|
|
*
|
|
* @param string $table the table to be renamed. The name will be properly quoted by the method.
|
|
* @param string $newName the new table name. The name will be properly quoted by the method.
|
|
* @return string the SQL statement for renaming a DB table.
|
|
*/
|
|
public function renameTable($table, $newName)
|
|
{
|
|
return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' RENAME TO ' . $this->db->quoteTableName($newName);
|
|
}
|
|
|
|
/**
|
|
* Builds a SQL statement for changing the definition of a column.
|
|
* @param string $table the table whose column is to be changed. The table name will be properly quoted by the method.
|
|
* @param string $column the name of the column to be changed. The name will be properly quoted by the method.
|
|
* @param string $type the new column type. The [[getColumnType()]] method will be invoked to convert abstract
|
|
* column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept
|
|
* in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null'
|
|
* will become 'varchar(255) not null'.
|
|
* @return string the SQL statement for changing the definition of a column.
|
|
* @throws NotSupportedException this is not supported by SQLite
|
|
*/
|
|
public function alterColumn($table, $column, $type)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* Builds a SQL statement for adding a primary key constraint to an existing table.
|
|
* @param string $name the name of the primary key constraint.
|
|
* @param string $table the table that the primary key constraint will be added to.
|
|
* @param string|array $columns comma separated string or array of columns that the primary key will consist of.
|
|
* @return string the SQL statement for adding a primary key constraint to an existing table.
|
|
* @throws NotSupportedException this is not supported by SQLite
|
|
*/
|
|
public function addPrimaryKey($name, $table, $columns)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* Builds a SQL statement for removing a primary key constraint to an existing table.
|
|
* @param string $name the name of the primary key constraint to be removed.
|
|
* @param string $table the table that the primary key constraint will be removed from.
|
|
* @return string the SQL statement for removing a primary key constraint from an existing table.
|
|
* @throws NotSupportedException this is not supported by SQLite
|
|
*/
|
|
public function dropPrimaryKey($name, $table)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @throws NotSupportedException this is not supported by SQLite.
|
|
*/
|
|
public function addUnique($name, $table, $columns)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @throws NotSupportedException this is not supported by SQLite.
|
|
*/
|
|
public function dropUnique($name, $table)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @throws NotSupportedException this is not supported by SQLite.
|
|
*/
|
|
public function addCheck($name, $table, $expression)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @throws NotSupportedException this is not supported by SQLite.
|
|
*/
|
|
public function dropCheck($name, $table)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @throws NotSupportedException this is not supported by SQLite.
|
|
*/
|
|
public function addDefaultValue($name, $table, $column, $value)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @throws NotSupportedException this is not supported by SQLite.
|
|
*/
|
|
public function dropDefaultValue($name, $table)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @throws NotSupportedException
|
|
* @since 2.0.8
|
|
*/
|
|
public function addCommentOnColumn($table, $column, $comment)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @throws NotSupportedException
|
|
* @since 2.0.8
|
|
*/
|
|
public function addCommentOnTable($table, $comment)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @throws NotSupportedException
|
|
* @since 2.0.8
|
|
*/
|
|
public function dropCommentFromColumn($table, $column)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @throws NotSupportedException
|
|
* @since 2.0.8
|
|
*/
|
|
public function dropCommentFromTable($table)
|
|
{
|
|
throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
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 SQLite
|
|
// https://www.sqlite.org/syntaxdiagrams.html#select-stmt
|
|
$sql = "LIMIT 9223372036854775807 OFFSET $offset"; // 2^63-1
|
|
}
|
|
|
|
return $sql;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
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];
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
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);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function createIndex($name, $table, $columns, $unique = false)
|
|
{
|
|
$tableParts = explode('.', $table);
|
|
|
|
$schema = null;
|
|
if (count($tableParts) === 2) {
|
|
list ($schema, $table) = $tableParts;
|
|
}
|
|
|
|
return ($unique ? 'CREATE UNIQUE INDEX ' : 'CREATE INDEX ')
|
|
. $this->db->quoteTableName(($schema ? $schema . '.' : '') . $name) . ' ON '
|
|
. $this->db->quoteTableName($table)
|
|
. ' (' . $this->buildColumns($columns) . ')';
|
|
}
|
|
}
|