allow dropping fkeys with sqlite

This implements the ability to drop foreign keys
with sqlite. It's basically the same implementation
used for dropping unique constraints so the common
code is refactored.

The existing FKey test that was skipping sqlite is
no longer skipped to show this works.

Change-Id: Idaaf4229e34af4c21c3bcead4b4e22491d24238e
Closes-Bug: #1423955
This commit is contained in:
Matt Riedemann 2015-02-20 09:26:10 -08:00
parent 997855db3b
commit ae64d828df
2 changed files with 37 additions and 18 deletions

View File

@ -11,6 +11,7 @@ from copy import copy
import re import re
from sqlalchemy.databases import sqlite as sa_base from sqlalchemy.databases import sqlite as sa_base
from sqlalchemy.schema import ForeignKeyConstraint
from sqlalchemy.schema import UniqueConstraint from sqlalchemy.schema import UniqueConstraint
from migrate import exceptions from migrate import exceptions
@ -29,8 +30,24 @@ class SQLiteCommon(object):
class SQLiteHelper(SQLiteCommon): class SQLiteHelper(SQLiteCommon):
def _get_unique_constraints(self, table): def _filter_columns(self, cols, table):
"""Retrieve information about existing unique constraints of the table """Splits the string of columns and returns those only in the table.
:param cols: comma-delimited string of table columns
:param table: the table to check
:return: list of columns in the table
"""
columns = []
for c in cols.split(","):
if c in table.columns:
# There was a bug in reflection of SQLite columns with
# reserved identifiers as names (SQLite can return them
# wrapped with double quotes), so strip double quotes.
columns.extend(c.strip(' "'))
return columns
def _get_constraints(self, table):
"""Retrieve information about existing constraints of the table
This feature is needed for recreate_table() to work properly. This feature is needed for recreate_table() to work properly.
""" """
@ -48,19 +65,21 @@ class SQLiteHelper(SQLiteCommon):
constraints = [] constraints = []
for name, cols in re.findall(UNIQUE_PATTERN, data): for name, cols in re.findall(UNIQUE_PATTERN, data):
# Filter out any columns that were dropped from the table. # Filter out any columns that were dropped from the table.
columns = [] columns = self._filter_columns(cols, table)
for c in cols.split(","):
if c in table.columns:
# There was a bug in reflection of SQLite columns with
# reserved identifiers as names (SQLite can return them
# wrapped with double quotes), so strip double quotes.
columns.extend(c.strip(' "'))
if columns: if columns:
constraints.extend(UniqueConstraint(*columns, name=name)) constraints.extend(UniqueConstraint(*columns, name=name))
FKEY_PATTERN = "CONSTRAINT (\w+) FOREIGN KEY \(([^\)]+)\)"
for name, cols in re.findall(FKEY_PATTERN, data):
# Filter out any columns that were dropped from the table.
columns = self._filter_columns(cols, table)
if columns:
constraints.extend(ForeignKeyConstraint(*columns, name=name))
return constraints return constraints
def recreate_table(self, table, column=None, delta=None, def recreate_table(self, table, column=None, delta=None,
omit_uniques=None): omit_constraints=None):
table_name = self.preparer.format_table(table) table_name = self.preparer.format_table(table)
# we remove all indexes so as not to have # we remove all indexes so as not to have
@ -68,13 +87,13 @@ class SQLiteHelper(SQLiteCommon):
for index in table.indexes: for index in table.indexes:
index.drop() index.drop()
# reflect existing unique constraints # reflect existing constraints
for uc in self._get_unique_constraints(table): for constraint in self._get_constraints(table):
table.append_constraint(uc) table.append_constraint(constraint)
# omit given unique constraints when creating a new table if required # omit given constraints when creating a new table if required
table.constraints = set([ table.constraints = set([
cons for cons in table.constraints cons for cons in table.constraints
if omit_uniques is None or cons.name not in omit_uniques if omit_constraints is None or cons.name not in omit_constraints
]) ])
self.append('ALTER TABLE %s RENAME TO migration_tmp' % table_name) self.append('ALTER TABLE %s RENAME TO migration_tmp' % table_name)
@ -182,13 +201,13 @@ class SQLiteConstraintDropper(ansisql.ANSIColumnDropper,
self.execute() self.execute()
def visit_migrate_foreign_key_constraint(self, *p, **k): def visit_migrate_foreign_key_constraint(self, *p, **k):
self._not_supported('ALTER TABLE DROP CONSTRAINT') self.recreate_table(p[0].table, omit_constraints=[p[0].name])
def visit_migrate_check_constraint(self, *p, **k): def visit_migrate_check_constraint(self, *p, **k):
self._not_supported('ALTER TABLE DROP CONSTRAINT') self._not_supported('ALTER TABLE DROP CONSTRAINT')
def visit_migrate_unique_constraint(self, *p, **k): def visit_migrate_unique_constraint(self, *p, **k):
self.recreate_table(p[0].table, omit_uniques=[p[0].name]) self.recreate_table(p[0].table, omit_constraints=[p[0].name])
# TODO: technically primary key is a NOT NULL + UNIQUE constraint, should add NOT NULL to index # TODO: technically primary key is a NOT NULL + UNIQUE constraint, should add NOT NULL to index

View File

@ -71,7 +71,7 @@ class TestConstraint(CommonTestConstraint):
self.assertTrue(isinstance(self.table.primary_key, schema.PrimaryKeyConstraint)) self.assertTrue(isinstance(self.table.primary_key, schema.PrimaryKeyConstraint))
return pk return pk
@fixture.usedb(not_supported='sqlite') @fixture.usedb()
def test_define_fk(self): def test_define_fk(self):
"""FK constraints can be defined, created, and dropped""" """FK constraints can be defined, created, and dropped"""
# FK target must be unique # FK target must be unique