Schema.php 25.9 KB
Newer Older
ayelet_Cr's avatar
ayelet_Cr committed
1 2
<?php

3
namespace Drupal\Core\Database\Driver\sqlite;
ayelet_Cr's avatar
ayelet_Cr committed
4

5 6 7
use Drupal\Core\Database\SchemaObjectExistsException;
use Drupal\Core\Database\SchemaObjectDoesNotExistException;
use Drupal\Core\Database\Schema as DatabaseSchema;
ayelet_Cr's avatar
ayelet_Cr committed
8 9 10 11 12 13

/**
 * @ingroup schemaapi
 * @{
 */

14 15 16
/**
 * SQLite implementation of \Drupal\Core\Database\Schema.
 */
ayelet_Cr's avatar
ayelet_Cr committed
17 18 19 20
class Schema extends DatabaseSchema {

  /**
   * Override DatabaseSchema::$defaultSchema
21 22
   *
   * @var string
ayelet_Cr's avatar
ayelet_Cr committed
23 24 25
   */
  protected $defaultSchema = 'main';

26 27 28
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
29 30 31 32
  public function tableExists($table) {
    $info = $this->getPrefixInfo($table);

    // Don't use {} around sqlite_master table.
33
    return (bool) $this->connection->query('SELECT 1 FROM ' . $info['schema'] . '.sqlite_master WHERE type = :type AND name = :name', [':type' => 'table', ':name' => $info['table']])->fetchField();
ayelet_Cr's avatar
ayelet_Cr committed
34 35
  }

36 37 38
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
  public function fieldExists($table, $column) {
    $schema = $this->introspectSchema($table);
    return !empty($schema['fields'][$column]);
  }

  /**
   * Generate SQL to create a new table from a Drupal schema definition.
   *
   * @param $name
   *   The name of the table to create.
   * @param $table
   *   A Schema API table definition array.
   * @return
   *   An array of SQL statements to create the table.
   */
  public function createTableSql($name, $table) {
55 56 57 58
    if (!empty($table['primary key']) && is_array($table['primary key'])) {
      $this->ensureNotNullPrimaryKey($table['primary key'], $table['fields']);
    }

59
    $sql = [];
60
    $sql[] = "CREATE TABLE {" . $name . "} (\n" . $this->createColumnsSql($name, $table) . "\n)\n";
ayelet_Cr's avatar
ayelet_Cr committed
61 62 63 64 65 66 67
    return array_merge($sql, $this->createIndexSql($name, $table));
  }

  /**
   * Build the SQL expression for indexes.
   */
  protected function createIndexSql($tablename, $schema) {
68
    $sql = [];
ayelet_Cr's avatar
ayelet_Cr committed
69 70 71
    $info = $this->getPrefixInfo($tablename);
    if (!empty($schema['unique keys'])) {
      foreach ($schema['unique keys'] as $key => $fields) {
72
        $sql[] = 'CREATE UNIQUE INDEX ' . $info['schema'] . '.' . $info['table'] . '_' . $key . ' ON ' . $info['table'] . ' (' . $this->createKeySql($fields) . ")\n";
ayelet_Cr's avatar
ayelet_Cr committed
73 74 75 76
      }
    }
    if (!empty($schema['indexes'])) {
      foreach ($schema['indexes'] as $key => $fields) {
77
        $sql[] = 'CREATE INDEX ' . $info['schema'] . '.' . $info['table'] . '_' . $key . ' ON ' . $info['table'] . ' (' . $this->createKeySql($fields) . ")\n";
ayelet_Cr's avatar
ayelet_Cr committed
78 79 80 81 82 83 84 85
      }
    }
    return $sql;
  }

