Add PostgreSQL operations to add constraints via NOT VALID / VALIDATE CONSTRAINT

[Adam Johnson]

If you read the ALTER TABLE PostgreSQL docs ( ​https://www.postgresql.org/docs/12/sql-altertable.html ) for ADD CONSTRAINT, you'll see that it supports the NOT VALID option. This prevents the constraint from being checked against all existing data, although it does affect all inserted/updated rows. Adding a constraint this way does not exclusively lock the whole table to check it. To promote it to valid, the VALIDATE CONSTRAINT syntax can be used. This allows a non-exclusive lock on the table to validate all existing rows. This two step techinque allows constraints to be added to very active tables without locking out concurrent access and thus inflicting downtime.

I suggest django.contrib.postgres add custom operations for these commands, with appropriate documentation around using them in non-atomic migrations.

[Simon Charette]

How would the VALIDATE CONSTRAINT step be performed? Were you thinking of using deferred_sql for this purpose? If it's the case how would you deal with VALIDATE CONSTRAINT failures (e.g. violation of the added constraint) since that'll mark the migration as not applied but leave the constraint in place and thus crash on attempts to re-apply.

I could see us provide specialized contrib.postgres operations that use this syntax to facilitate this manipulation (e.g. AddContraint(valid=False) and ValidateConstraint(name)) but I'm afraid this will be hard to achieve by default without risking leaving the migration and database state out-of-sync if the VALIDATE CONSTRAINT fails.

[Adam Johnson]

It doesn't need to be deferred, as I understand it can be done within a migration transaction. I was imagining SchemaEditor.add_constraint can be overridden to add the NOT VALID clause then execute the second VALIDATE CONSTRAINT.

[Mariusz Felisiak]

Similar NOVALIDATE syntax is available on ​Oracle. However on both databases it has some caveats.

[Simon Charette]

The documentation states

After that, a VALIDATE CONSTRAINT command can be issued to verify that existing rows satisfy the constraint. The validation step does not need to lock out concurrent updates, since it knows that other transactions will be enforcing the constraint for rows that they insert or update; only pre-existing rows need to be checked.

My interpretation is that in order for other transactions to see that the constraint was added in a READ COMMITTED scenario the ADD CONSTRAINT NOT VALID must be committed first; performing a ADD CONSTRAINT NOT VALID and VALIDATE CONSTRAINT in the same transaction should result in the same operations as ADD CONSTRAINT otherwise PostgreSQL would always do it by default?

I could be missing something as I didn't try it out locally but from my understanding this would need the following sequence of migrations to be generated to work properly.

class Migration(migrations.Migration):
    operations = [
        # BEGIN
        AddConstraint(Constraint(name='foo'), validate=False),
        # COMMIT
    ]

class Migration(migrations.Migration):
    operations = [
        # BEGIN
        ValidateConstraint('foo'),
        # COMMIT
    ]

Running the first migration would commit the ADD CONSTRAINT NOT VALID and allow other transactions to start enforcing it which is something the VALIDATE CONSTRAINT could assume in the following transaction.

[Adam Johnson]

My interpretation is that in order for other transactions to see that the constraint was added in a READ COMMITTED scenario the ADD CONSTRAINT NOT VALID must be committed first; performing a ADD CONSTRAINT NOT VALID and VALIDATE CONSTRAINT in the same transaction should result in the same operations as ADD CONSTRAINT otherwise PostgreSQL would always do it by default?

Yes... the one time I've used NOT VALID was actually in an atomic = False migration so I didn't test it with atomic. I was probably too zealous reading the PostgreSQL docs which don't mention transactions.

I think custom django.contrib.postgres operations would be the way. They can document to use non-atomic migrations. Rather than AddConstraint(..., validate=False) I'd suggest AddConstraintNotValid(...) as a subclass of AddConstraint, and ValidateConstraint.

[Simon Charette]

I think custom django.contrib.postgres operations would be the way. They can document to use non-atomic migrations. Rather than AddConstraint(..., validate=False) I'd suggest AddConstraintNotValid(...) as a subclass of AddConstraint, and ValidateConstraint.

I think that's the way to go as well. I'd suggest we document breaking the operations in two migrations instead of using atomic=False otherwise your database will be left in a inconsistent state if the ValidateConstraint operation fails.

[Adam Johnson]

I'd suggest we document breaking the operations in two migrations instead of using atomic=False otherwise your database will be left in a inconsistent state if the ValidateConstraint operation fails.

Yes. I think MySQL has made me reach for atomic = False too much 😂

[Sanskar Jaiswal]

I'd like to work on this ticket. I was thinking of adding an add_constraint() in db.backends.postgresql.schema.DatabaseSchemaEditor, which could modify the sql returned by calling constraint.create_sql(model, self) to have the NOT VALID clause as well. This could be then used by the custom operations, that'll be defined in contrib.postgres.operations. Does this work or is my approach missing something here?

[Adam Johnson]

I think it would be better to keep the SQL modification purely in the operation class. It's only for PostgreSQL, so it doesn't need to be part of the more generic backend class.

[Sanskar Jaiswal]

But wouldn't modifying the SQL in a new add_constraint() method in db.backends.postgresql.schema.DatabaseSchemaEditor avoid making it backend agnostic and make it Postgres specific?

[Adam Johnson]

The backend classes exist mostly as a unified API across all supported backends. When I see a method in a backend class, I presume it exists with the same signature in all other backend classes.

[Sanskar Jaiswal]

This form adds a new constraint to a table using the same constraint syntax as CREATE TABLE, plus the option NOT VALID, which is currently only allowed for foreign key and CHECK constraints.

We should probably also document the fact that this operation only supports CheckConstraints and NOT ForeignKeys. I think it'd be better if we added Postgres operations that support the NOT VALID clause for fk checks as well in the future.

[Sanskar Jaiswal]

Patch ​https://github.com/django/django/pull/13559

[Mariusz Felisiak <felisiak.mariusz@…>]

In 8c3bd0b7:

Fixed #31653 -- Added AddConstraintNotValid()/ValidateConstraint() operations for PostgreSQL.