pgsqlschema.php 14.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Database schema utilities
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Database
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2009 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

/**
 * Class representing the database schema
 *
 * A class representing the database schema. Can be used to
 * manipulate the schema -- especially for plugins and upgrade
 * utilities.
 *
 * @category Database
 * @package  StatusNet
 * @author   Evan Prodromou <evan@status.net>
44
 * @author   Brenda Wallace <shiny@cpan.org>
45
 * @author   Brion Vibber <brion@status.net>
46 47 48 49 50 51 52 53
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */

class PgsqlSchema extends Schema
{

    /**
54
     * Returns a table definition array for the table
55 56 57 58
     * in the schema with the given name.
     *
     * Throws an exception if the table is not found.
     *
59
     * @param string $table Name of the table to get
60
     *
61
     * @return array tabledef for that table.
62 63
     */

64
    public function getTableDef($table)
65
    {
66 67
        $def = array();
        $hasKeys = false;
68

69 70 71 72
        // Pull column data from INFORMATION_SCHEMA
        $columns = $this->fetchMetaInfo($table, 'columns', 'ordinal_position');
        if (count($columns) == 0) {
            throw new SchemaTableMissingException("No such table: $table");
73 74
        }

75 76 77
        // We'll need to match up fields by ordinal reference
        $orderedFields = array();

78
        foreach ($columns as $row) {
79

80
            $name = $row['column_name'];
81 82
            $orderedFields[$row['ordinal_position']] = $name;

83
            $field = array();
Brion Vibber's avatar
Brion Vibber committed
84
            $field['type'] = $row['udt_name'];
85

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
            if ($type == 'char' || $type == 'varchar') {
                if ($row['character_maximum_length'] !== null) {
                    $field['length'] = intval($row['character_maximum_length']);
                }
            }
            if ($type == 'numeric') {
                // Other int types may report these values, but they're irrelevant.
                // Just ignore them!
                if ($row['numeric_precision'] !== null) {
                    $field['precision'] = intval($row['numeric_precision']);
                }
                if ($row['numeric_scale'] !== null) {
                    $field['scale'] = intval($row['numeric_scale']);
                }
            }
            if ($row['is_nullable'] == 'NO') {
                $field['not null'] = true;
            }
            if ($row['column_default'] !== null) {
                $field['default'] = $row['column_default'];
                if ($this->isNumericType($type)) {
                    $field['default'] = intval($field['default']);
                }
            }
110

111 112
            $def['fields'][$name] = $field;
        }
113

114
        // Pulling index info from pg_class & pg_index
115 116
        // This can give us primary & unique key info, but not foreign key constraints
        // so we exclude them and pick them up later.
117 118 119 120 121
        $indexInfo = $this->getIndexInfo($table);
        foreach ($indexInfo as $row) {
            $keyName = $row['key_name'];

            // Dig the column references out!
122 123 124 125
            //
            // These are inconvenient arrays with partial references to the
            // pg_att table, but since we've already fetched up the column
            // info on the current table, we can look those up locally.
126 127 128 129 130 131 132 133 134 135
            $cols = array();
            $colPositions = explode(' ', $row['indkey']);
            foreach ($colPositions as $ord) {
                if ($ord == 0) {
                    $cols[] = 'FUNCTION'; // @fixme
                } else {
                    $cols[] = $orderedFields[$ord];
                }
            }

136
            $def['indexes'][$keyName] = $cols;
137 138
        }

139 140
        // Pull constraint data from INFORMATION_SCHEMA:
        // Primary key, unique keys, foreign keys
141 142 143 144 145 146 147 148
        $keyColumns = $this->fetchMetaInfo($table, 'key_column_usage', 'constraint_name,ordinal_position');
        $keys = array();

        foreach ($keyColumns as $row) {
            $keyName = $row['constraint_name'];
            $keyCol = $row['column_name'];
            if (!isset($keys[$keyName])) {
                $keys[$keyName] = array();
149
            }
150 151
            $keys[$keyName][] = $keyCol;
        }
152

153
        foreach ($keys as $keyName => $cols) {
154
            // name hack -- is this reliable?
155
            if ($keyName == "{$table}_pkey") {
156
                $def['primary key'] = $cols;
157
            } else if (preg_match("/^{$table}_(.*)_fkey$/", $keyName, $matches)) {
158 159 160
                $fkey = $this->getForeignKeyInfo($table, $keyName);
                $colMap = array_combine($cols, $fkey['col_names']);
                $def['foreign keys'][$keyName] = array($fkey['table_name'], $colMap);
161
            } else {
162
                $def['unique keys'][$keyName] = $cols;
163
            }
164 165 166
        }
        return $def;
    }
167

168 169 170 171 172 173 174 175 176 177 178 179 180
    /**
     * Pull some INFORMATION.SCHEMA data for the given table.
     *
     * @param string $table
     * @return array of arrays
     */
    function fetchMetaInfo($table, $infoTable, $orderBy=null)
    {
        $query = "SELECT * FROM information_schema.%s " .
                 "WHERE table_name='%s'";
        $sql = sprintf($query, $infoTable, $table);
        if ($orderBy) {
            $sql .= ' ORDER BY ' . $orderBy;
181
        }
182
        return $this->fetchQueryData($sql);
183 184 185
    }