  /**
   * Build the SQL expression for creating columns.
   */
86
  protected function createColumnsSql($tablename, $schema) {
87
    $sql_array = [];
ayelet_Cr's avatar
ayelet_Cr committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

    // Add the SQL statement for each field.
    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));
    }

    // Process keys.
    if (!empty($schema['primary key'])) {
      $sql_array[] = " PRIMARY KEY (" . $this->createKeySql($schema['primary key']) . ")";
    }

    return implode(", \n", $sql_array);
  }

  /**
   * Build the SQL expression for keys.
   */
  protected function createKeySql($fields) {
111
    $return = [];
ayelet_Cr's avatar
ayelet_Cr committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
    foreach ($fields as $field) {
      if (is_array($field)) {
        $return[] = $field[0];
      }
      else {
        $return[] = $field;
      }
    }
    return implode(', ', $return);
  }

  /**
   * Set database-engine specific properties for a field.
   *
   * @param $field
   *   A field description array, as specified in the schema documentation.
   */
  protected function processField($field) {
    if (!isset($field['size'])) {
      $field['size'] = 'normal';
    }

    // Set the correct database-engine specific datatype.
    // In case one is already provided, force it to uppercase.
    if (isset($field['sqlite_type'])) {
137
      $field['sqlite_type'] = mb_strtoupper($field['sqlite_type']);
ayelet_Cr's avatar
ayelet_Cr committed
138 139 140 141
    }
    else {
      $map = $this->getFieldTypeMap();
      $field['sqlite_type'] = $map[$field['type'] . ':' . $field['size']];
142 143 144 145 146

      // Numeric fields with a specified scale have to be stored as floats.
      if ($field['sqlite_type'] === 'NUMERIC' && isset($field['scale'])) {
        $field['sqlite_type'] = 'FLOAT';
      }
ayelet_Cr's avatar
ayelet_Cr committed
147 148 149 150 151 152 153 154 155 156 157 158 159
    }

    if (isset($field['type']) && $field['type'] == 'serial') {
      $field['auto_increment'] = TRUE;
    }

    return $field;
  }

  /**
   * Create an SQL string for a field to be used in table creation or alteration.
   *
   * Before passing a field out of a schema definition into this function it has
160
   * to be processed by self::processField().
ayelet_Cr's avatar
ayelet_Cr committed
161 162
   *
   * @param $name
163
   *   Name of the field.
ayelet_Cr's avatar
ayelet_Cr committed
164
   * @param $spec
165
   *   The field specification, as per the schema data structure format.
ayelet_Cr's avatar
ayelet_Cr committed
166 167
   */
  protected function createFieldSql($name, $spec) {
168
    $name = $this->connection->escapeField($name);
ayelet_Cr's avatar
ayelet_Cr committed
169 170 171 172 173 174 175 176 177
    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'];

178
      if (in_array($spec['sqlite_type'], ['VARCHAR', 'TEXT'])) {
179 180 181 182 183 184 185
        if (isset($spec['length'])) {
          $sql .= '(' . $spec['length'] . ')';
        }

        if (isset($spec['binary']) && $spec['binary'] === FALSE) {
          $sql .= ' COLLATE NOCASE_UTF8';
        }
ayelet_Cr's avatar
ayelet_Cr committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
      }

      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'])) {
203
          $spec['default'] = $this->connection->quote($spec['default']);
ayelet_Cr's avatar
ayelet_Cr committed
204 205 206 207 208 209 210 211 212 213 214 215
        }
        $sql .= ' DEFAULT ' . $spec['default'];
      }

      if (empty($spec['not null']) && !isset($spec['default'])) {
        $sql .= ' DEFAULT NULL';
      }
    }
    return $sql;
  }

  /**
216
   * {@inheritdoc}
ayelet_Cr's avatar
ayelet_Cr committed
217 218 219 220 221 222
   */
  public function getFieldTypeMap() {
    // Put :normal last so it gets preserved by array_flip. This makes
    // it much easier for modules (such as schema.module) to map
    // database types back into schema types.
    // $map does not use drupal_static as its value never changes.
223
    static $map = [
224 225
      'varchar_ascii:normal' => 'VARCHAR',

ayelet_Cr's avatar
ayelet_Cr committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
      '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',
257
    ];
ayelet_Cr's avatar
ayelet_Cr committed
258 259 260
    return $map;
  }

