You are here

protected function Schema::createTableSql in Drupal 9

Same name in this branch
  1. 9 core/lib/Drupal/Core/Database/Driver/sqlite/Schema.php \Drupal\Core\Database\Driver\sqlite\Schema::createTableSql()
  2. 9 core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php \Drupal\Core\Database\Driver\pgsql\Schema::createTableSql()
  3. 9 core/lib/Drupal/Core/Database/Driver/mysql/Schema.php \Drupal\Core\Database\Driver\mysql\Schema::createTableSql()
Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php \Drupal\Core\Database\Driver\pgsql\Schema::createTableSql()

Generate SQL to create a new table from a Drupal schema definition.

Parameters

string $name: The name of the table to create.

array $table: A Schema API table definition array.

Return value

array An array of SQL statements to create the table.

File

core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php, line 284

Class

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

Namespace

Drupal\Core\Database\Driver\pgsql

Code

protected function createTableSql($name, $table) {
  $sql_fields = [];
  foreach ($table['fields'] as $field_name => $field) {
    $sql_fields[] = $this
      ->createFieldSql($field_name, $this
      ->processField($field));
  }
  $sql_keys = [];
  if (!empty($table['primary key']) && is_array($table['primary key'])) {
    $this
      ->ensureNotNullPrimaryKey($table['primary key'], $table['fields']);
    $sql_keys[] = 'CONSTRAINT ' . $this
      ->ensureIdentifiersLength($name, '', 'pkey') . ' PRIMARY KEY (' . $this
      ->createPrimaryKeySql($table['primary key']) . ')';
  }
  if (isset($table['unique keys']) && is_array($table['unique keys'])) {
    foreach ($table['unique keys'] as $key_name => $key) {
      $sql_keys[] = 'CONSTRAINT ' . $this
        ->ensureIdentifiersLength($name, $key_name, 'key') . ' UNIQUE (' . implode(', ', $key) . ')';
    }
  }
  $sql = "CREATE TABLE {" . $name . "} (\n\t";
  $sql .= implode(",\n\t", $sql_fields);
  if (count($sql_keys) > 0) {
    $sql .= ",\n\t";
  }
  $sql .= implode(",\n\t", $sql_keys);
  $sql .= "\n)";
  $statements[] = $sql;
  if (isset($table['indexes']) && is_array($table['indexes'])) {
    foreach ($table['indexes'] as $key_name => $key) {
      $statements[] = $this
        ->_createIndexSql($name, $key_name, $key);
    }
  }

  // Add table comment.
  if (!empty($table['description'])) {
    $statements[] = 'COMMENT ON TABLE {' . $name . '} IS ' . $this
      ->prepareComment($table['description']);
  }

  // Add column comments.
  foreach ($table['fields'] as $field_name => $field) {
    if (!empty($field['description'])) {
      $statements[] = 'COMMENT ON COLUMN {' . $name . '}.' . $field_name . ' IS ' . $this
        ->prepareComment($field['description']);
    }
  }
  return $statements;
}