Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
3.33% |
1 / 30 |
CRAP | |
2.88% |
9 / 313 |
| Schema | |
0.00% |
0 / 1 |
|
3.33% |
1 / 30 |
15853.82 | |
2.88% |
9 / 313 |
| ensureIdentifiersLength | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 9 |
|||
| queryTableInformation | |
0.00% |
0 / 1 |
90 | |
0.00% |
0 / 29 |
|||
| resetTableInformation | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 5 |
|||
| queryFieldInformation | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 14 |
|||
| createTableSql | |
0.00% |
0 / 1 |
210 | |
0.00% |
0 / 25 |
|||
| createFieldSql | |
0.00% |
0 / 1 |
132 | |
0.00% |
0 / 17 |
|||
| processField | |
0.00% |
0 / 1 |
90 | |
0.00% |
0 / 19 |
|||
| getFieldTypeMap | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| _createKeySql | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 6 |
|||
| createPrimaryKeySql | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 6 |
|||
| tableExists | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| renameTable | |
0.00% |
0 / 1 |
72 | |
0.00% |
0 / 25 |
|||
| dropTable | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 5 |
|||
| addField | |
0.00% |
0 / 1 |
90 | |
0.00% |
0 / 23 |
|||
| dropField | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 5 |
|||
| fieldSetDefault | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 5 |
|||
| fieldSetNoDefault | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 4 |
|||
| indexExists | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 3 |
|||
| constraintExists | |
100.00% |
1 / 1 |
2 | |
100.00% |
9 / 9 |
|||
| addPrimaryKey | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 7 |
|||
| dropPrimaryKey | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 5 |
|||
| addUniqueKey | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 7 |
|||
| dropUniqueKey | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 5 |
|||
| addIndex | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 7 |
|||
| dropIndex | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 5 |
|||
| changeField | |
0.00% |
0 / 1 |
462 | |
0.00% |
0 / 46 |
|||
| _createIndexSql | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 3 |
|||
| _createKeys | |
0.00% |
0 / 1 |
42 | |
0.00% |
0 / 9 |
|||
| getComment | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 4 |
|||
| hashBase64 | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| <?php | |
| /** | |
| * @file | |
| * Contains \Drupal\Core\Database\Driver\pgsql\Schema. | |
| */ | |
| namespace Drupal\Core\Database\Driver\pgsql; | |
| use Drupal\Component\Utility\Unicode; | |
| use Drupal\Core\Database\SchemaObjectExistsException; | |
| use Drupal\Core\Database\SchemaObjectDoesNotExistException; | |
| use Drupal\Core\Database\Schema as DatabaseSchema; | |
| /** | |
| * @addtogroup schemaapi | |
| * @{ | |
| */ | |
| /** | |
| * PostgreSQL implementation of \Drupal\Core\Database\Schema. | |
| */ | |
| class Schema extends DatabaseSchema { | |
| /** | |
| * A cache of information about blob columns and sequences of tables. | |
| * | |
| * This is collected by DatabaseConnection_pgsql->queryTableInformation(), | |
| * by introspecting the database. | |
| * | |
| * @see DatabaseConnection_pgsql->queryTableInformation() | |
| * @var array | |
| */ | |
| protected $tableInformation = array(); | |
| /** | |
| * The maximum allowed length for index, primary key and constraint names. | |
| * | |
| * Value will usually be set to a 63 chars limit but PostgreSQL allows | |
| * to higher this value before compiling, so we need to check for that. | |
| * | |
| * @var int | |
| */ | |
| protected $maxIdentifierLength; | |
| /** | |
| * Make sure to limit identifiers according to PostgreSQL compiled in length. | |
| * | |
| * PostgreSQL allows in standard configuration no longer identifiers than 63 | |
| * chars for table/relation names, indexes, primary keys, and constraints. So | |
| * we map all identifiers that are too long to drupal_base64hash_tag, where | |
| * tag is one of: | |
| * - idx for indexes | |
| * - key for constraints | |
| * - pkey for primary keys | |
| * | |
| * @param $identifiers | |
| * The arguments to build the identifier string | |
| * @return | |
| * The index/constraint/pkey identifier | |
| */ | |
| protected function ensureIdentifiersLength($identifier) { | |
| $args = func_get_args(); | |
| $info = $this->getPrefixInfo($identifier); | |
| $args[0] = $info['table']; | |
| $identifierName = implode('__', $args); | |
| // Retrieve the max identifier length which is usually 63 characters | |
| // but can be altered before PostgreSQL is compiled so we need to check. | |
| $this->maxIdentifierLength = $this->connection->query("SHOW max_identifier_length")->fetchField(); | |
| if (strlen($identifierName) > $this->maxIdentifierLength) { | |
| $saveIdentifier = '"drupal_' . $this->hashBase64($identifierName) . '_' . $args[2] . '"'; | |
| } | |
| else { | |
| $saveIdentifier = $identifierName; | |
| } | |
| return $saveIdentifier; | |
| } | |
| /** | |
| * Fetch the list of blobs and sequences used on a table. | |
| * | |
| * We introspect the database to collect the information required by insert | |
| * and update queries. | |
| * | |
| * @param $table_name | |
| * The non-prefixed name of the table. | |
| * @return | |
| * An object with two member variables: | |
| * - 'blob_fields' that lists all the blob fields in the table. | |
| * - 'sequences' that lists the sequences used in that table. | |
| */ | |
| public function queryTableInformation($table) { | |
| // Generate a key to reference this table's information on. | |
| $key = $this->connection->prefixTables('{' . $table . '}'); | |
| // Take into account that temporary tables are stored in a different schema. | |
| // \Drupal\Core\Database\Connection::generateTemporaryTableName() sets the | |
| // 'db_temporary_' prefix to all temporary tables. | |
| if (strpos($key, '.') === FALSE && strpos($table, 'db_temporary_') === FALSE) { | |
| $key = 'public.' . $key; | |
| } | |
| else { | |
| $schema = $this->connection->query('SELECT nspname FROM pg_namespace WHERE oid = pg_my_temp_schema()')->fetchField(); | |
| $key = $schema . '.' . $key; | |
| } | |
| if (!isset($this->tableInformation[$key])) { | |
| // Split the key into schema and table for querying. | |
| list($schema, $table_name) = explode('.', $key); | |
| $table_information = (object) array( | |
| 'blob_fields' => array(), | |
| 'sequences' => array(), | |
| ); | |
| // Don't use {} around information_schema.columns table. | |
| $this->connection->addSavepoint(); | |
| try { | |
| // Check if the table information exists in the PostgreSQL metadata. | |
| $table_information_exists = (bool) $this->connection->query("SELECT 1 FROM pg_class WHERE relname = :table", array(':table' => $table_name))->fetchField(); | |
| // If the table information does not yet exist in the PostgreSQL | |
| // metadata, then return the default table information here, so that it | |
| // will not be cached. | |
| if (!$table_information_exists) { | |
| $this->connection->releaseSavepoint(); | |
| return $table_information; | |
| } | |
| else { | |
| $result = $this->connection->query("SELECT column_name, data_type, column_default FROM information_schema.columns WHERE table_schema = :schema AND table_name = :table AND (data_type = 'bytea' OR (numeric_precision IS NOT NULL AND column_default LIKE :default))", array( | |
| ':schema' => $schema, | |
| ':table' => $table_name, | |
| ':default' => '%nextval%', | |
| )); | |
| } | |
| } | |
| catch (\Exception $e) { | |
| $this->connection->rollbackSavepoint(); | |
| throw $e; | |
| } | |
| $this->connection->releaseSavepoint(); | |
| foreach ($result as $column) { | |
| if ($column->data_type == 'bytea') { | |
| $table_information->blob_fields[$column->column_name] = TRUE; | |
| } | |
| elseif (preg_match("/nextval\('([^']+)'/", $column->column_default, $matches)) { | |
| // We must know of any sequences in the table structure to help us | |
| // return the last insert id. If there is more than 1 sequences the | |
| // first one (index 0 of the sequences array) will be used. | |
| $table_information->sequences[] = $matches[1]; | |
| $table_information->serial_fields[] = $column->column_name; | |
| } | |
| } | |
| $this->tableInformation[$key] = $table_information; | |
| } | |
| return $this->tableInformation[$key]; | |
| } | |
| /** | |
| * Resets information about table blobs, sequences and serial fields. | |
| * | |
| * @param $table | |
| * The non-prefixed name of the table. | |
| */ | |
| protected function resetTableInformation($table) { | |
| $key = $this->connection->prefixTables('{' . $table . '}'); | |
| if (strpos($key, '.') === FALSE) { | |
| $key = 'public.' . $key; | |
| } | |
| unset($this->tableInformation[$key]); | |
| } | |
| /** | |
| * Fetch the list of CHECK constraints used on a field. | |
| * | |
| * We introspect the database to collect the information required by field | |
| * alteration. | |
| * | |
| * @param $table | |
| * The non-prefixed name of the table. | |
| * @param $field | |
| * The name of the field. | |
| * @return | |
| * An array of all the checks for the field. | |
| */ | |
| public function queryFieldInformation($table, $field) { | |
| $prefixInfo = $this->getPrefixInfo($table, TRUE); | |
| // Split the key into schema and table for querying. | |
| $schema = $prefixInfo['schema']; | |
| $table_name = $prefixInfo['table']; | |
| $this->connection->addSavepoint(); | |
| try { | |
| $checks = $this->connection->query("SELECT conname FROM pg_class cl INNER JOIN pg_constraint co ON co.conrelid = cl.oid INNER JOIN pg_attribute attr ON attr.attrelid = cl.oid AND attr.attnum = ANY (co.conkey) INNER JOIN pg_namespace ns ON cl.relnamespace = ns.oid WHERE co.contype = 'c' AND ns.nspname = :schema AND cl.relname = :table AND attr.attname = :column", array( | |
| ':schema' => $schema, | |
| ':table' => $table_name, | |
| ':column' => $field, | |
| )); | |
| } | |
| catch (\Exception $e) { | |
| $this->connection->rollbackSavepoint(); | |
| throw $e; | |
| } | |
| $this->connection->releaseSavepoint(); | |
| $field_information = $checks->fetchCol(); | |
| return $field_information; | |
| } | |
| /** | |
| * Generate SQL to create a new table from a Drupal schema definition. | |
| * | |
| * @param $name | |
| * The name of the table to create. | |
| * @param $table | |
| * A Schema API table definition array. | |
| * @return | |
| * An array of SQL statements to create the table. | |
| */ | |
| protected function createTableSql($name, $table) { | |
| $sql_fields = array(); | |
| foreach ($table['fields'] as $field_name => $field) { | |
| $sql_fields[] = $this->createFieldSql($field_name, $this->processField($field)); | |
| } | |
| $sql_keys = array(); | |
| if (isset($table['primary key']) && is_array($table['primary key'])) { | |
| $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; | |
| } | |
| /** | |
| * Create an 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 _db_process_field(). | |
| * | |
| * @param $name | |
| * Name of the field. | |
| * @param $spec | |
| * The field specification, as per the schema data structure format. | |
| */ | |
| protected function createFieldSql($name, $spec) { | |
| // The PostgreSQL server converts names into lowercase, unless quoted. | |
| $sql = '"' . $name . '" ' . $spec['pgsql_type']; | |
| if (isset($spec['type']) && $spec['type'] == 'serial') { | |
| unset($spec['not null']); | |
| } | |
| if (in_array($spec['pgsql_type'], array('varchar', 'character')) && isset($spec['length'])) { | |
| $sql .= '(' . $spec['length'] . ')'; | |
| } | |
| elseif (isset($spec['precision']) && isset($spec['scale'])) { | |
| $sql .= '(' . $spec['precision'] . ', ' . $spec['scale'] . ')'; | |
| } | |
| if (!empty($spec['unsigned'])) { | |
| $sql .= " CHECK ($name >= 0)"; | |
| } | |
| if (isset($spec['not null'])) { | |
| if ($spec['not null']) { | |
| $sql .= ' NOT NULL'; | |
| } | |
| else { | |
| $sql .= ' NULL'; | |
| } | |
| } | |
| if (array_key_exists('default', $spec)) { | |
| $default = $this->escapeDefaultValue($spec['default']); | |
| $sql .= " default $default"; | |
| } | |
| return $sql; | |
| } | |
| /** | |
| * Set database-engine specific properties for a field. | |
| * | |
| * @param $field | |
| * A field description array, as specified in the schema documentation. | |
| */ | |
| protected function processField($field) { | |
| if (!isset($field['size'])) { | |
| $field['size'] = 'normal'; | |
| } | |
| // Set the correct database-engine specific datatype. | |
| // In case one is already provided, force it to lowercase. | |
| if (isset($field['pgsql_type'])) { | |
| $field['pgsql_type'] = Unicode::strtolower($field['pgsql_type']); | |
| } | |
| else { | |
| $map = $this->getFieldTypeMap(); | |
| $field['pgsql_type'] = $map[$field['type'] . ':' . $field['size']]; | |
| } | |
| if (!empty($field['unsigned'])) { | |
| // Unsigned datatypes are not supported in PostgreSQL 9.1. In MySQL, | |
| // they are used to ensure a positive number is inserted and it also | |
| // doubles the maximum integer size that can be stored in a field. | |
| // The PostgreSQL schema in Drupal creates a check constraint | |
| // to ensure that a value inserted is >= 0. To provide the extra | |
| // integer capacity, here, we bump up the column field size. | |
| if (!isset($map)) { | |
| $map = $this->getFieldTypeMap(); | |
| } | |
| switch ($field['pgsql_type']) { | |
| case 'smallint': | |
| $field['pgsql_type'] = $map['int:medium']; | |
| break; | |
| case 'int' : | |
| $field['pgsql_type'] = $map['int:big']; | |
| break; | |
| } | |
| } | |
| if (isset($field['type']) && $field['type'] == 'serial') { | |
| unset($field['not null']); | |
| } | |
| return $field; | |
| } | |
| /** | |
| * This maps a generic data type in combination with its data size | |
| * to the engine-specific data type. | |
| */ | |
| function getFieldTypeMap() { | |
| // Put :normal last so it gets preserved by array_flip. This makes | |
| // it much easier for modules (such as schema.module) to map | |
| // database types back into schema types. | |
| // $map does not use drupal_static as its value never changes. | |
| static $map = array( | |
| 'varchar_ascii:normal' => 'varchar', | |
| 'varchar:normal' => 'varchar', | |
| 'char:normal' => 'character', | |
| 'text:tiny' => 'text', | |
| 'text:small' => 'text', | |
| 'text:medium' => 'text', | |
| 'text:big' => 'text', | |
| 'text:normal' => 'text', | |
| 'int:tiny' => 'smallint', | |
| 'int:small' => 'smallint', | |
| 'int:medium' => 'int', | |
| 'int:big' => 'bigint', | |
| 'int:normal' => 'int', | |
| 'float:tiny' => 'real', | |
| 'float:small' => 'real', | |
| 'float:medium' => 'real', | |
| 'float:big' => 'double precision', | |
| 'float:normal' => 'real', | |
| 'numeric:normal' => 'numeric', | |
| 'blob:big' => 'bytea', | |
| 'blob:normal' => 'bytea', | |
| 'serial:tiny' => 'serial', | |
| 'serial:small' => 'serial', | |
| 'serial:medium' => 'serial', | |
| 'serial:big' => 'bigserial', | |
| 'serial:normal' => 'serial', | |
| ); | |
| return $map; | |
| } | |
| protected function _createKeySql($fields) { | |
| $return = array(); | |
| foreach ($fields as $field) { | |
| if (is_array($field)) { | |
| $return[] = 'substr(' . $field[0] . ', 1, ' . $field[1] . ')'; | |
| } | |
| else { | |
| $return[] = '"' . $field . '"'; | |
| } | |
| } | |
| return implode(', ', $return); | |
| } | |
| /** | |
| * Create the SQL expression for primary keys. | |
| * | |
| * Postgresql does not support key length. It does support fillfactor, but | |
| * that requires a separate database lookup for each column in the key. The | |
| * key length defined in the schema is ignored. | |
| */ | |
| protected function createPrimaryKeySql($fields) { | |
| $return = array(); | |
| foreach ($fields as $field) { | |
| if (is_array($field)) { | |
| $return[] = '"' . $field[0] . '"'; | |
| } | |
| else { | |
| $return[] = '"' . $field . '"'; | |
| } | |
| } | |
| return implode(', ', $return); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function tableExists($table) { | |
| $prefixInfo = $this->getPrefixInfo($table, TRUE); | |
| return (bool) $this->connection->query("SELECT 1 FROM pg_tables WHERE schemaname = :schema AND tablename = :table", array(':schema' => $prefixInfo['schema'], ':table' => $prefixInfo['table']))->fetchField(); | |
| } | |
| function renameTable($table, $new_name) { | |
| if (!$this->tableExists($table)) { | |
| throw new SchemaObjectDoesNotExistException(t("Cannot rename @table to @table_new: table @table doesn't exist.", array('@table' => $table, '@table_new' => $new_name))); | |
| } | |
| if ($this->tableExists($new_name)) { | |
| throw new SchemaObjectExistsException(t("Cannot rename @table to @table_new: table @table_new already exists.", array('@table' => $table, '@table_new' => $new_name))); | |
| } | |
| // Get the schema and tablename for the old table. | |
| $old_full_name = $this->connection->prefixTables('{' . $table . '}'); | |
| list($old_schema, $old_table_name) = strpos($old_full_name, '.') ? explode('.', $old_full_name) : array('public', $old_full_name); | |
| // Index names and constraint names are global in PostgreSQL, so we need to | |
| // rename them when renaming the table. | |
| $indexes = $this->connection->query('SELECT indexname FROM pg_indexes WHERE schemaname = :schema AND tablename = :table', array(':schema' => $old_schema, ':table' => $old_table_name)); | |
| foreach ($indexes as $index) { | |
| // Get the index type by suffix, e.g. idx/key/pkey | |
| $index_type = substr($index->indexname, strrpos($index->indexname, '_') + 1); | |
| // If the index is already rewritten by ensureIdentifiersLength() to not | |
| // exceed the 63 chars limit of PostgreSQL, we need to take care of that. | |
| // Example (drupal_Gk7Su_T1jcBHVuvSPeP22_I3Ni4GrVEgTYlIYnBJkro_idx). | |
| if (strpos($index->indexname, 'drupal_') !== FALSE) { | |
| preg_match('/^drupal_(.*)_' . preg_quote($index_type) . '/', $index->indexname, $matches); | |
| $index_name = $matches[1]; | |
| } | |
| else { | |
| // Make sure to remove the suffix from index names, because | |
| // $this->ensureIdentifiersLength() will add the suffix again and thus | |
| // would result in a wrong index name. | |
| preg_match('/^' . preg_quote($old_full_name) . '__(.*)__' . preg_quote($index_type) . '/', $index->indexname, $matches); | |
| $index_name = $matches[1]; | |
| } | |
| $this->connection->query('ALTER INDEX "' . $index->indexname . '" RENAME TO ' . $this->ensureIdentifiersLength($new_name, $index_name, $index_type) . ''); | |
| } | |
| // Ensure the new table name does not include schema syntax. | |
| $prefixInfo = $this->getPrefixInfo($new_name); | |
| // Rename sequences if there's a serial fields. | |
| $info = $this->queryTableInformation($table); | |
| if (!empty($info->serial_fields)) { | |
| foreach ($info->serial_fields as $field) { | |
| $old_sequence = $this->prefixNonTable($table, $field, 'seq'); | |
| $new_sequence = $this->prefixNonTable($new_name, $field, 'seq'); | |
| $this->connection->query('ALTER SEQUENCE ' . $old_sequence . ' RENAME TO ' . $new_sequence); | |
| } | |
| } | |
| // Now rename the table. | |
| $this->connection->query('ALTER TABLE {' . $table . '} RENAME TO ' . $prefixInfo['table']); | |
| $this->resetTableInformation($table); | |
| } | |
| public function dropTable($table) { | |
| if (!$this->tableExists($table)) { | |
| return FALSE; | |
| } | |
| $this->connection->query('DROP TABLE {' . $table . '}'); | |
| $this->resetTableInformation($table); | |
| return TRUE; | |
| } | |
| public function addField($table, $field, $spec, $new_keys = array()) { | |
| if (!$this->tableExists($table)) { | |
| throw new SchemaObjectDoesNotExistException(t("Cannot add field @table.@field: table doesn't exist.", array('@field' => $field, '@table' => $table))); | |
| } | |
| if ($this->fieldExists($table, $field)) { | |
| throw new SchemaObjectExistsException(t("Cannot add field @table.@field: field already exists.", array('@field' => $field, '@table' => $table))); | |
| } | |
| $fixnull = FALSE; | |
| if (!empty($spec['not null']) && !isset($spec['default'])) { | |
| $fixnull = TRUE; | |
| $spec['not null'] = FALSE; | |
| } | |
| $query = 'ALTER TABLE {' . $table . '} ADD COLUMN '; | |
| $query .= $this->createFieldSql($field, $this->processField($spec)); | |
| $this->connection->query($query); | |
| if (isset($spec['initial'])) { | |
| $this->connection->update($table) | |
| ->fields(array($field => $spec['initial'])) | |
| ->execute(); | |
| } | |
| if ($fixnull) { | |
| $this->connection->query("ALTER TABLE {" . $table . "} ALTER $field SET NOT NULL"); | |
| } | |
| if (isset($new_keys)) { | |
| $this->_createKeys($table, $new_keys); | |
| } | |
| // Add column comment. | |
| if (!empty($spec['description'])) { | |
| $this->connection->query('COMMENT ON COLUMN {' . $table . '}.' . $field . ' IS ' . $this->prepareComment($spec['description'])); | |
| } | |
| $this->resetTableInformation($table); | |
| } | |
| public function dropField($table, $field) { | |
| if (!$this->fieldExists($table, $field)) { | |
| return FALSE; | |
| } | |
| $this->connection->query('ALTER TABLE {' . $table . '} DROP COLUMN "' . $field . '"'); | |
| $this->resetTableInformation($table); | |
| return TRUE; | |
| } | |
| public function fieldSetDefault($table, $field, $default) { | |
| if (!$this->fieldExists($table, $field)) { | |
| throw new SchemaObjectDoesNotExistException(t("Cannot set default value of field @table.@field: field doesn't exist.", array('@table' => $table, '@field' => $field))); | |
| } | |
| $default = $this->escapeDefaultValue($default); | |
| $this->connection->query('ALTER TABLE {' . $table . '} ALTER COLUMN "' . $field . '" SET DEFAULT ' . $default); | |
| } | |
| public function fieldSetNoDefault($table, $field) { | |
| if (!$this->fieldExists($table, $field)) { | |
| throw new SchemaObjectDoesNotExistException(t("Cannot remove default value of field @table.@field: field doesn't exist.", array('@table' => $table, '@field' => $field))); | |
| } | |
| $this->connection->query('ALTER TABLE {' . $table . '} ALTER COLUMN "' . $field . '" DROP DEFAULT'); | |
| } | |
| public function indexExists($table, $name) { | |
| // Details http://www.postgresql.org/docs/9.1/interactive/view-pg-indexes.html | |
| $index_name = $this->ensureIdentifiersLength($table, $name, 'idx'); | |
| // Remove leading and trailing quotes because the index name is in a WHERE | |
| // clause and not used as an identifier. | |
| $index_name = str_replace('"', '', $index_name); | |
| return (bool) $this->connection->query("SELECT 1 FROM pg_indexes WHERE indexname = '$index_name'")->fetchField(); | |
| } | |
| /** | |
| * Helper function: check if a constraint (PK, FK, UK) exists. | |
| * | |
| * @param string $table | |
| * The name of the table. | |
| * @param string $name | |
| * The name of the constraint (typically 'pkey' or '[constraint]__key'). | |
| * | |
| * @return bool | |
| * TRUE if the constraint exists, FALSE otherwise. | |
| */ | |
| public function constraintExists($table, $name) { | |
| // ::ensureIdentifiersLength() expects three parameters, although not | |
| // explicitly stated in its signature, thus we split our constraint name in | |
| // a proper name and a suffix. | |
| if ($name == 'pkey') { | |
| $suffix = $name; | |
| $name = ''; | |
| } | |
| else { | |
| $pos = strrpos($name, '__'); | |
| $suffix = substr($name, $pos + 2); | |
| $name = substr($name, 0, $pos); | |
| } | |
| $constraint_name = $this->ensureIdentifiersLength($table, $name, $suffix); | |
| // Remove leading and trailing quotes because the index name is in a WHERE | |
| // clause and not used as an identifier. | |
| $constraint_name = str_replace('"', '', $constraint_name); | |
| return (bool) $this->connection->query("SELECT 1 FROM pg_constraint WHERE conname = '$constraint_name'")->fetchField(); | |
| } | |
| public function addPrimaryKey($table, $fields) { | |
| if (!$this->tableExists($table)) { | |
| throw new SchemaObjectDoesNotExistException(t("Cannot add primary key to table @table: table doesn't exist.", array('@table' => $table))); | |
| } | |
| if ($this->constraintExists($table, 'pkey')) { | |
| throw new SchemaObjectExistsException(t("Cannot add primary key to table @table: primary key already exists.", array('@table' => $table))); | |
| } | |
| $this->connection->query('ALTER TABLE {' . $table . '} ADD CONSTRAINT ' . $this->ensureIdentifiersLength($table, '', 'pkey') . ' PRIMARY KEY (' . $this->createPrimaryKeySql($fields) . ')'); | |
| $this->resetTableInformation($table); | |
| } | |
| public function dropPrimaryKey($table) { | |
| if (!$this->constraintExists($table, 'pkey')) { | |
| return FALSE; | |
| } | |
| $this->connection->query('ALTER TABLE {' . $table . '} DROP CONSTRAINT ' . $this->ensureIdentifiersLength($table, '', 'pkey')); | |
| $this->resetTableInformation($table); | |
| return TRUE; | |
| } | |
| function addUniqueKey($table, $name, $fields) { | |
| if (!$this->tableExists($table)) { | |
| throw new SchemaObjectDoesNotExistException(t("Cannot add unique key @name to table @table: table doesn't exist.", array('@table' => $table, '@name' => $name))); | |
| } | |
| if ($this->constraintExists($table, $name . '__key')) { | |
| throw new SchemaObjectExistsException(t("Cannot add unique key @name to table @table: unique key already exists.", array('@table' => $table, '@name' => $name))); | |
| } | |
| $this->connection->query('ALTER TABLE {' . $table . '} ADD CONSTRAINT ' . $this->ensureIdentifiersLength($table, $name, 'key') . ' UNIQUE (' . implode(',', $fields) . ')'); | |
| $this->resetTableInformation($table); | |
| } | |
| public function dropUniqueKey($table, $name) { | |
| if (!$this->constraintExists($table, $name . '__key')) { | |
| return FALSE; | |
| } | |
| $this->connection->query('ALTER TABLE {' . $table . '} DROP CONSTRAINT ' . $this->ensureIdentifiersLength($table, $name, 'key')); | |
| $this->resetTableInformation($table); | |
| return TRUE; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function addIndex($table, $name, $fields, array $spec) { | |
| if (!$this->tableExists($table)) { | |
| throw new SchemaObjectDoesNotExistException(t("Cannot add index @name to table @table: table doesn't exist.", array('@table' => $table, '@name' => $name))); | |
| } | |
| if ($this->indexExists($table, $name)) { | |
| throw new SchemaObjectExistsException(t("Cannot add index @name to table @table: index already exists.", array('@table' => $table, '@name' => $name))); | |
| } | |
| $this->connection->query($this->_createIndexSql($table, $name, $fields)); | |
| $this->resetTableInformation($table); | |
| } | |
| public function dropIndex($table, $name) { | |
| if (!$this->indexExists($table, $name)) { | |
| return FALSE; | |
| } | |
| $this->connection->query('DROP INDEX ' . $this->ensureIdentifiersLength($table, $name, 'idx')); | |
| $this->resetTableInformation($table); | |
| return TRUE; | |
| } | |
| public function changeField($table, $field, $field_new, $spec, $new_keys = array()) { | |
| if (!$this->fieldExists($table, $field)) { | |
| throw new SchemaObjectDoesNotExistException(t("Cannot change the definition of field @table.@name: field doesn't exist.", array('@table' => $table, '@name' => $field))); | |
| } | |
| if (($field != $field_new) && $this->fieldExists($table, $field_new)) { | |
| throw new SchemaObjectExistsException(t("Cannot rename field @table.@name to @name_new: target field already exists.", array('@table' => $table, '@name' => $field, '@name_new' => $field_new))); | |
| } | |
| $spec = $this->processField($spec); | |
| // Type 'serial' is known to PostgreSQL, but only during table creation, | |
| // not when altering. Because of that, we create it here as an 'int'. After | |
| // we create it we manually re-apply the sequence. | |
| if (in_array($spec['pgsql_type'], array('serial', 'bigserial'))) { | |
| $field_def = 'int'; | |
| } | |
| else { | |
| $field_def = $spec['pgsql_type']; | |
| } | |
| if (in_array($spec['pgsql_type'], array('varchar', 'character', 'text')) && isset($spec['length'])) { | |
| $field_def .= '(' . $spec['length'] . ')'; | |
| } | |
| elseif (isset($spec['precision']) && isset($spec['scale'])) { | |
| $field_def .= '(' . $spec['precision'] . ', ' . $spec['scale'] . ')'; | |
| } | |
| // Remove old check constraints. | |
| $field_info = $this->queryFieldInformation($table, $field); | |
| foreach ($field_info as $check) { | |
| $this->connection->query('ALTER TABLE {' . $table . '} DROP CONSTRAINT "' . $check . '"'); | |
| } | |
| // Remove old default. | |
| $this->fieldSetNoDefault($table, $field); | |
| // Convert field type. | |
| // Usually, we do this via a simple typecast 'USING fieldname::type'. But | |
| // the typecast does not work for conversions to bytea. | |
| // @see http://www.postgresql.org/docs/current/static/datatype-binary.html | |
| $table_information = $this->queryTableInformation($table); | |
| $is_bytea = !empty($table_information->blob_fields[$field]); | |
| if ($spec['pgsql_type'] != 'bytea') { | |
| if ($is_bytea) { | |
| $this->connection->query('ALTER TABLE {' . $table . '} ALTER "' . $field . '" TYPE ' . $field_def . ' USING convert_from("' . $field . '"' . ", 'UTF8')"); | |
| } | |
| else { | |
| $this->connection->query('ALTER TABLE {' . $table . '} ALTER "' . $field . '" TYPE ' . $field_def . ' USING "' . $field . '"::' . $field_def); | |
| } | |
| } | |
| else { | |
| // Do not attempt to convert a field that is bytea already. | |
| if (!$is_bytea) { | |
| // Convert to a bytea type by using the SQL replace() function to | |
| // convert any single backslashes in the field content to double | |
| // backslashes ('\' to '\\'). | |
| $this->connection->query('ALTER TABLE {' . $table . '} ALTER "' . $field . '" TYPE ' . $field_def . ' USING decode(replace("' . $field . '"' . ", E'\\\\', E'\\\\\\\\'), 'escape');"); | |
| } | |
| } | |
| if (isset($spec['not null'])) { | |
| if ($spec['not null']) { | |
| $nullaction = 'SET NOT NULL'; | |
| } | |
| else { | |
| $nullaction = 'DROP NOT NULL'; | |
| } | |
| $this->connection->query('ALTER TABLE {' . $table . '} ALTER "' . $field . '" ' . $nullaction); | |
| } | |
| if (in_array($spec['pgsql_type'], array('serial', 'bigserial'))) { | |
| // Type "serial" is known to PostgreSQL, but *only* during table creation, | |
| // not when altering. Because of that, the sequence needs to be created | |
| // and initialized by hand. | |
| $seq = "{" . $table . "}_" . $field_new . "_seq"; | |
| $this->connection->query("CREATE SEQUENCE " . $seq); | |
| // Set sequence to maximal field value to not conflict with existing | |
| // entries. | |
| $this->connection->query("SELECT setval('" . $seq . "', MAX(\"" . $field . '")) FROM {' . $table . "}"); | |
| $this->connection->query('ALTER TABLE {' . $table . '} ALTER ' . $field . ' SET DEFAULT nextval(' . $this->connection->quote($seq) . ')'); | |
| } | |
| // Rename the column if necessary. | |
| if ($field != $field_new) { | |
| $this->connection->query('ALTER TABLE {' . $table . '} RENAME "' . $field . '" TO "' . $field_new . '"'); | |
| } | |
| // Add unsigned check if necessary. | |
| if (!empty($spec['unsigned'])) { | |
| $this->connection->query('ALTER TABLE {' . $table . '} ADD CHECK ("' . $field_new . '" >= 0)'); | |
| } | |
| // Add default if necessary. | |
| if (isset($spec['default'])) { | |
| $this->fieldSetDefault($table, $field_new, $spec['default']); | |
| } | |
| // Change description if necessary. | |
| if (!empty($spec['description'])) { | |
| $this->connection->query('COMMENT ON COLUMN {' . $table . '}."' . $field_new . '" IS ' . $this->prepareComment($spec['description'])); | |
| } | |
| if (isset($new_keys)) { | |
| $this->_createKeys($table, $new_keys); | |
| } | |
| $this->resetTableInformation($table); | |
| } | |
| protected function _createIndexSql($table, $name, $fields) { | |
| $query = 'CREATE INDEX ' . $this->ensureIdentifiersLength($table, $name, 'idx') . ' ON {' . $table . '} ('; | |
| $query .= $this->_createKeySql($fields) . ')'; | |
| return $query; | |
| } | |
| protected function _createKeys($table, $new_keys) { | |
| if (isset($new_keys['primary key'])) { | |
| $this->addPrimaryKey($table, $new_keys['primary key']); | |
| } | |
| if (isset($new_keys['unique keys'])) { | |
| foreach ($new_keys['unique keys'] as $name => $fields) { | |
| $this->addUniqueKey($table, $name, $fields); | |
| } | |
| } | |
| if (isset($new_keys['indexes'])) { | |
| foreach ($new_keys['indexes'] as $name => $fields) { | |
| // Even though $new_keys is not a full schema it still has 'indexes' and | |
| // so is a partial schema. Technically addIndex() doesn't do anything | |
| // with it so passing an empty array would work as well. | |
| $this->addIndex($table, $name, $fields, $new_keys); | |
| } | |
| } | |
| } | |
| /** | |
| * Retrieve a table or column comment. | |
| */ | |
| public function getComment($table, $column = NULL) { | |
| $info = $this->getPrefixInfo($table); | |
| // Don't use {} around pg_class, pg_attribute tables. | |
| if (isset($column)) { | |
| return $this->connection->query('SELECT col_description(oid, attnum) FROM pg_class, pg_attribute WHERE attrelid = oid AND relname = ? AND attname = ?', array($info['table'], $column))->fetchField(); | |
| } | |
| else { | |
| return $this->connection->query('SELECT obj_description(oid, ?) FROM pg_class WHERE relname = ?', array('pg_class', $info['table']))->fetchField(); | |
| } | |
| } | |
| /** | |
| * Calculates a base-64 encoded, PostgreSQL-safe sha-256 hash per PostgreSQL | |
| * documentation: 4.1. Lexical Structure. | |
| * | |
| * @param $data | |
| * String to be hashed. | |
| * @return string | |
| * A base-64 encoded sha-256 hash, with + and / replaced with _ and any = | |
| * padding characters removed. | |
| */ | |
| protected function hashBase64($data) { | |
| $hash = base64_encode(hash('sha256', $data, TRUE)); | |
| // Modify the hash so it's safe to use in PostgreSQL identifiers. | |
| return strtr($hash, array('+' => '_', '/' => '_', '=' => '')); | |
| } | |
| } | |
| /** | |
| * @} End of "addtogroup schemaapi". | |
| */ |