function DatabaseSchema::prepareComment

Prepare a table or column comment for database query.

Parameters

$comment: The comment string to prepare.

$length: Optional upper limit on the returned string length.

Return value

The prepared comment.

3 calls to DatabaseSchema::prepareComment()
DatabaseSchema_pgsql::addField in includes/database/pgsql/schema.inc
Add a new field to a table.
DatabaseSchema_pgsql::changeField in includes/database/pgsql/schema.inc
Change a field definition.
DatabaseSchema_pgsql::createTableSql in includes/database/pgsql/schema.inc
Generate SQL to create a new table from a Drupal schema definition.
1 method overrides DatabaseSchema::prepareComment()
DatabaseSchema_mysql::prepareComment in includes/database/mysql/schema.inc
Prepare a table or column comment for database query.

File

includes/database/schema.inc, line 775

Class

DatabaseSchema
Base class for database schema definitions.

Code

public function prepareComment($comment, $length = NULL) {
    return $this->connection
        ->quote($comment);
}

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