261 262 263
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
264 265
  public function renameTable($table, $new_name) {
    if (!$this->tableExists($table)) {
266
      throw new SchemaObjectDoesNotExistException("Cannot rename '$table' to '$new_name': table '$table' doesn't exist.");
ayelet_Cr's avatar
ayelet_Cr committed
267 268
    }
    if ($this->tableExists($new_name)) {
269
      throw new SchemaObjectExistsException("Cannot rename '$table' to '$new_name': table '$new_name' already exists.");
ayelet_Cr's avatar
ayelet_Cr committed
270 271 272 273 274
    }

    $schema = $this->introspectSchema($table);

    // SQLite doesn't allow you to rename tables outside of the current
275
    // database. So the syntax '... RENAME TO database.table' would fail.
ayelet_Cr's avatar
ayelet_Cr committed
276
    // So we must determine the full table name here rather than surrounding
277 278
    // the table with curly braces in case the db_prefix contains a reference
    // to a database outside of our existing database.
ayelet_Cr's avatar
ayelet_Cr committed
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
    $info = $this->getPrefixInfo($new_name);
    $this->connection->query('ALTER TABLE {' . $table . '} RENAME TO ' . $info['table']);

    // Drop the indexes, there is no RENAME INDEX command in SQLite.
    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);
      }
    }

    // Recreate the indexes.
    $statements = $this->createIndexSql($new_name, $schema);
    foreach ($statements as $statement) {
      $this->connection->query($statement);
    }
  }

301 302 303
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
304 305 306 307 308 309 310 311 312
  public function dropTable($table) {
    if (!$this->tableExists($table)) {
      return FALSE;
    }
    $this->connection->tableDropped = TRUE;
    $this->connection->query('DROP TABLE {' . $table . '}');
    return TRUE;
  }

313 314 315
  /**
   * {@inheritdoc}
   */