    /**
186 187 188 189 190 191 192 193 194 195
     * Pull some PG-specific index info
     * @param string $table
     * @return array of arrays
     */
    function getIndexInfo($table)
    {
        $query = 'SELECT ' .
                 '(SELECT relname FROM pg_class WHERE oid=indexrelid) AS key_name, ' .
                 '* FROM pg_index ' .
                 'WHERE indrelid=(SELECT oid FROM pg_class WHERE relname=\'%s\') ' .
196
                 'AND indisprimary=\'f\' AND indisunique=\'f\' ' .
197 198 199 200 201
                 'ORDER BY indrelid, indexrelid';
        $sql = sprintf($query, $table);
        return $this->fetchQueryData($sql);
    }

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
    /**
     * Column names from the foreign table can be resolved with a call to getTableColumnNames()
     * @param <type> $table
     * @return array array of rows with keys: fkey_name, table_name, table_id, col_names (array of strings)
     */
    function getForeignKeyInfo($table, $constraint_name)
    {
        // In a sane world, it'd be easier to query the column names directly.
        // But it's pretty hard to work with arrays such as col_indexes in direct SQL here.
        $query = 'SELECT ' .
                 '(SELECT relname FROM pg_class WHERE oid=confrelid) AS table_name, ' .
                 'confrelid AS table_id, ' .
                 '(SELECT indkey FROM pg_index WHERE indexrelid=conindid) AS col_indexes ' .
                 'FROM pg_constraint ' .
                 'WHERE conrelid=(SELECT oid FROM pg_class WHERE relname=\'%s\') ' .
                 'AND conname=\'%s\' ' .
                 'AND contype=\'f\'';
        $sql = sprintf($query, $table, $constraint_name);
        $data = $this->fetchQueryData($sql);
        if (count($data) < 1) {
            throw new Exception("Could not find foreign key " . $constraint_name . " on table " . $table);
        }

        $row = $data[0];
        return array(
            'table_name' => $row['table_name'],
            'col_names' => $this->getTableColumnNames($row['table_id'], $row['col_indexes'])
        );
    }

