public function DatabaseSchema_mysql::getComment

Retrieve a table or column comment.

File

core/includes/database/mysql/schema.inc, line 490

Database schema code for MySQL database servers.

Class

DatabaseSchema_mysql

Code

public function getComment($table, $column = NULL) {
  $condition = $this->buildTableNameCondition($table);
  if (isset($column)) {
    $condition->condition('column_name', $column);
    $condition->compile($this->connection, $this);
    // Don't use {} around information_schema.columns table.
    return $this->connection->query("SELECT column_comment FROM information_schema.columns WHERE " . (string) $condition, $condition->arguments())->fetchField();
  }
  $condition->compile($this->connection, $this);
  // Don't use {} around information_schema.tables table.
  return $this->connection->query("SELECT table_comment FROM information_schema.tables WHERE " . (string) $condition, $condition->arguments())->fetchField();
}