public function Schema::CommentGet in Drupal driver for SQL Server and SQL Azure 8.2

Get the description property of a table or column.

Parameters

string $table:

string $column:

Return value

string

2 calls to Schema::CommentGet()

Schema::CommentCreateOrUpdate in drivers/lib/Drupal/Driver/Database/sqlsrv/Schema.php

Create, update or remove a comment for a database object, transaction friendly.

Schema::getComment in drivers/lib/Drupal/Driver/Database/sqlsrv/Schema.php

Retrieve a table or column comment.

File

drivers/lib/Drupal/Driver/Database/sqlsrv/Schema.php, line 209

Definition of Drupal\Driver\Database\sqlsrv\Schema

Class

Schema

Namespace

Drupal\Driver\Database\sqlsrv

Code

public function CommentGet($table, $column = null) {
  $arguments = array(
    'MS_Description',
    'Schema',
    $this
      ->GetDefaultSchema(),
    'Table',
    $table,
  );
  if (!empty($column)) {
    $arguments[] = 'column';
    $arguments[] = $column;
  }
  $args = call_user_func_array(Utils::class . '::GetExtendedProperty', $arguments);
  $extended_property = $this->connection
    ->GetConnection()
    ->query_execute($args['query'], $args['args'])
    ->fetchAssoc();
  if (is_array($extended_property)) {
    return $extended_property['value'];
  }
  return '';
}