View source
<?php
namespace Drupal\Core\Database\Driver\sqlite;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Database\SchemaObjectExistsException;
use Drupal\Core\Database\SchemaObjectDoesNotExistException;
use Drupal\Core\Database\Schema as DatabaseSchema;
class Schema extends DatabaseSchema {
protected $defaultSchema = 'main';
public function tableExists($table) {
$info = $this
->getPrefixInfo($table);
return (bool) $this->connection
->query('SELECT 1 FROM ' . $info['schema'] . '.sqlite_master WHERE type = :type AND name = :name', array(
':type' => 'table',
':name' => $info['table'],
))
->fetchField();
}
public function fieldExists($table, $column) {
$schema = $this
->introspectSchema($table);
return !empty($schema['fields'][$column]);
}
public function createTableSql($name, $table) {
$sql = array();
$sql[] = "CREATE TABLE {" . $name . "} (\n" . $this
->createColumnsSql($name, $table) . "\n)\n";
return array_merge($sql, $this
->createIndexSql($name, $table));
}
protected function createIndexSql($tablename, $schema) {
$sql = array();
$info = $this
->getPrefixInfo($tablename);
if (!empty($schema['unique keys'])) {
foreach ($schema['unique keys'] as $key => $fields) {
$sql[] = 'CREATE UNIQUE INDEX ' . $info['schema'] . '.' . $info['table'] . '_' . $key . ' ON ' . $info['table'] . ' (' . $this
->createKeySql($fields) . ")\n";
}
}
if (!empty($schema['indexes'])) {
foreach ($schema['indexes'] as $key => $fields) {
$sql[] = 'CREATE INDEX ' . $info['schema'] . '.' . $info['table'] . '_' . $key . ' ON ' . $info['table'] . ' (' . $this
->createKeySql($fields) . ")\n";
}
}
return $sql;
}
protected function createColumnsSql($tablename, $schema) {
$sql_array = array();
foreach ($schema['fields'] as $name => $field) {
if (isset($field['type']) && $field['type'] == 'serial') {
if (isset($schema['primary key']) && ($key = array_search($name, $schema['primary key'])) !== FALSE) {
unset($schema['primary key'][$key]);
}
}
$sql_array[] = $this
->createFieldSql($name, $this
->processField($field));
}
if (!empty($schema['primary key'])) {
$sql_array[] = " PRIMARY KEY (" . $this
->createKeySql($schema['primary key']) . ")";
}
return implode(", \n", $sql_array);
}
protected function createKeySql($fields) {
$return = array();
foreach ($fields as $field) {
if (is_array($field)) {
$return[] = $field[0];
}
else {
$return[] = $field;
}
}
return implode(', ', $return);
}
protected function processField($field) {
if (!isset($field['size'])) {
$field['size'] = 'normal';
}
if (isset($field['sqlite_type'])) {
$field['sqlite_type'] = Unicode::strtoupper($field['sqlite_type']);
}
else {
$map = $this
->getFieldTypeMap();
$field['sqlite_type'] = $map[$field['type'] . ':' . $field['size']];
if ($field['sqlite_type'] === 'NUMERIC' && isset($field['scale'])) {
$field['sqlite_type'] = 'FLOAT';
}
}
if (isset($field['type']) && $field['type'] == 'serial') {
$field['auto_increment'] = TRUE;
}
return $field;
}
protected function createFieldSql($name, $spec) {
if (!empty($spec['auto_increment'])) {
$sql = $name . " INTEGER PRIMARY KEY AUTOINCREMENT";
if (!empty($spec['unsigned'])) {
$sql .= ' CHECK (' . $name . '>= 0)';
}
}
else {
$sql = $name . ' ' . $spec['sqlite_type'];
if (in_array($spec['sqlite_type'], array(
'VARCHAR',
'TEXT',
))) {
if (isset($spec['length'])) {
$sql .= '(' . $spec['length'] . ')';
}
if (isset($spec['binary']) && $spec['binary'] === FALSE) {
$sql .= ' COLLATE NOCASE_UTF8';
}
}
if (isset($spec['not null'])) {
if ($spec['not null']) {
$sql .= ' NOT NULL';
}
else {
$sql .= ' NULL';
}
}
if (!empty($spec['unsigned'])) {
$sql .= ' CHECK (' . $name . '>= 0)';
}
if (isset($spec['default'])) {
if (is_string($spec['default'])) {
$spec['default'] = $this->connection
->quote($spec['default']);
}
$sql .= ' DEFAULT ' . $spec['default'];
}
if (empty($spec['not null']) && !isset($spec['default'])) {
$sql .= ' DEFAULT NULL';
}
}
return $sql;
}
public function getFieldTypeMap() {
static $map = array(
'varchar_ascii:normal' => 'VARCHAR',
'varchar:normal' => 'VARCHAR',
'char:normal' => 'CHAR',
'text:tiny' => 'TEXT',
'text:small' => 'TEXT',
'text:medium' => 'TEXT',
'text:big' => 'TEXT',
'text:normal' => 'TEXT',
'serial:tiny' => 'INTEGER',
'serial:small' => 'INTEGER',
'serial:medium' => 'INTEGER',
'serial:big' => 'INTEGER',
'serial:normal' => 'INTEGER',
'int:tiny' => 'INTEGER',
'int:small' => 'INTEGER',
'int:medium' => 'INTEGER',
'int:big' => 'INTEGER',
'int:normal' => 'INTEGER',
'float:tiny' => 'FLOAT',
'float:small' => 'FLOAT',
'float:medium' => 'FLOAT',
'float:big' => 'FLOAT',
'float:normal' => 'FLOAT',
'numeric:normal' => 'NUMERIC',
'blob:big' => 'BLOB',
'blob:normal' => 'BLOB',
);
return $map;
}
public function renameTable($table, $new_name) {
if (!$this
->tableExists($table)) {
throw new SchemaObjectDoesNotExistException(t("Cannot rename @table to @table_new: table @table doesn't exist.", array(
'@table' => $table,
'@table_new' => $new_name,
)));
}
if ($this
->tableExists($new_name)) {
throw new SchemaObjectExistsException(t("Cannot rename @table to @table_new: table @table_new already exists.", array(
'@table' => $table,
'@table_new' => $new_name,
)));
}
$schema = $this
->introspectSchema($table);
$info = $this
->getPrefixInfo($new_name);
$this->connection
->query('ALTER TABLE {' . $table . '} RENAME TO ' . $info['table']);
if (!empty($schema['unique keys'])) {
foreach ($schema['unique keys'] as $key => $fields) {
$this
->dropIndex($table, $key);
}
}
if (!empty($schema['indexes'])) {
foreach ($schema['indexes'] as $index => $fields) {
$this
->dropIndex($table, $index);
}
}
$statements = $this
->createIndexSql($new_name, $schema);
foreach ($statements as $statement) {
$this->connection
->query($statement);
}
}
public function dropTable($table) {
if (!$this
->tableExists($table)) {
return FALSE;
}
$this->connection->tableDropped = TRUE;
$this->connection
->query('DROP TABLE {' . $table . '}');
return TRUE;
}
public function addField($table, $field, $specification, $keys_new = array()) {
if (!$this
->tableExists($table)) {
throw new SchemaObjectDoesNotExistException(t("Cannot add field @table.@field: table doesn't exist.", array(
'@field' => $field,
'@table' => $table,
)));
}
if ($this
->fieldExists($table, $field)) {
throw new SchemaObjectExistsException(t("Cannot add field @table.@field: field already exists.", array(
'@field' => $field,
'@table' => $table,
)));
}
if (empty($keys_new) && (empty($specification['not null']) || isset($specification['default']))) {
$query = 'ALTER TABLE {' . $table . '} ADD ' . $this
->createFieldSql($field, $this
->processField($specification));
$this->connection
->query($query);
if (isset($specification['initial'])) {
$this->connection
->update($table)
->fields(array(
$field => $specification['initial'],
))
->execute();
}
}
else {
$old_schema = $this
->introspectSchema($table);
$new_schema = $old_schema;
$new_schema['fields'][$field] = $specification;
$mapping = array();
if (isset($specification['initial'])) {
$mapping[$field] = array(
'expression' => ':newfieldinitial',
'arguments' => array(
':newfieldinitial' => $specification['initial'],
),
);
}
else {
$mapping[$field] = NULL;
}
$new_schema += $keys_new;
$this
->alterTable($table, $old_schema, $new_schema, $mapping);
}
}
protected function alterTable($table, $old_schema, $new_schema, array $mapping = array()) {
$i = 0;
do {
$new_table = $table . '_' . $i++;
} while ($this
->tableExists($new_table));
$this
->createTable($new_table, $new_schema);
$select = $this->connection
->select($table);
$possible_keys = array_keys($new_schema['fields']);
$mapping += array_combine($possible_keys, $possible_keys);
foreach ($mapping as $field_alias => $field_source) {
if (!isset($field_source)) {
continue;
}
if (is_array($field_source)) {
$select
->addExpression($field_source['expression'], $field_alias, $field_source['arguments']);
}
else {
$select
->addField($table, $field_source, $field_alias);
}
}
$this->connection
->insert($new_table)
->from($select)
->execute();
$old_count = $this->connection
->query('SELECT COUNT(*) FROM {' . $table . '}')
->fetchField();
$new_count = $this->connection
->query('SELECT COUNT(*) FROM {' . $new_table . '}')
->fetchField();
if ($old_count == $new_count) {
$this
->dropTable($table);
$this
->renameTable($new_table, $table);
}
}
protected function introspectSchema($table) {
$mapped_fields = array_flip($this
->getFieldTypeMap());
$schema = array(
'fields' => array(),
'primary key' => array(),
'unique keys' => array(),
'indexes' => array(),
);
$info = $this
->getPrefixInfo($table);
$result = $this->connection
->query('PRAGMA ' . $info['schema'] . '.table_info(' . $info['table'] . ')');
foreach ($result as $row) {
if (preg_match('/^([^(]+)\\((.*)\\)$/', $row->type, $matches)) {
$type = $matches[1];
$length = $matches[2];
}
else {
$type = $row->type;
$length = NULL;
}
if (isset($mapped_fields[$type])) {
list($type, $size) = explode(':', $mapped_fields[$type]);
$schema['fields'][$row->name] = array(
'type' => $type,
'size' => $size,
'not null' => !empty($row->notnull),
'default' => trim($row->dflt_value, "'"),
);
if ($length) {
$schema['fields'][$row->name]['length'] = $length;
}
if ($row->pk) {
$schema['primary key'][] = $row->name;
}
}
else {
new \Exception("Unable to parse the column type " . $row->type);
}
}
$indexes = array();
$result = $this->connection
->query('PRAGMA ' . $info['schema'] . '.index_list(' . $info['table'] . ')');
foreach ($result as $row) {
if (strpos($row->name, 'sqlite_autoindex_') !== 0) {
$indexes[] = array(
'schema_key' => $row->unique ? 'unique keys' : 'indexes',
'name' => $row->name,
);
}
}
foreach ($indexes as $index) {
$name = $index['name'];
$index_name = substr($name, strlen($info['table']) + 1);
$result = $this->connection
->query('PRAGMA ' . $info['schema'] . '.index_info(' . $name . ')');
foreach ($result as $row) {
$schema[$index['schema_key']][$index_name][] = $row->name;
}
}
return $schema;
}
public function dropField($table, $field) {
if (!$this
->fieldExists($table, $field)) {
return FALSE;
}
$old_schema = $this
->introspectSchema($table);
$new_schema = $old_schema;
unset($new_schema['fields'][$field]);
if (isset($new_schema['primary key']) && ($key = array_search($field, $new_schema['primary key'])) !== FALSE) {
unset($new_schema['primary key'][$key]);
}
foreach ($new_schema['indexes'] as $index => $fields) {
foreach ($fields as $key => $field_name) {
if ($field_name == $field) {
unset($new_schema['indexes'][$index][$key]);
}
}
if (empty($new_schema['indexes'][$index])) {
unset($new_schema['indexes'][$index]);
}
}
$this
->alterTable($table, $old_schema, $new_schema);
return TRUE;
}
public function changeField($table, $field, $field_new, $spec, $keys_new = array()) {
if (!$this
->fieldExists($table, $field)) {
throw new SchemaObjectDoesNotExistException(t("Cannot change the definition of field @table.@name: field doesn't exist.", array(
'@table' => $table,
'@name' => $field,
)));
}
if ($field != $field_new && $this
->fieldExists($table, $field_new)) {
throw new SchemaObjectExistsException(t("Cannot rename field @table.@name to @name_new: target field already exists.", array(
'@table' => $table,
'@name' => $field,
'@name_new' => $field_new,
)));
}
$old_schema = $this
->introspectSchema($table);
$new_schema = $old_schema;
if ($field != $field_new) {
$mapping[$field_new] = $field;
}
else {
$mapping = array();
}
unset($new_schema['fields'][$field]);
$new_schema['fields'][$field_new] = $spec;
$new_schema['primary key'] = $this
->mapKeyDefinition($new_schema['primary key'], $mapping);
foreach (array(
'unique keys',
'indexes',
) as $k) {
foreach ($new_schema[$k] as &$key_definition) {
$key_definition = $this
->mapKeyDefinition($key_definition, $mapping);
}
}
if (isset($keys_new['primary key'])) {
$new_schema['primary key'] = $keys_new['primary key'];
}
foreach (array(
'unique keys',
'indexes',
) as $k) {
if (!empty($keys_new[$k])) {
$new_schema[$k] = $keys_new[$k] + $new_schema[$k];
}
}
$this
->alterTable($table, $old_schema, $new_schema, $mapping);
}
protected function mapKeyDefinition(array $key_definition, array $mapping) {
foreach ($key_definition as &$field) {
if (is_array($field)) {
$field =& $field[0];
}
if (isset($mapping[$field])) {
$field = $mapping[$field];
}
}
return $key_definition;
}
public function addIndex($table, $name, $fields, array $spec) {
if (!$this
->tableExists($table)) {
throw new SchemaObjectDoesNotExistException(t("Cannot add index @name to table @table: table doesn't exist.", array(
'@table' => $table,
'@name' => $name,
)));
}
if ($this
->indexExists($table, $name)) {
throw new SchemaObjectExistsException(t("Cannot add index @name to table @table: index already exists.", array(
'@table' => $table,
'@name' => $name,
)));
}
$schema['indexes'][$name] = $fields;
$statements = $this
->createIndexSql($table, $schema);
foreach ($statements as $statement) {
$this->connection
->query($statement);
}
}
public function indexExists($table, $name) {
$info = $this
->getPrefixInfo($table);
return $this->connection
->query('PRAGMA ' . $info['schema'] . '.index_info(' . $info['table'] . '_' . $name . ')')
->fetchField() != '';
}
public function dropIndex($table, $name) {
if (!$this
->indexExists($table, $name)) {
return FALSE;
}
$info = $this
->getPrefixInfo($table);
$this->connection
->query('DROP INDEX ' . $info['schema'] . '.' . $info['table'] . '_' . $name);
return TRUE;
}
public function addUniqueKey($table, $name, $fields) {
if (!$this
->tableExists($table)) {
throw new SchemaObjectDoesNotExistException(t("Cannot add unique key @name to table @table: table doesn't exist.", array(
'@table' => $table,
'@name' => $name,
)));
}
if ($this
->indexExists($table, $name)) {
throw new SchemaObjectExistsException(t("Cannot add unique key @name to table @table: unique key already exists.", array(
'@table' => $table,
'@name' => $name,
)));
}
$schema['unique keys'][$name] = $fields;
$statements = $this
->createIndexSql($table, $schema);
foreach ($statements as $statement) {
$this->connection
->query($statement);
}
}
public function dropUniqueKey($table, $name) {
if (!$this
->indexExists($table, $name)) {
return FALSE;
}
$info = $this
->getPrefixInfo($table);
$this->connection
->query('DROP INDEX ' . $info['schema'] . '.' . $info['table'] . '_' . $name);
return TRUE;
}
public function addPrimaryKey($table, $fields) {
if (!$this
->tableExists($table)) {
throw new SchemaObjectDoesNotExistException(t("Cannot add primary key to table @table: table doesn't exist.", array(
'@table' => $table,
)));
}
$old_schema = $this
->introspectSchema($table);
$new_schema = $old_schema;
if (!empty($new_schema['primary key'])) {
throw new SchemaObjectExistsException(t("Cannot add primary key to table @table: primary key already exists.", array(
'@table' => $table,
)));
}
$new_schema['primary key'] = $fields;
$this
->alterTable($table, $old_schema, $new_schema);
}
public function dropPrimaryKey($table) {
$old_schema = $this
->introspectSchema($table);
$new_schema = $old_schema;
if (empty($new_schema['primary key'])) {
return FALSE;
}
unset($new_schema['primary key']);
$this
->alterTable($table, $old_schema, $new_schema);
return TRUE;
}
public function fieldSetDefault($table, $field, $default) {
if (!$this
->fieldExists($table, $field)) {
throw new SchemaObjectDoesNotExistException(t("Cannot set default value of field @table.@field: field doesn't exist.", array(
'@table' => $table,
'@field' => $field,
)));
}
$old_schema = $this
->introspectSchema($table);
$new_schema = $old_schema;
$new_schema['fields'][$field]['default'] = $default;
$this
->alterTable($table, $old_schema, $new_schema);
}
public function fieldSetNoDefault($table, $field) {
if (!$this
->fieldExists($table, $field)) {
throw new SchemaObjectDoesNotExistException(t("Cannot remove default value of field @table.@field: field doesn't exist.", array(
'@table' => $table,
'@field' => $field,
)));
}
$old_schema = $this
->introspectSchema($table);
$new_schema = $old_schema;
unset($new_schema['fields'][$field]['default']);
$this
->alterTable($table, $old_schema, $new_schema);
}
public function findTables($table_expression) {
$tables = [];
$attached_dbs = $this->connection
->getAttachedDatabases();
foreach ($attached_dbs as $schema) {
$result = db_query("SELECT name FROM " . $schema . ".sqlite_master WHERE type = :type AND name LIKE :table_name AND name NOT LIKE :pattern", array(
':type' => 'table',
':table_name' => $table_expression,
':pattern' => 'sqlite_%',
));
$tables += $result
->fetchAllKeyed(0, 0);
}
return $tables;
}
}