<?php /** * @link http://www.yiiframework.com/ * @copyright Copyright (c) 2008 Yii Software LLC * @license http://www.yiiframework.com/license/ */ namespace yii\db\sqlite; use yii\db\Exception; use yii\base\InvalidParamException; use yii\base\NotSupportedException; /** * 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_BIGPK => 'integer PRIMARY KEY AUTOINCREMENT NOT NULL', Schema::TYPE_STRING => 'varchar(255)', Schema::TYPE_TEXT => 'text', Schema::TYPE_SMALLINT => 'smallint', Schema::TYPE_INTEGER => 'integer', Schema::TYPE_BIGINT => 'bigint', Schema::TYPE_FLOAT => 'float', 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)', ]; /** * Generates a batch INSERT SQL statement. * For example, * * ~~~ * $connection->createCommand()->batchInsert('tbl_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 $rows the rows to be batch inserted into the table * @return string the batch INSERT SQL statement */ public function batchInsert($table, $columns, $rows) { if (($tableSchema = $this->db->getTableSchema($table)) !== null) { $columnSchemas = $tableSchema->columns; } else { $columnSchemas = []; } foreach ($columns as $i => $name) { $columns[$i] = $this->db->quoteColumnName($name); } $values = []; foreach ($rows as $row) { $vs = []; foreach ($row as $i => $value) { if (!is_array($value) && isset($columnSchemas[$columns[$i]])) { $value = $columnSchemas[$columns[$i]]->typecast($value); } $vs[] = is_string($value) ? $this->db->quoteValue($value) : $value; } $values[] = implode(', ', $vs); } return 'INSERT INTO ' . $this->db->quoteTableName($table) . ' (' . implode(', ', $columns) . ') SELECT ' . implode(' UNION ALL ', $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 InvalidParamException 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) { if ($value === null) { $key = reset($table->primaryKey); $tableName = $db->quoteTableName($tableName); $value = $db->createCommand("SELECT MAX('$key') FROM $tableName")->queryScalar(); } else { $value = (int)$value - 1; } try { // it's possible sqlite_sequence does not exist $db->createCommand("UPDATE sqlite_sequence SET seq='$value' WHERE name='{$table->name}'")->execute(); } catch (Exception $e) { } } elseif ($table === null) { throw new InvalidParamException("Table not found: $tableName"); } else { throw new InvalidParamException("There is not sequence associated with table '$tableName'.'"); } } /** * Enables or disables integrity check. * @param boolean $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 = '') { throw new NotSupportedException(__METHOD__ . ' is not supported by SQLite.'); } /** * 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 $delete the ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL * @param string $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 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} */ public function buildLimit($limit, $offset) { $sql = ''; // limit is not optional in SQLite // http://www.sqlite.org/syntaxdiagrams.html#select-stmt if ($limit !== null && $limit >= 0) { $sql = 'LIMIT ' . (int)$limit; if ($offset > 0) { $sql .= ' OFFSET ' . (int)$offset; } } elseif ($offset > 0) { $sql = 'LIMIT 9223372036854775807 OFFSET ' . (int)$offset; // 2^63-1 } return $sql; } }