316
  public function addField($table, $field, $specification, $keys_new = []) {
ayelet_Cr's avatar
ayelet_Cr committed
317
    if (!$this->tableExists($table)) {
318
      throw new SchemaObjectDoesNotExistException("Cannot add field '$table.$field': table doesn't exist.");
ayelet_Cr's avatar
ayelet_Cr committed
319 320
    }
    if ($this->fieldExists($table, $field)) {
321
      throw new SchemaObjectExistsException("Cannot add field '$table.$field': field already exists.");
ayelet_Cr's avatar
ayelet_Cr committed
322
    }
323 324 325
    if (isset($keys_new['primary key']) && in_array($field, $keys_new['primary key'], TRUE)) {
      $this->ensureNotNullPrimaryKey($keys_new['primary key'], [$field => $specification]);
    }
ayelet_Cr's avatar
ayelet_Cr committed
326 327 328 329 330 331 332 333 334 335 336

    // SQLite doesn't have a full-featured ALTER TABLE statement. It only
    // supports adding new fields to a table, in some simple cases. In most
    // cases, we have to create a new table and copy the data over.
    if (empty($keys_new) && (empty($specification['not null']) || isset($specification['default']))) {
      // When we don't have to create new keys and we are not creating a
      // NOT NULL column without a default value, we can use the quicker version.
      $query = 'ALTER TABLE {' . $table . '} ADD ' . $this->createFieldSql($field, $this->processField($specification));
      $this->connection->query($query);

      // Apply the initial value if set.
337
      if (isset($specification['initial_from_field'])) {
338 339 340 341 342 343 344 345
        if (isset($specification['initial'])) {
          $expression = 'COALESCE(' . $specification['initial_from_field'] . ', :default_initial_value)';
          $arguments = [':default_initial_value' => $specification['initial']];
        }
        else {
          $expression = $specification['initial_from_field'];
          $arguments = [];
        }
346
        $this->connection->update($table)
347
          ->expression($field, $expression, $arguments)
348 349
          ->execute();
      }
350 351 352 353 354
      elseif (isset($specification['initial'])) {
        $this->connection->update($table)
          ->fields([$field => $specification['initial']])
          ->execute();
      }
ayelet_Cr's avatar
ayelet_Cr committed
355 356 357 358 359 360 361 362 363 364 365
    }
    else {
      // We cannot add the field directly. Use the slower table alteration
      // method, starting from the old schema.
      $old_schema = $this->introspectSchema($table);
      $new_schema = $old_schema;

      // Add the new field.
      $new_schema['fields'][$field] = $specification;

      // Build the mapping between the old fields and the new fields.
366
      $mapping = [];
367
      if (isset($specification['initial_from_field'])) {
368
        // If we have a initial value, copy it over.
369 370 371 372 373 374 375 376
        if (isset($specification['initial'])) {
          $expression = 'COALESCE(' . $specification['initial_from_field'] . ', :default_initial_value)';
          $arguments = [':default_initial_value' => $specification['initial']];
        }
        else {
          $expression = $specification['initial_from_field'];
          $arguments = [];
        }
377
        $mapping[$field] = [
378 379
          'expression' => $expression,
          'arguments' => $arguments,
380
        ];
381
      }
382 383 384 385 386 387 388
      elseif (isset($specification['initial'])) {
        // If we have a initial value, copy it over.
        $mapping[$field] = [
          'expression' => ':newfieldinitial',
          'arguments' => [':newfieldinitial' => $specification['initial']],
        ];
      }
ayelet_Cr's avatar
ayelet_Cr committed
389 390 391 392 393 394
      else {
        // Else use the default of the field.
        $mapping[$field] = NULL;
      }

      // Add the new indexes.
395
      $new_schema = array_merge($new_schema, $keys_new);
ayelet_Cr's avatar
ayelet_Cr committed
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421

      $this->alterTable($table, $old_schema, $new_schema, $mapping);
    }
  }

  /**
   * Create a table with a new schema containing the old content.
   *
   * As SQLite does not support ALTER TABLE (with a few exceptions) it is
   * necessary to create a new table and copy over the old content.
   *
   * @param $table
   *   Name of the table to be altered.
   * @param $old_schema
   *   The old schema array for the table.
   * @param $new_schema
   *   The new schema array for the table.
   * @param $mapping
   *   An optional mapping between the fields of the old specification and the
   *   fields of the new specification. An associative array, whose keys are
   *   the fields of the new table, and values can take two possible forms:
   *     - a simple string, which is interpreted as the name of a field of the
   *       old table,
   *     - an associative array with two keys 'expression' and 'arguments',
   *       that will be used as an expression field.
   */
422
  protected function alterTable($table, $old_schema, $new_schema, array $mapping = []) {
ayelet_Cr's avatar
ayelet_Cr committed
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
    $i = 0;
    do {
      $new_table = $table . '_' . $i++;
    } while ($this->tableExists($new_table));

    $this->createTable($new_table, $new_schema);

    // Build a SQL query to migrate the data from the old table to the new.
    $select = $this->connection->select($table);

    // Complete the mapping.
    $possible_keys = array_keys($new_schema['fields']);
    $mapping += array_combine($possible_keys, $possible_keys);

    // Now add the fields.
    foreach ($mapping as $field_alias => $field_source) {
439
      // Just ignore this field (ie. use its default value).
ayelet_Cr's avatar
ayelet_Cr committed
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
      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);
      }
    }

    // Execute the data migration query.
    $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);
    }
  }

  /**
   * Find out the schema of a table.
   *
   * This function uses introspection methods provided by the database to
   * create a schema array. This is useful, for example, during update when
   * the old schema is not available.
   *
   * @param $table
   *   Name of the table.
474
   *
ayelet_Cr's avatar
ayelet_Cr committed
475
   * @return
476
   *   An array representing the schema.
477 478 479
   *
   * @throws \Exception
   *   If a column of the table could not be parsed.
ayelet_Cr's avatar
ayelet_Cr committed
480 481 482
   */
  protected function introspectSchema($table) {
    $mapped_fields = array_flip($this->getFieldTypeMap());
483 484 485 486 487 488
    $schema = [
      'fields' => [],
      'primary key' => [],
      'unique keys' => [],
      'indexes' => [],
    ];
ayelet_Cr's avatar
ayelet_Cr committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502

    $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]);
