function Schema::getComment

Retrieve a table or column comment.

File

core/modules/pgsql/src/Driver/Database/pgsql/Schema.php, line 1034

Class

Schema

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

Namespace

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();
  }
}