function Schema::fieldExists

Same name in this branch
  1. 11.x core/modules/sqlite/src/Driver/Database/sqlite/Schema.php \Drupal\sqlite\Driver\Database\sqlite\Schema::fieldExists()
  2. 11.x core/modules/pgsql/src/Driver/Database/pgsql/Schema.php \Drupal\pgsql\Driver\Database\pgsql\Schema::fieldExists()
Same name in other branches
  1. 9 core/modules/sqlite/src/Driver/Database/sqlite/Schema.php \Drupal\sqlite\Driver\Database\sqlite\Schema::fieldExists()
  2. 9 core/modules/pgsql/src/Driver/Database/pgsql/Schema.php \Drupal\pgsql\Driver\Database\pgsql\Schema::fieldExists()
  3. 9 core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::fieldExists()
  4. 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Schema.php \Drupal\Core\Database\Driver\sqlite\Schema::fieldExists()
  5. 8.9.x core/lib/Drupal/Core/Database/Driver/mysql/Schema.php \Drupal\Core\Database\Driver\mysql\Schema::fieldExists()
  6. 8.9.x core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php \Drupal\Core\Database\Driver\pgsql\Schema::fieldExists()
  7. 8.9.x core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::fieldExists()
  8. 10 core/modules/sqlite/src/Driver/Database/sqlite/Schema.php \Drupal\sqlite\Driver\Database\sqlite\Schema::fieldExists()
  9. 10 core/modules/pgsql/src/Driver/Database/pgsql/Schema.php \Drupal\pgsql\Driver\Database\pgsql\Schema::fieldExists()
  10. 10 core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::fieldExists()

Check if a column exists in the given table.

Parameters

string $table: The name of the table in drupal (no prefixing).

string $column: The name of the column.

Return value

bool TRUE if the given column exists, otherwise FALSE.

3 calls to Schema::fieldExists()
Schema::addField in core/modules/mysql/src/Driver/Database/mysql/Schema.php
Add a new field to a table.
Schema::changeField in core/modules/mysql/src/Driver/Database/mysql/Schema.php
Change a field definition.
Schema::dropField in core/modules/mysql/src/Driver/Database/mysql/Schema.php
Drop a field.
2 methods override Schema::fieldExists()
Schema::fieldExists in core/modules/sqlite/src/Driver/Database/sqlite/Schema.php
Check if a column exists in the given table.
Schema::fieldExists in core/modules/pgsql/src/Driver/Database/pgsql/Schema.php
Check if a column exists in the given table.

File

core/lib/Drupal/Core/Database/Schema.php, line 248

Class

Schema
Provides a base implementation for Database Schema.

Namespace

Drupal\Core\Database

Code

public function fieldExists($table, $column) {
    $condition = $this->buildTableNameCondition($table);
    $condition->condition('column_name', $column);
    $condition->compile($this->connection, $this);
    // Normally, we would heartily discourage the use of string
    // concatenation for conditionals like this however, we
    // couldn't use \Drupal::database()->select() here because it would prefix
    // information_schema.tables and the query would fail.
    // Don't use {} around information_schema.columns table.
    return (bool) $this->connection
        ->query("SELECT 1 FROM information_schema.columns WHERE " . (string) $condition, $condition->arguments())
        ->fetchField();
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.