Fix: Cannot remove UniqueConstraint on ForeignKey with Django/MySQL

remove_custom_fk_uniqueconstraint_django_mysql.md

Django allows you to define custom UniqueConstraints to specify which combinations of values are allowed in a row, but removing these later can be problematic when some ForeignKey is involved, at least with MySQL it may throw a Cannot drop index '...': needed in a foreign key constraint at you.

The example below shows you how to resolve such a situation in 3 small individual migrations:

• We start with an existing UniqueConstraint.

class MyModel(models.Model):
    other_model = models.ForeignKey("OtherModel", on_delete=models.CASCADE)
    name = models.CharField(max_length=128)

    class Meta:
        constraints = (
            models.UniqueConstraint(
                fields=(
                    "other_model",
                    "name",
                ),
                name="unique_other_model_name",
            ),
        )

• Step 1: Tell Django that we don't want an index and constraint on the ForeignKey.

class MyModel(models.Model):
    other_model = models.ForeignKey(
        "OtherModel", 
        on_delete=models.CASCADE,
        db_index=False,
        db_constraint=False,
    )
    name = models.CharField(max_length=128)

    class Meta:
        constraints = (
            models.UniqueConstraint(
                fields=(
                    "other_model",
                    "name",
                ),
                name="unique_other_model_name",
            ),
        )

$ python manage.py makemigrations

• Step 2: Remove the custom UniqueConstraint.

class MyModel(models.Model):
    other_model = models.ForeignKey(
        "OtherModel", 
        on_delete=models.CASCADE,
        db_index=False,
        db_constraint=False,
    )
    name = models.CharField(max_length=128)

$ python manage.py makemigrations

• Step 3: Re-introduce the default behaviour of having an index and constraint on the ForeignKey.

class MyModel(models.Model):
    other_model = models.ForeignKey( "OtherModel", on_delete=models.CASCADE)
    name = models.CharField(Max_length=128)

$ python manage.py makemigrations

You'll end up with 3 migration files that can easily be combined into a single one before running this in production, to tidy things up.

Done!

Thank you! I was afraid I fcked up real bad!

Glad it was helpful, thanks for letting me know 👍

Great gist!

It worked for me too, thanks.

Long time, no see!

We really have to find a better way to do this. Default behavior shouldn't be to revert a migration by adding another migration.

Glad you documented the trick.
Thx!

this helped me loads! thank you :)

I have a problem with this: after the first migration is applied the index for the other_model is also removed and when the second migration tries to remove that constraint it can't... is there a way to skip errors of that kind? (something like "ignore if the RemoveConstraint tries to remove something that does not exist)?