Initial foreign key setup support

This commit is contained in:
Brion Vibber 2010-10-19 12:08:59 -07:00
parent b635c75639
commit 7751d455de
2 changed files with 84 additions and 13 deletions

View File

@ -511,8 +511,8 @@ $schema['foreign_link'] = array(
$schema['foreign_subscription'] = array( $schema['foreign_subscription'] = array(
'fields' => array( 'fields' => array(
'service' => array('type' => 'int', 'not null' => true, 'description' => 'service where relationship happens'), 'service' => array('type' => 'int', 'not null' => true, 'description' => 'service where relationship happens'),
'subscriber' => array('type' => 'int', 'not null' => true, 'description' => 'subscriber on foreign service'), 'subscriber' => array('type' => 'int', 'size' => 'big', 'not null' => true, 'description' => 'subscriber on foreign service'),
'subscribed' => array('type' => 'int', 'not null' => true, 'description' => 'subscribed user'), 'subscribed' => array('type' => 'int', 'size' => 'big', 'not null' => true, 'description' => 'subscribed user'),
'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
), ),
'primary key' => array('service', 'subscriber', 'subscribed'), 'primary key' => array('service', 'subscriber', 'subscribed'),

View File

@ -149,7 +149,7 @@ class Schema
$this->appendColumnDef($sql, $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. // the CREATE TABLE statement normally.
if (!empty($def['primary key'])) { if (!empty($def['primary key'])) {
$this->appendPrimaryKeyDef($sql, $def['primary key']); $this->appendPrimaryKeyDef($sql, $def['primary key']);
@ -161,6 +161,12 @@ class Schema
} }
} }
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 // Multi-value indexes are advisory and for best portability
// should be created as separate statements. // should be created as separate statements.
$statements = array(); $statements = array();
@ -225,7 +231,7 @@ class Schema
} }
/** /**
* 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. * key in a CREATE TABLE statement.
* *
* @param array $sql * @param array $sql
@ -237,6 +243,27 @@ class Schema
$sql[] = "CONSTRAINT $name UNIQUE " . $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)
{
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 * Append an SQL statement with an index definition for an advisory
* index over one or more columns on a table. * index over one or more columns on a table.
@ -251,6 +278,19 @@ class Schema
$statements[] = "CREATE INDEX $name ON $table " . $this->buildIndexList($def); $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) function buildIndexList(array $def)
{ {
// @fixme // @fixme
@ -485,19 +525,30 @@ class Schema
return $this->buildCreateTable($tableName, $def); 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->filterDef($def); $def = $this->filterDef($def);
// @fixme check if not present $statements = array();
$fields = $this->diffArrays($old, $def, 'fields', array($this, 'columnsEqual')); $fields = $this->diffArrays($old, $def, 'fields', array($this, 'columnsEqual'));
$uniques = $this->diffArrays($old, $def, 'unique keys'); $uniques = $this->diffArrays($old, $def, 'unique keys');
$indexes = $this->diffArrays($old, $def, 'indexes'); $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 // For efficiency, we want this all in one
// query, instead of using our methods. // query, instead of using our methods.
$phrase = array(); $phrase = array();
foreach ($foreign['del'] + $foreign['mod'] as $keyName) {
$this->appendAlterDropForeign($phrase, $keyName);
}
foreach ($uniques['del'] + $uniques['mod'] as $keyName) { foreach ($uniques['del'] + $uniques['mod'] as $keyName) {
$this->appendAlterDropUnique($phrase, $keyName); $this->appendAlterDropUnique($phrase, $keyName);
} }
@ -521,16 +572,23 @@ class Schema
$this->appendAlterAddUnique($phrase, $keyName, $def['unique keys'][$keyName]); $this->appendAlterAddUnique($phrase, $keyName, $def['unique keys'][$keyName]);
} }
$this->appendAlterExtras($phrase, $tableName); foreach ($foreign['mod'] + $foreign['add'] as $keyName) {
$this->appendAlterAddForeign($phrase, $keyName, $def['foreign keys'][$keyName]);
if (count($phrase) == 0) {
// nothing to do
return array();
} }
$sql = 'ALTER TABLE ' . $tableName . ' ' . implode(",\n", $phrase); $this->appendAlterExtras($phrase, $tableName);
return array($sql); 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]);
}
return $statements;
} }
function diffArrays($oldDef, $newDef, $section, $compareCallback=null) function diffArrays($oldDef, $newDef, $section, $compareCallback=null)
@ -621,11 +679,24 @@ class Schema
$phrase[] = implode(' ', $sql); $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) function appendAlterDropUnique(array &$phrase, $keyName)
{ {
$phrase[] = 'DROP CONSTRAINT ' . $keyName; $phrase[] = 'DROP CONSTRAINT ' . $keyName;
} }
function appendAlterDropForeign(array &$phrase, $keyName)
{
$phrase[] = 'DROP FOREIGN KEY ' . $keyName;
}
function appendAlterExtras(array &$phrase, $tableName) function appendAlterExtras(array &$phrase, $tableName)
{ {
// no-op // no-op