protected function DatabaseSchema_mysql::createFieldSql

Create a SQL string for a field to be used in table creation or alteration.

Before passing a field out of a schema definition into this function it has to be processed by DatabaseSchema_mysql::processField().

Parameters

string $name: Name of the field.

array $spec: The field specification, as per the schema data structure format.

Return value

string: A string that can be used to create or alter a table.

File

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

Database schema code for MySQL database servers.

Class

DatabaseSchema_mysql

Class to create and manipulate MySQL tables.

Code

protected function createFieldSql($name, array $spec) {
  $sql = "`" . $name . "` " . $spec['mysql_type'];

  $string_types = array(
    'VARCHAR',
    'CHAR',
    'TINYTEXT',
    'MEDIUMTEXT',
    'LONGTEXT',
    'TEXT',
  );
  if (in_array($spec['mysql_type'], $string_types)) {
    if (isset($spec['length'])) {
      $sql .= '(' . $spec['length'] . ')';
    }
    if (!empty($spec['binary'])) {
      $sql .= ' BINARY';
    }
  }
  elseif (isset($spec['precision']) && isset($spec['scale'])) {
    $sql .= '(' . $spec['precision'] . ', ' . $spec['scale'] . ')';
  }

  if (!empty($spec['unsigned'])) {
    $sql .= ' unsigned';
  }

  if (isset($spec['not null'])) {
    if ($spec['not null']) {
      $sql .= ' NOT NULL';
    }
    else {
      $sql .= ' NULL';
    }
  }

  if (!empty($spec['auto_increment'])) {
    $sql .= ' auto_increment';
  }

  // $spec['default'] can be NULL, so we explicitly check for the key here.
  if (array_key_exists('default', $spec)) {
    if (is_string($spec['default'])) {
      $spec['default'] = "'" . $spec['default'] . "'";
    }
    elseif (!isset($spec['default'])) {
      $spec['default'] = 'NULL';
    }
    $sql .= ' DEFAULT ' . $spec['default'];
  }

  if (empty($spec['not null']) && !isset($spec['default'])) {
    $sql .= ' DEFAULT NULL';
  }

  // Add column comment.
  if (!empty($spec['description'])) {
    $sql .= ' COMMENT ' . $this->prepareComment($spec['description'], self::COMMENT_MAX_COLUMN);
  }

  return $sql;
}