503
        $schema['fields'][$row->name] = [
ayelet_Cr's avatar
ayelet_Cr committed
504 505
          'type' => $type,
          'size' => $size,
506
          'not null' => !empty($row->notnull) || $row->pk !== "0",
ayelet_Cr's avatar
ayelet_Cr committed
507
          'default' => trim($row->dflt_value, "'"),
508
        ];
ayelet_Cr's avatar
ayelet_Cr committed
509 510 511
        if ($length) {
          $schema['fields'][$row->name]['length'] = $length;
        }
512 513 514
        // $row->pk contains a number that reflects the primary key order. We
        // use that as the key and sort (by key) below to return the primary key
        // in the same order that it is stored in.
ayelet_Cr's avatar
ayelet_Cr committed
515
        if ($row->pk) {
516
          $schema['primary key'][$row->pk] = $row->name;
ayelet_Cr's avatar
ayelet_Cr committed
517 518 519
        }
      }
      else {
520
        throw new \Exception("Unable to parse the column type " . $row->type);
ayelet_Cr's avatar
ayelet_Cr committed
521 522
      }
    }
523 524 525 526
    ksort($schema['primary key']);
    // Re-key the array because $row->pk starts counting at 1.
    $schema['primary key'] = array_values($schema['primary key']);

527
    $indexes = [];
ayelet_Cr's avatar
ayelet_Cr committed
528 529 530
    $result = $this->connection->query('PRAGMA ' . $info['schema'] . '.index_list(' . $info['table'] . ')');
    foreach ($result as $row) {
      if (strpos($row->name, 'sqlite_autoindex_') !== 0) {
531
        $indexes[] = [
ayelet_Cr's avatar
ayelet_Cr committed
532 533
          'schema_key' => $row->unique ? 'unique keys' : 'indexes',
          'name' => $row->name,
534
        ];
ayelet_Cr's avatar
ayelet_Cr committed
535 536 537 538 539 540 541 542 543 544 545 546 547 548
      }
    }
    foreach ($indexes as $index) {
      $name = $index['name'];
      // Get index name without prefix.
      $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;
  }

549 550 551
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
552 553 554 555 556 557 558 559 560
  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]);
561

562 563 564 565 566
    // Drop the primary key if the field to drop is part of it. This is
    // consistent with the behavior on PostgreSQL.
    // @see \Drupal\Core\Database\Driver\mysql\Schema::dropField()
    if (isset($new_schema['primary key']) && in_array($field, $new_schema['primary key'], TRUE)) {
      unset($new_schema['primary key']);
567 568 569
    }

    // Handle possible index changes.
ayelet_Cr's avatar
ayelet_Cr committed
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
    foreach ($new_schema['indexes'] as $index => $fields) {
      foreach ($fields as $key => $field_name) {
        if ($field_name == $field) {
          unset($new_schema['indexes'][$index][$key]);
        }
      }
      // If this index has no more fields then remove it.
      if (empty($new_schema['indexes'][$index])) {
        unset($new_schema['indexes'][$index]);
      }
    }
    $this->alterTable($table, $old_schema, $new_schema);
    return TRUE;
  }

585 586 587
  /**
   * {@inheritdoc}
   */
