3 * StatusNet, the distributed open-source microblogging tool
5 * Database schema utilities
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @copyright 2009 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
35 * Class representing the database schema
37 * A class representing the database schema. Can be used to
38 * manipulate the schema -- especially for plugins and upgrade
43 * @author Evan Prodromou <evan@status.net>
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45 * @link http://status.net/
48 class PgsqlSchema extends Schema
52 * Returns a TableDef object for the table
53 * in the schema with the given name.
55 * Throws an exception if the table is not found.
57 * @param string $name Name of the table to get
59 * @return TableDef tabledef for that table.
62 public function getTableDef($name)
64 $res = $this->conn->query("SELECT *, column_default as default, is_nullable as Null,
65 udt_name as Type, column_name AS Field from INFORMATION_SCHEMA.COLUMNS where table_name = '$name'");
67 if (PEAR::isError($res)) {
68 throw new Exception($res->getMessage());
74 $td->columns = array();
76 if ($res->numRows() == 0 ) {
77 throw new Exception('no such table'); //pretend to be the msyql error. yeah, this sucks.
81 while ($res->fetchInto($row, DB_FETCHMODE_ASSOC)) {
83 $cd = new ColumnDef();
85 $cd->name = $row['field'];
87 $packed = $row['type'];
89 if (preg_match('/^(\w+)\((\d+)\)$/', $packed, $match)) {
90 $cd->type = $match[1];
91 $cd->size = $match[2];
96 $cd->nullable = ($row['null'] == 'YES') ? true : false;
97 $cd->key = $row['Key'];
98 $cd->default = $row['default'];
99 $cd->extra = $row['Extra'];
101 $td->columns[] = $cd;
107 * Gets a ColumnDef object for a single column.
109 * Throws an exception if the table is not found.
111 * @param string $table name of the table
112 * @param string $column name of the column
114 * @return ColumnDef definition of the column or null
118 public function getColumnDef($table, $column)
120 $td = $this->getTableDef($table);
122 foreach ($td->columns as $cd) {
123 if ($cd->name == $column) {
132 * Creates a table with the given names and columns.
134 * @param string $name Name of the table
135 * @param array $columns Array of ColumnDef objects
138 * @return boolean success flag
141 public function createTable($name, $columns)
147 $sql = "CREATE TABLE $name (\n";
149 for ($i = 0; $i < count($columns); $i++) {
157 $sql .= $this->_columnSql($cd);
161 $uniques[] = $cd->name;
164 $primary[] = $cd->name;
167 $indices[] = $cd->name;
172 if (count($primary) > 0) { // it really should be...
173 $sql .= ",\n primary key (" . implode(',', $primary) . ")";
178 foreach ($indices as $i) {
179 $sql .= ",\nindex {$name}_{$i}_idx ($i)";
185 foreach ($uniques as $u) {
186 $sql .= "\n CREATE index {$name}_{$u}_idx ON {$name} ($u); ";
188 $res = $this->conn->query($sql);
190 if (PEAR::isError($res)) {
191 throw new Exception($res->getMessage());
198 * Drops a table from the schema
200 * Throws an exception if the table is not found.
202 * @param string $name Name of the table to drop
204 * @return boolean success flag
207 public function dropTable($name)
209 $res = $this->conn->query("DROP TABLE $name");
211 if (PEAR::isError($res)) {
212 throw new Exception($res->getMessage());
219 * Translate the (mostly) mysql-ish column types into somethings more standard
220 * @param string column type
222 * @return string postgres happy column type
224 private function _columnTypeTranslation($type) {
226 'datetime' => 'timestamp'
228 if(!empty($map[$type])) {
235 * Adds an index to a table.
237 * If no name is provided, a name will be made up based
238 * on the table name and column names.
240 * Throws an exception on database error, esp. if the table
243 * @param string $table Name of the table
244 * @param array $columnNames Name of columns to index
245 * @param string $name (Optional) name of the index
247 * @return boolean success flag
250 public function createIndex($table, $columnNames, $name=null)
252 if (!is_array($columnNames)) {
253 $columnNames = array($columnNames);
257 $name = "$table_".implode("_", $columnNames)."_idx";
260 $res = $this->conn->query("ALTER TABLE $table ".
262 implode(",", $columnNames).")");
264 if (PEAR::isError($res)) {
265 throw new Exception($res->getMessage());
272 * Drops a named index from a table.
274 * @param string $table name of the table the index is on.
275 * @param string $name name of the index
277 * @return boolean success flag
280 public function dropIndex($table, $name)
282 $res = $this->conn->query("ALTER TABLE $table DROP INDEX $name");
284 if (PEAR::isError($res)) {
285 throw new Exception($res->getMessage());
292 * Adds a column to a table
294 * @param string $table name of the table
295 * @param ColumnDef $columndef Definition of the new
298 * @return boolean success flag
301 public function addColumn($table, $columndef)
303 $sql = "ALTER TABLE $table ADD COLUMN " . $this->_columnSql($columndef);
305 $res = $this->conn->query($sql);
307 if (PEAR::isError($res)) {
308 throw new Exception($res->getMessage());
315 * Modifies a column in the schema.
317 * The name must match an existing column and table.
319 * @param string $table name of the table
320 * @param ColumnDef $columndef new definition of the column.
322 * @return boolean success flag
325 public function modifyColumn($table, $columndef)
327 $sql = "ALTER TABLE $table MODIFY COLUMN " .
328 $this->_columnSql($columndef);
330 $res = $this->conn->query($sql);
332 if (PEAR::isError($res)) {
333 throw new Exception($res->getMessage());
340 * Drops a column from a table
342 * The name must match an existing column.
344 * @param string $table name of the table
345 * @param string $columnName name of the column to drop
347 * @return boolean success flag
350 public function dropColumn($table, $columnName)
352 $sql = "ALTER TABLE $table DROP COLUMN $columnName";
354 $res = $this->conn->query($sql);
356 if (PEAR::isError($res)) {
357 throw new Exception($res->getMessage());
364 * Ensures that a table exists with the given
365 * name and the given column definitions.
367 * If the table does not yet exist, it will
368 * create the table. If it does exist, it will
369 * alter the table to match the column definitions.
371 * @param string $tableName name of the table
372 * @param array $columns array of ColumnDef
373 * objects for the table
375 * @return boolean success flag
378 public function ensureTable($tableName, $columns)
380 // XXX: DB engine portability -> toilet
383 $td = $this->getTableDef($tableName);
385 } catch (Exception $e) {
386 if (preg_match('/no such table/', $e->getMessage())) {
387 return $this->createTable($tableName, $columns);
393 $cur = $this->_names($td->columns);
394 $new = $this->_names($columns);
396 $toadd = array_diff($new, $cur);
397 $todrop = array_diff($cur, $new);
398 $same = array_intersect($new, $cur);
401 foreach ($same as $m) {
402 $curCol = $this->_byName($td->columns, $m);
403 $newCol = $this->_byName($columns, $m);
405 if (!$newCol->equals($curCol)) {
406 $tomod[] = $newCol->name;
410 if (count($toadd) + count($todrop) + count($tomod) == 0) {
415 // For efficiency, we want this all in one
416 // query, instead of using our methods.
420 foreach ($toadd as $columnName) {
421 $cd = $this->_byName($columns, $columnName);
423 $phrase[] = 'ADD COLUMN ' . $this->_columnSql($cd);
426 foreach ($todrop as $columnName) {
427 $phrase[] = 'DROP COLUMN ' . $columnName;
430 foreach ($tomod as $columnName) {
431 $cd = $this->_byName($columns, $columnName);
433 $phrase[] = 'MODIFY COLUMN ' . $this->_columnSql($cd);
436 $sql = 'ALTER TABLE ' . $tableName . ' ' . implode(', ', $phrase);
438 $res = $this->conn->query($sql);
440 if (PEAR::isError($res)) {
441 throw new Exception($res->getMessage());
448 * Returns the array of names from an array of
451 * @param array $cds array of ColumnDef objects
453 * @return array strings for name values
456 private function _names($cds)
460 foreach ($cds as $cd) {
461 $names[] = $cd->name;
468 * Get a ColumnDef from an array matching
471 * @param array $cds Array of ColumnDef objects
472 * @param string $name Name of the column
474 * @return ColumnDef matching item or null if no match.
477 private function _byName($cds, $name)
479 foreach ($cds as $cd) {
480 if ($cd->name == $name) {
489 * Return the proper SQL for creating or
492 * Appropriate for use in CREATE TABLE or
493 * ALTER TABLE statements.
495 * @param ColumnDef $cd column to create
497 * @return string correct SQL for that column
500 private function _columnSql($cd)
502 $sql = "{$cd->name} ";
503 $type = $this->_columnTypeTranslation($cd->type);
505 if (!empty($cd->size)) {
506 $sql .= "{$type}({$cd->size}) ";
511 if (!empty($cd->default)) {
512 $sql .= "default {$cd->default} ";
514 $sql .= ($cd->nullable) ? "null " : "not null ";
517 if (!empty($cd->auto_increment)) {
518 $sql .= " auto_increment ";
521 if (!empty($cd->extra)) {
522 $sql .= "{$cd->extra} ";