public function Schema::getComment in Drupal 8

Same name in this branch

1. 8 core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php \Drupal\Core\Database\Driver\pgsql\Schema::getComment()
2. 8 core/lib/Drupal/Core/Database/Driver/mysql/Schema.php \Drupal\Core\Database\Driver\mysql\Schema::getComment()

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php \Drupal\Core\Database\Driver\pgsql\Schema::getComment()

Retrieve a table or column comment.

File

core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php, line 1062

Class

Schema

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

Namespace

Drupal\Core\Database\Driver\pgsql

Code

public function getComment($table, $column = NULL) {
  $info = $this
    ->getPrefixInfo($table);

  // Don't use {} around pg_class, pg_attribute tables.
  if (isset($column)) {
    return $this->connection
      ->query('SELECT col_description(oid, attnum) FROM pg_class, pg_attribute WHERE attrelid = oid AND relname = ? AND attname = ?', [
      $info['table'],
      $column,
    ])
      ->fetchField();
  }
  else {
    return $this->connection
      ->query('SELECT obj_description(oid, ?) FROM pg_class WHERE relname = ?', [
      'pg_class',
      $info['table'],
    ])
      ->fetchField();
  }
}