*/
public function buildCreateTable($name, $def)
{
+ $def = $this->validateDef($name, $def);
$def = $this->filterDef($def);
$sql = array();
$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']);
}
}
+ if (!empty($def['foreign keys'])) {
+ foreach ($def['foreign keys'] as $keyName => $keyDef) {
+ $this->appendForeignKeyDef($sql, $keyName, $keyDef);
+ }
+ }
+
// Multi-value indexes are advisory and for best portability
// should be created as separate statements.
$statements = array();
}
/**
- * 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
$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);
+ }
+
/**
* Append an SQL statement with an index definition for an advisory
* index over one or more columns on a table.
$statements[] = "CREATE INDEX $name ON $table " . $this->buildIndexList($def);
}
+ /**
+ * 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
* @return array of SQL statements
*/
- function buildEnsureTable($tableName, $def)
+ function buildEnsureTable($tableName, array $def)
{
try {
$old = $this->getTableDef($tableName);
return $this->buildCreateTable($tableName, $def);
}
- //$old = $this->filterDef($old);
+ // 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);
- // @fixme check if not present
+ $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');
+
+ // Drop any obsolete or modified indexes ahead...
+ foreach ($indexes['del'] + $indexes['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);
}
$this->appendAlterAddUnique($phrase, $keyName, $def['unique keys'][$keyName]);
}
+ foreach ($foreign['mod'] + $foreign['add'] as $keyName) {
+ $this->appendAlterAddForeign($phrase, $keyName, $def['foreign keys'][$keyName]);
+ }
+
$this->appendAlterExtras($phrase, $tableName);
- if (count($phrase) == 0) {
- // nothing to do
- return array();
+ if (count($phrase) > 0) {
+ $sql = 'ALTER TABLE ' . $tableName . ' ' . implode(",\n", $phrase);
+ $statements[] = $sql;
}
- $sql = 'ALTER TABLE ' . $tableName . ' ' . implode(",\n", $phrase);
+ // Now create any indexes...
+ foreach ($indexes['mod'] + $indexes['add'] as $indexName) {
+ $this->appendCreateIndex($statements, $tableName, $indexName, $def['indexes'][$indexName]);
+ }
- return array($sql);
+ return $statements;
}
function diffArrays($oldDef, $newDef, $section, $compareCallback=null)
$phrase[] = implode(' ', $sql);
}
+ function appendAlterAddForeign(array &$phrase, $keyName, array $def)
+ {
+ $sql = array();
+ $sql[] = 'ADD';
+ $this->appendForeignKeyDef($sql, $keyName, $def);
+ $phrase[] = implode(' ', $sql);
+ }
+
function appendAlterDropUnique(array &$phrase, $keyName)
{
$phrase[] = 'DROP CONSTRAINT ' . $keyName;
}
+ function appendAlterDropForeign(array &$phrase, $keyName)
+ {
+ $phrase[] = 'DROP FOREIGN KEY ' . $keyName;
+ }
+
function appendAlterExtras(array &$phrase, $tableName)
{
// no-op
* 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 $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 (count($def) && $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);
projects / quix0rs-gnu-social.git / blobdiff