588
  public function changeField($table, $field, $field_new, $spec, $keys_new = []) {
ayelet_Cr's avatar
ayelet_Cr committed
589
    if (!$this->fieldExists($table, $field)) {
590
      throw new SchemaObjectDoesNotExistException("Cannot change the definition of field '$table.$field': field doesn't exist.");
ayelet_Cr's avatar
ayelet_Cr committed
591 592
    }
    if (($field != $field_new) && $this->fieldExists($table, $field_new)) {
593
      throw new SchemaObjectExistsException("Cannot rename field '$table.$field' to '$field_new': target field already exists.");
ayelet_Cr's avatar
ayelet_Cr committed
594
    }
595 596 597
    if (isset($keys_new['primary key']) && in_array($field_new, $keys_new['primary key'], TRUE)) {
      $this->ensureNotNullPrimaryKey($keys_new['primary key'], [$field_new => $spec]);
    }
ayelet_Cr's avatar
ayelet_Cr committed
598 599 600 601 602 603 604 605 606

    $old_schema = $this->introspectSchema($table);
    $new_schema = $old_schema;

    // Map the old field to the new field.
    if ($field != $field_new) {
      $mapping[$field_new] = $field;
    }
    else {
607
      $mapping = [];
ayelet_Cr's avatar
ayelet_Cr committed
608 609 610 611 612 613 614 615
    }

    // Remove the previous definition and swap in the new one.
    unset($new_schema['fields'][$field]);
    $new_schema['fields'][$field_new] = $spec;

    // Map the former indexes to the new column name.
    $new_schema['primary key'] = $this->mapKeyDefinition($new_schema['primary key'], $mapping);
616
    foreach (['unique keys', 'indexes'] as $k) {
ayelet_Cr's avatar
ayelet_Cr committed
617 618 619 620 621 622 623 624 625
      foreach ($new_schema[$k] as &$key_definition) {
        $key_definition = $this->mapKeyDefinition($key_definition, $mapping);
      }
    }

    // Add in the keys from $keys_new.
    if (isset($keys_new['primary key'])) {
      $new_schema['primary key'] = $keys_new['primary key'];
    }
626
    foreach (['unique keys', 'indexes'] as $k) {
ayelet_Cr's avatar
ayelet_Cr committed
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
      if (!empty($keys_new[$k])) {
        $new_schema[$k] = $keys_new[$k] + $new_schema[$k];
      }
    }

    $this->alterTable($table, $old_schema, $new_schema, $mapping);
  }

  /**
   * Utility method: rename columns in an index definition according to a new mapping.
   *
   * @param $key_definition
   *   The key definition.
   * @param $mapping
   *   The new mapping.
   */
  protected function mapKeyDefinition(array $key_definition, array $mapping) {
    foreach ($key_definition as &$field) {
      // The key definition can be an array($field, $length).
      if (is_array($field)) {
        $field = &$field[0];
      }
649 650 651 652

      $mapped_field = array_search($field, $mapping, TRUE);
      if ($mapped_field !== FALSE) {
        $field = $mapped_field;
ayelet_Cr's avatar
ayelet_Cr committed
653 654 655 656 657
      }
    }
    return $key_definition;
  }

658 659 660 661
  /**
   * {@inheritdoc}
   */
  public function addIndex($table, $name, $fields, array $spec) {
ayelet_Cr's avatar
ayelet_Cr committed
662
    if (!$this->tableExists($table)) {
663
      throw new SchemaObjectDoesNotExistException("Cannot add index '$name' to table '$table': table doesn't exist.");
ayelet_Cr's avatar
ayelet_Cr committed
664 665
    }
    if ($this->indexExists($table, $name)) {
666
      throw new SchemaObjectExistsException("Cannot add index '$name' to table '$table': index already exists.");
ayelet_Cr's avatar
ayelet_Cr committed
667 668 669 670 671 672 673 674 675
    }

    $schema['indexes'][$name] = $fields;
    $statements = $this->createIndexSql($table, $schema);
    foreach ($statements as $statement) {
      $this->connection->query($statement);
    }
  }

676 677 678
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
679 680 681 682 683 684
  public function indexExists($table, $name) {
    $info = $this->getPrefixInfo($table);

    return $this->connection->query('PRAGMA ' . $info['schema'] . '.index_info(' . $info['table'] . '_' . $name . ')')->fetchField() != '';
  }

685 686 687
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
688 689 690 691 692 693 694 695 696 697 698
  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;
  }

