{
$td = $this->getTableDef($table);
- foreach ($td->columns as $cd) {
- if ($cd->name == $column) {
- return $cd;
+ if (!empty($td) && !empty($td->columns)) {
+ foreach ($td->columns as $cd) {
+ if ($cd->name == $column) {
+ return $cd;
+ }
}
}
/**
* Creates a table with the given names and columns.
*
- * @param string $name Name of the table
- * @param array $columns Array of ColumnDef objects
- * for new table.
+ * @param string $tableName Name of the table
+ * @param array $def Table definition array listing fields and indexes.
*
* @return boolean success flag
*/
- public function createTable($name, $columns)
+ public function createTable($tableName, $def)
{
$statements = $this->buildCreateTable($tableName, $def);
return $this->runSqlSet($statements);
*/
public function buildCreateTable($name, $def)
{
+ $def = $this->validateDef($name, $def);
+ $def = $this->filterDef($def);
$sql = array();
foreach ($def['fields'] as $col => $colDef) {
$this->appendColumnDef($sql, $col, $colDef);
}
- // Primary and unique keys are constraints, so go within
+ // Primary, unique, and foreign keys are constraints, so go within
// the CREATE TABLE statement normally.
if (!empty($def['primary key'])) {
$this->appendPrimaryKeyDef($sql, $def['primary key']);
}
}
- // Multi-value indexes are advisory and for best portability
- // should be created as separate statements.
+ if (!empty($def['foreign keys'])) {
+ foreach ($def['foreign keys'] as $keyName => $keyDef) {
+ $this->appendForeignKeyDef($sql, $keyName, $keyDef);
+ }
+ }
+
+ // Wrap the CREATE TABLE around the main body chunks...
$statements = array();
$statements[] = $this->startCreateTable($name, $def) . "\n" .
implode($sql, ",\n") . "\n" .
$this->endCreateTable($name, $def);
+
+ // Multi-value indexes are advisory and for best portability
+ // should be created as separate statements.
if (!empty($def['indexes'])) {
foreach ($def['indexes'] as $col => $colDef) {
$this->appendCreateIndex($statements, $name, $col, $colDef);
}
}
+ if (!empty($def['fulltext indexes'])) {
+ foreach ($def['fulltext indexes'] as $col => $colDef) {
+ $this->appendCreateFulltextIndex($statements, $name, $col, $colDef);
+ }
+ }
return $statements;
}
}
/**
- * Append an SQL fragment with a constraint definition for a primary
+ * Append an SQL fragment with a constraint definition for a unique
* key in a CREATE TABLE statement.
*
* @param array $sql
*/
function appendUniqueKeyDef(array &$sql, $name, array $def)
{
- $sql[] = "UNIQUE $name " . $this->buildIndexList($def);
+ $sql[] = "CONSTRAINT $name UNIQUE " . $this->buildIndexList($def);
+ }
+
+ /**
+ * Append an SQL fragment with a constraint definition for a foreign
+ * key in a CREATE TABLE statement.
+ *
+ * @param array $sql
+ * @param string $name
+ * @param array $def
+ */
+ function appendForeignKeyDef(array &$sql, $name, array $def)
+ {
+ if (count($def) != 2) {
+ throw new Exception("Invalid foreign key def for $name: " . var_export($def, true));
+ }
+ list($refTable, $map) = $def;
+ $srcCols = array_keys($map);
+ $refCols = array_values($map);
+ $sql[] = "CONSTRAINT $name FOREIGN KEY " .
+ $this->buildIndexList($srcCols) .
+ " REFERENCES " .
+ $this->quoteIdentifier($refTable) .
+ " " .
+ $this->buildIndexList($refCols);
}
/**
$statements[] = "CREATE INDEX $name ON $table " . $this->buildIndexList($def);
}
+ /**
+ * Append an SQL statement with an index definition for a full-text search
+ * index over one or more columns on a table.
+ *
+ * @param array $statements
+ * @param string $table
+ * @param string $name
+ * @param array $def
+ */
+ function appendCreateFulltextIndex(array &$statements, $table, $name, array $def)
+ {
+ throw new Exception("Fulltext index not supported in this database");
+ }
+
+ /**
+ * Append an SQL statement to drop an index from a table.
+ *
+ * @param array $statements
+ * @param string $table
+ * @param string $name
+ * @param array $def
+ */
+ function appendDropIndex(array &$statements, $table, $name)
+ {
+ $statements[] = "DROP INDEX $name ON " . $this->quoteIdentifier($table);
+ }
+
function buildIndexList(array $def)
{
// @fixme
public function dropTable($name)
{
+ global $_PEAR;
+
$res = $this->conn->query("DROP TABLE $name");
- if (PEAR::isError($res)) {
+ if ($_PEAR->isError($res)) {
throw new Exception($res->getMessage());
}
public function createIndex($table, $columnNames, $name=null)
{
+ global $_PEAR;
+
if (!is_array($columnNames)) {
$columnNames = array($columnNames);
}
"ADD INDEX $name (".
implode(",", $columnNames).")");
- if (PEAR::isError($res)) {
+ if ($_PEAR->isError($res)) {
throw new Exception($res->getMessage());
}
public function dropIndex($table, $name)
{
+ global $_PEAR;
+
$res = $this->conn->query("ALTER TABLE $table DROP INDEX $name");
- if (PEAR::isError($res)) {
+ if ($_PEAR->isError($res)) {
throw new Exception($res->getMessage());
}
public function addColumn($table, $columndef)
{
+ global $_PEAR;
+
$sql = "ALTER TABLE $table ADD COLUMN " . $this->_columnSql($columndef);
$res = $this->conn->query($sql);
- if (PEAR::isError($res)) {
+ if ($_PEAR->isError($res)) {
throw new Exception($res->getMessage());
}
public function modifyColumn($table, $columndef)
{
+ global $_PEAR;
+
$sql = "ALTER TABLE $table MODIFY COLUMN " .
$this->_columnSql($columndef);
$res = $this->conn->query($sql);
- if (PEAR::isError($res)) {
+ if ($_PEAR->isError($res)) {
throw new Exception($res->getMessage());
}
public function dropColumn($table, $columnName)
{
+ global $_PEAR;
+
$sql = "ALTER TABLE $table DROP COLUMN $columnName";
$res = $this->conn->query($sql);
- if (PEAR::isError($res)) {
+ if ($_PEAR->isError($res)) {
throw new Exception($res->getMessage());
}
*/
function runSqlSet(array $statements)
{
+ global $_PEAR;
+
$ok = true;
foreach ($statements as $sql) {
+ if (defined('DEBUG_INSTALLER')) {
+ echo "<tt>" . htmlspecialchars($sql) . "</tt><br/>\n";
+ }
$res = $this->conn->query($sql);
- if (PEAR::isError($res)) {
+ if ($_PEAR->isError($res)) {
throw new Exception($res->getMessage());
}
}
* @return array of SQL statements
*/
- function buildEnsureTable($tableName, $def)
+ function buildEnsureTable($tableName, array $def)
{
try {
$old = $this->getTableDef($tableName);
- } catch (Exception $e) {
- // @fixme this is a terrible check :D
- if (preg_match('/no such table/', $e->getMessage())) {
- return $this->buildCreateTable($tableName, $def);
- } else {
- throw $e;
- }
+ } catch (SchemaTableMissingException $e) {
+ return $this->buildCreateTable($tableName, $def);
}
- // @fixme check if not present
- $fields = $this->diffArrays($old['fields'], $def['fields'], array($this, 'columnsEqual'));
- $uniques = $this->diffArrays($old['unique keys'], $def['unique keys']);
- $indexes = $this->diffArrays($old['indexes'], $def['indexes']);
+ // Filter the DB-independent table definition to match the current
+ // database engine's features and limitations.
+ $def = $this->validateDef($tableName, $def);
+ $def = $this->filterDef($def);
+
+ $statements = array();
+ $fields = $this->diffArrays($old, $def, 'fields', array($this, 'columnsEqual'));
+ $uniques = $this->diffArrays($old, $def, 'unique keys');
+ $indexes = $this->diffArrays($old, $def, 'indexes');
+ $foreign = $this->diffArrays($old, $def, 'foreign keys');
+ $fulltext = $this->diffArrays($old, $def, 'fulltext indexes');
+
+ // Drop any obsolete or modified indexes ahead...
+ foreach ($indexes['del'] + $indexes['mod'] as $indexName) {
+ $this->appendDropIndex($statements, $tableName, $indexName);
+ }
- /*
- if (count($toadd) + count($todrop) + count($tomod) == 0) {
- // nothing to do
- return true;
+ // Drop any obsolete or modified fulltext indexes ahead...
+ foreach ($fulltext['del'] + $fulltext['mod'] as $indexName) {
+ $this->appendDropIndex($statements, $tableName, $indexName);
}
- */
// For efficiency, we want this all in one
// query, instead of using our methods.
$phrase = array();
+ foreach ($foreign['del'] + $foreign['mod'] as $keyName) {
+ $this->appendAlterDropForeign($phrase, $keyName);
+ }
+
foreach ($uniques['del'] + $uniques['mod'] as $keyName) {
$this->appendAlterDropUnique($phrase, $keyName);
}
+ if (isset($old['primary key']) && (!isset($def['primary key']) || $def['primary key'] != $old['primary key'])) {
+ $this->appendAlterDropPrimary($phrase);
+ }
+
foreach ($fields['add'] as $columnName) {
$this->appendAlterAddColumn($phrase, $columnName,
$def['fields'][$columnName]);
$this->appendAlterDropColumn($phrase, $columnName);
}
+ if (isset($def['primary key']) && (!isset($old['primary key']) || $old['primary key'] != $def['primary key'])) {
+ $this->appendAlterAddPrimary($phrase, $def['primary key']);
+ }
+
foreach ($uniques['mod'] + $uniques['add'] as $keyName) {
$this->appendAlterAddUnique($phrase, $keyName, $def['unique keys'][$keyName]);
}
- $sql = 'ALTER TABLE ' . $tableName . ' ' . implode(",\n", $phrase);
+ foreach ($foreign['mod'] + $foreign['add'] as $keyName) {
+ $this->appendAlterAddForeign($phrase, $keyName, $def['foreign keys'][$keyName]);
+ }
+
+ $this->appendAlterExtras($phrase, $tableName, $def);
+
+ if (count($phrase) > 0) {
+ $sql = 'ALTER TABLE ' . $tableName . ' ' . implode(",\n", $phrase);
+ $statements[] = $sql;
+ }
+
+ // Now create any indexes...
+ foreach ($indexes['mod'] + $indexes['add'] as $indexName) {
+ $this->appendCreateIndex($statements, $tableName, $indexName, $def['indexes'][$indexName]);
+ }
+
+ foreach ($fulltext['mod'] + $fulltext['add'] as $indexName) {
+ $colDef = $def['fulltext indexes'][$indexName];
+ $this->appendCreateFulltextIndex($statements, $tableName, $indexName, $colDef);
+ }
- return array($sql);
+ return $statements;
}
- function diffArrays($old, $new, $compareCallback=null)
+ function diffArrays($oldDef, $newDef, $section, $compareCallback=null)
{
+ $old = isset($oldDef[$section]) ? $oldDef[$section] : array();
+ $new = isset($newDef[$section]) ? $newDef[$section] : array();
- $oldKeys = array_keys($old ? $old : array());
- $newKeys = array_keys($new ? $new : array());
+ $oldKeys = array_keys($old);
+ $newKeys = array_keys($new);
$toadd = array_diff($newKeys, $oldKeys);
$todrop = array_diff($oldKeys, $newKeys);
if ($compareCallback) {
$same = call_user_func($compareCallback, $old[$name], $new[$name]);
} else {
- $same = ($old[$name] != $new[$name]);
+ $same = ($old[$name] == $new[$name]);
}
if ($same) {
$tokeep[] = $name;
return array('add' => $toadd,
'del' => $todrop,
'mod' => $tomod,
- 'keep' => $tokeep);
+ 'keep' => $tokeep,
+ 'count' => count($toadd) + count($todrop) + count($tomod));
}
/**
$sql = array();
$sql[] = 'ADD';
$this->appendUniqueKeyDef($sql, $keyName, $def);
- $phrase[] = implode(' ', $sql);'ADD CONSTRAINT ' . $keyName;
+ $phrase[] = implode(' ', $sql);
+ }
+
+ function appendAlterAddForeign(array &$phrase, $keyName, array $def)
+ {
+ $sql = array();
+ $sql[] = 'ADD';
+ $this->appendForeignKeyDef($sql, $keyName, $def);
+ $phrase[] = implode(' ', $sql);
+ }
+
+ function appendAlterAddPrimary(array &$phrase, array $def)
+ {
+ $sql = array();
+ $sql[] = 'ADD';
+ $this->appendPrimaryKeyDef($sql, $def);
+ $phrase[] = implode(' ', $sql);
+ }
+
+ function appendAlterDropPrimary(array &$phrase)
+ {
+ $phrase[] = 'DROP CONSTRAINT PRIMARY KEY';
}
function appendAlterDropUnique(array &$phrase, $keyName)
$phrase[] = 'DROP CONSTRAINT ' . $keyName;
}
+ function appendAlterDropForeign(array &$phrase, $keyName)
+ {
+ $phrase[] = 'DROP FOREIGN KEY ' . $keyName;
+ }
+
+ function appendAlterExtras(array &$phrase, $tableName, array $def)
+ {
+ // no-op
+ }
+
/**
* Quote a db/table/column identifier if necessary.
*
function quoteValue($val)
{
- if (is_int($val) || is_float($val) || is_double($val)) {
- return strval($val);
- } else {
- return '"' . $this->conn->escapeSimple($val) . '"';
- }
+ return $this->conn->quoteSmart($val);
}
/**
function typeAndSize($column)
{
- $type = $this->mapType($column);
+ //$type = $this->mapType($column);
+ $type = $column['type'];
+ if (isset($column['size'])) {
+ $type = $column['size'] . $type;
+ }
$lengths = array();
- if ($column['type'] == 'numeric') {
- if (isset($column['precision'])) {
- $lengths[] = $column['precision'];
- if (isset($column['scale'])) {
- $lengths[] = $column['scale'];
- }
+ if (isset($column['precision'])) {
+ $lengths[] = $column['precision'];
+ if (isset($column['scale'])) {
+ $lengths[] = $column['scale'];
}
} else if (isset($column['length'])) {
$lengths[] = $column['length'];
}
}
- /**
- * Map a native type back to an independent type + size
- *
- * @param string $type
- * @return array ($type, $size) -- $size may be null
- */
- protected function reverseMapType($type)
- {
- return array($type, null);
- }
-
/**
* Convert an old-style set of ColumnDef objects into the current
* Drupal-style schema definition array, for backwards compatibility
* with plugins written for 0.9.x.
*
* @param string $tableName
- * @param array $defs
+ * @param array $defs: array of ColumnDef objects
* @return array
*/
- function oldToNew($tableName, $defs)
+ protected function oldToNew($tableName, array $defs)
{
$table = array();
$prefixes = array(
'big',
);
foreach ($defs as $cd) {
- $cd->addToTableDef($table);
$column = array();
$column['type'] = $cd->type;
foreach ($prefixes as $prefix) {
if (!$cd->nullable) {
$column['not null'] = true;
}
- if ($cd->autoincrement) {
+ if ($cd->auto_increment) {
$column['type'] = 'serial';
}
if ($cd->default) {
return $table;
}
+ /**
+ * 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)
+ {
+ return $tableDef;
+ }
+
+ /**
+ * Validate a table definition array, checking for basic structure.
+ *
+ * If necessary, converts from an old-style array of ColumnDef objects.
+ *
+ * @param string $tableName
+ * @param array $def: table definition array
+ * @return array validated table definition array
+ *
+ * @throws Exception on wildly invalid input
+ */
+ function validateDef($tableName, array $def)
+ {
+ if (isset($def[0]) && $def[0] instanceof ColumnDef) {
+ $def = $this->oldToNew($tableName, $def);
+ }
+
+ // A few quick checks :D
+ if (!isset($def['fields'])) {
+ throw new Exception("Invalid table definition for $tableName: no fields.");
+ }
+
+ return $def;
+ }
+
function isNumericType($type)
{
$type = strtolower($type);
*/
protected function fetchQueryData($sql)
{
+ global $_PEAR;
+
$res = $this->conn->query($sql);
- if (PEAR::isError($res)) {
+ if ($_PEAR->isError($res)) {
throw new Exception($res->getMessage());
}
projects / quix0rs-gnu-social.git / blobdiff