    /**
     *
     * @param int $table_id
     * @param array $col_indexes
     * @return array of strings
     */
    function getTableColumnNames($table_id, $col_indexes)
    {
        $indexes = array_map('intval', explode(' ', $col_indexes));
        $query = 'SELECT attnum AS col_index, attname AS col_name ' .
                 'FROM pg_attribute where attrelid=%d ' .
                 'AND attnum IN (%s)';
        $sql = sprintf($query, $table_id, implode(',', $indexes));
        $data = $this->fetchQueryData($sql);

        $byId = array();
        foreach ($data as $row) {
            $byId[$row['col_index']] = $row['col_name'];
        }

        $out = array();
        foreach ($indexes as $id) {
            $out[] = $byId[$id];
        }
        return $out;
    }

259 260 261 262 263 264 265 266
    /**
     * Translate the (mostly) mysql-ish column types into somethings more standard
     * @param string column type
     *
     * @return string postgres happy column type
     */
    private function _columnTypeTranslation($type) {
      $map = array(
267
      'datetime' => 'timestamp',
268 269 270 271 272 273 274
      );
      if(!empty($map[$type])) {
        return $map[$type];
      }
      return $type;
    }

275
    /**
276 277
     * Return the proper SQL for creating or
     * altering a column.
278
     *
279 280
     * Appropriate for use in CREATE TABLE or
     * ALTER TABLE statements.
281
     *
282
     * @param array $cd column to create
283
     *
284
     * @return string correct SQL for that column
285 286
     */

287
    function columnSql(array $cd)
288
    {
289
        $line = array();
290
        $line[] = parent::columnSql($cd);
291

292
        /*
293 294 295
        if ($table['foreign keys'][$name]) {
            foreach ($table['foreign keys'][$name] as $foreignTable => $foreignColumn) {
                $line[] = 'references';
296 297
                $line[] = $this->quoteIdentifier($foreignTable);
                $line[] = '(' . $this->quoteIdentifier($foreignColumn) . ')';
298 299
            }
        }
300
        */
301

302
        return implode(' ', $line);
303 304
    }

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
    /**
     * Append phrase(s) to an array of partial ALTER TABLE chunks in order
     * to alter the given column from its old state to a new one.
     *
     * @param array $phrase
     * @param string $columnName
     * @param array $old previous column definition as found in DB
     * @param array $cd current column definition
     */
    function appendAlterModifyColumn(array &$phrase, $columnName, array $old, array $cd)
    {
        $prefix = 'ALTER COLUMN ' . $this->quoteIdentifier($columnName) . ' ';

        $oldType = $this->mapType($old);
        $newType = $this->mapType($cd);
        if ($oldType != $newType) {
Brion Vibber's avatar
Brion Vibber committed
321
            $phrase[] = $prefix . 'TYPE ' . $newType;
322 323 324
        }

        if (!empty($old['not null']) && empty($cd['not null'])) {
Brion Vibber's avatar
Brion Vibber committed
325
            $phrase[] = $prefix . 'DROP NOT NULL';
326
        } else if (empty($old['not null']) && !empty($cd['not null'])) {
Brion Vibber's avatar
Brion Vibber committed
327
            $phrase[] = $prefix . 'SET NOT NULL';
328 329 330
        }

        if (isset($old['default']) && !isset($cd['default'])) {
Brion Vibber's avatar
Brion Vibber committed
331
            $phrase[] = $prefix . 'DROP DEFAULT';
332
        } else if (!isset($old['default']) && isset($cd['default'])) {
Brion Vibber's avatar
Brion Vibber committed
333
            $phrase[] = $prefix . 'SET DEFAULT ' . $this->quoteDefaultValue($cd);
334 335 336
        }
    }

Brion Vibber's avatar
Brion Vibber committed
337 338 339 340 341 342 343 344 345 346 347 348 349 350
    /**
     * Append an SQL statement to drop an index from a table.
     * Note that in PostgreSQL, index names are DB-unique.
     *
     * @param array $statements
     * @param string $table
     * @param string $name
     * @param array $def
     */
    function appendDropIndex(array &$statements, $table, $name)
    {
        $statements[] = "DROP INDEX $name";
    }

351 352 353 354 355 356 357 358
    /**
     * Quote a db/table/column identifier if necessary.
     *
     * @param string $name
     * @return string
     */
    function quoteIdentifier($name)
    {
Brion Vibber's avatar
Brion Vibber committed
359
        return $this->conn->quoteIdentifier($name);
360 361
    }

362
    function mapType($column)
363
    {
364 365 366 367 368 369 370 371
        $map = array('serial' => 'bigserial', // FIXME: creates the wrong name for the sequence for some internal sequence-lookup function, so better fix this to do the real 'create sequence' dance.
                     'numeric' => 'decimal',
                     'datetime' => 'timestamp',
                     'blob' => 'bytea');

        $type = $column['type'];
        if (isset($map[$type])) {
            $type = $map[$type];
372 373
        }

374 375 376 377 378 379 380 381
        if ($type == 'int') {
            if (!empty($column['size'])) {
                $size = $column['size'];
                if ($size == 'small') {
                    return 'int2';
                } else if ($size == 'big') {
                    return 'int8';
                }
382
            }
383
            return 'int4';
384 385
        }

386 387 388 389 390 391 392 393 394
        return $type;
    }

    // @fixme need name... :P
    function typeAndSize($column)
    {
        if ($column['type'] == 'enum') {
            $vals = array_map(array($this, 'quote'), $column['enum']);
            return "text check ($name in " . implode(',', $vals) . ')';
395
        } else {
396
            return parent::typeAndSize($column);
397 398
        }
    }
399

400 401 402 403 404 405 406 407 408 409 410
    /**
     * Filter the given table definition array to match features available
     * in this database.
     *
     * This lets us strip out unsupported things like comments, foreign keys,
     * or type variants that we wouldn't get back from getTableDef().
     *
     * @param array $tableDef
     */
    function filterDef(array $tableDef)
    {
Brion Vibber's avatar
Brion Vibber committed
411
        foreach ($tableDef['fields'] as $name => &$col) {
412 413 414
            // No convenient support for field descriptions
            unset($col['description']);

415
            /*
416 417 418 419 420 421
            if (isset($col['size'])) {
                // Don't distinguish between tinyint and int.
                if ($col['size'] == 'tiny' && $col['type'] == 'int') {
                    unset($col['size']);
                }
            }
422 423 424
             */
            $col['type'] = $this->mapType($col);
            unset($col['size']);
425
        }
426 427 428 429 430 431 432 433
        if (!empty($tableDef['primary key'])) {
            $tableDef['primary key'] = $this->filterKeyDef($tableDef['primary key']);
        }
        if (!empty($tableDef['unique keys'])) {
            foreach ($tableDef['unique keys'] as $i => $def) {
                $tableDef['unique keys'][$i] = $this->filterKeyDef($def);
            }
        }
434 435 436
        return $tableDef;
    }

437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
    /**
     * Filter the given key/index definition to match features available
     * in this database.
     *
     * @param array $def
     * @return array
     */
    function filterKeyDef(array $def)
    {
        // PostgreSQL doesn't like prefix lengths specified on keys...?
        foreach ($def as $i => $item)
        {
            if (is_array($item)) {
                $def[$i] = $item[0];
            }
        }
        return $def;
    }
455
}