public function Schema::dropField in Drupal 10

Same name in this branch

1. 10 core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::dropField()
2. 10 core/modules/sqlite/src/Driver/Database/sqlite/Schema.php \Drupal\sqlite\Driver\Database\sqlite\Schema::dropField()
3. 10 core/modules/pgsql/src/Driver/Database/pgsql/Schema.php \Drupal\pgsql\Driver\Database\pgsql\Schema::dropField()
4. 10 core/modules/mysql/src/Driver/Database/mysql/Schema.php \Drupal\mysql\Driver\Database\mysql\Schema::dropField()
5. 10 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Schema.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\Schema::dropField()

Drop a field.

Parameters

$table: The table to be altered.

$field: The field to be dropped.

Return value

TRUE if the field was successfully dropped, FALSE if there was no field by that name to begin with.

Overrides Schema::dropField

File

core/modules/mysql/src/Driver/Database/mysql/Schema.php, line 465

Class

Schema

MySQL implementation of \Drupal\Core\Database\Schema.

Namespace

Drupal\mysql\Driver\Database\mysql

Code

public function dropField($table, $field) {
  if (!$this
    ->fieldExists($table, $field)) {
    return FALSE;
  }

  // When dropping a field that is part of a composite primary key MySQL
  // automatically removes the field from the primary key, which can leave the
  // table in an invalid state. MariaDB 10.2.8 requires explicitly dropping
  // the primary key first for this reason. We perform this deletion
  // explicitly which also makes the behavior on both MySQL and MariaDB
  // consistent with PostgreSQL.
  // @see https://mariadb.com/kb/en/library/alter-table
  $primary_key = $this
    ->findPrimaryKeyColumns($table);
  if (count($primary_key) > 1 && in_array($field, $primary_key, TRUE)) {
    $this
      ->dropPrimaryKey($table);
  }
  $this->connection
    ->query('ALTER TABLE {' . $table . '} DROP `' . $field . '`');
  return TRUE;
}