699 700 701
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
702 703
  public function addUniqueKey($table, $name, $fields) {
    if (!$this->tableExists($table)) {
704
      throw new SchemaObjectDoesNotExistException("Cannot add unique key '$name' to table '$table': table doesn't exist.");
ayelet_Cr's avatar
ayelet_Cr committed
705 706
    }
    if ($this->indexExists($table, $name)) {
707
      throw new SchemaObjectExistsException("Cannot add unique key '$name' to table '$table': unique key already exists.");
ayelet_Cr's avatar
ayelet_Cr committed
708 709 710 711 712 713 714 715 716
    }

    $schema['unique keys'][$name] = $fields;
    $statements = $this->createIndexSql($table, $schema);
    foreach ($statements as $statement) {
      $this->connection->query($statement);
    }
  }

717 718 719
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
720 721 722 723 724 725 726 727 728 729 730
  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;
  }

731 732 733
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
734 735
  public function addPrimaryKey($table, $fields) {
    if (!$this->tableExists($table)) {
736
      throw new SchemaObjectDoesNotExistException("Cannot add primary key to table '$table': table doesn't exist.");
ayelet_Cr's avatar
ayelet_Cr committed
737 738 739 740 741 742
    }

    $old_schema = $this->introspectSchema($table);
    $new_schema = $old_schema;

    if (!empty($new_schema['primary key'])) {
743
      throw new SchemaObjectExistsException("Cannot add primary key to table '$table': primary key already exists.");
ayelet_Cr's avatar
ayelet_Cr committed
744 745 746
    }

    $new_schema['primary key'] = $fields;
747
    $this->ensureNotNullPrimaryKey($new_schema['primary key'], $new_schema['fields']);
ayelet_Cr's avatar
ayelet_Cr committed
748 749 750
    $this->alterTable($table, $old_schema, $new_schema);
  }

751 752 753
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
754 755 756 757 758 759 760 761 762 763 764 765 766
  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;
  }

767 768 769 770 771 772 773 774 775 776 777
  /**
   * {@inheritdoc}
   */
  protected function findPrimaryKeyColumns($table) {
    if (!$this->tableExists($table)) {
      return FALSE;
    }
    $schema = $this->introspectSchema($table);
    return $schema['primary key'];
  }

778 779 780 781 782 783 784 785 786 787 788 789
  /**
   * {@inheritdoc}
   */
  protected function introspectIndexSchema($table) {
    if (!$this->tableExists($table)) {
      throw new SchemaObjectDoesNotExistException("The table $table doesn't exist.");
    }
    $schema = $this->introspectSchema($table);
    unset($schema['fields']);
    return $schema;
  }

790 791 792
  /**
   * {@inheritdoc}
   */
ayelet_Cr's avatar
ayelet_Cr committed
793
  public function findTables($table_expression) {
794 795 796 797 798 799 800 801 802 803 804 805
    $tables = [];

    // The SQLite implementation doesn't need to use the same filtering strategy
    // as the parent one because individually prefixed tables live in their own
    // schema (database), which means that neither the main database nor any
    // attached one will contain a prefixed table name, so we just need to loop
    // over all known schemas and filter by the user-supplied table expression.
    $attached_dbs = $this->connection->getAttachedDatabases();
    foreach ($attached_dbs as $schema) {
      // Can't use query placeholders for the schema because the query would
      // have to be :prefixsqlite_master, which does not work. We also need to
      // ignore the internal SQLite tables.
806
      $result = $this->connection->query("SELECT name FROM " . $schema . ".sqlite_master WHERE type = :type AND name LIKE :table_name AND name NOT LIKE :pattern", [
807 808 809
        ':type' => 'table',
        ':table_name' => $table_expression,
        ':pattern' => 'sqlite_%',
810
      ]);
811 812 813 814
      $tables += $result->fetchAllKeyed(0, 0);
    }

    return $tables;
ayelet_Cr's avatar
ayelet_Cr committed
815
  }
816

817
}