Fixed #29824 -- Added support for database exclusion constraints on PostgreSQL. #10478

atombrella · 2018-10-04T09:58:52Z

It should be cleaned up, but here's a good first take on adding the exclude using constraint to django.contrib.postgres. Essentially, it's a way to enforce a unique constraint for a range, whether they're represented as a range-type, or using two fields.

https://gist.github.com/fphilipe/0a2a3d50a9f3834683bf uses two fields, and overlaps with the documentation example where cars are used to illustrate how it works.

I was lucky that RemoveConstraint works, as the constraint can also be removed using DROP INDEX ....
https://code.djangoproject.com/ticket/29824

Introduce a way to write operators and boundaries with constants. Locally, I have something for this.
Demonstrate how to use the constraint for models that use two fields instead of a range-field
~~Maybe write some tests for abstract models. There's Fixed #30397 -- Added app_label/class interpolation for names of indexes and constraints. #11279 that's a necessity for this~~.

charettes

Thank you for your work on this!

django/contrib/postgres/constraints.py

docs/ref/contrib/postgres/constraints.txt

django/contrib/postgres/constraints.py

tests/postgres_tests/models.py

tests/postgres_tests/test_constraints.py

docs/ref/contrib/postgres/constraints.txt

timgraham · 2018-10-30T19:29:22Z

Is it ready for review or still WIP as mentioned in the commit message?

atombrella · 2018-10-30T19:45:25Z

@timgraham I'd like to have an example as requested because there may be many (I've at least worked with one) existing installations of Django which implement a table with two fields, rather than using django.contrib.postgres's ranges. I tried to add some test and code, just as a POC but didn't finalize it.

auvipy

and please rebase :)

docs/releases/2.2.txt

tests/postgres_tests/migrations/0002_create_test_models.py

atombrella · 2019-05-26T08:54:03Z

I'm clueless how to fix the failing tests on the databases that are irrelevant for this patch.

ngnpope

Hi @atombrella!

Thanks for tackling this - will be an awesome addition. I've had a first pass through this - I think that there is some validation that needs attending to and I have some questions about simplifying the API...

django/contrib/postgres/constraints.py

docs/ref/contrib/postgres/fields.txt

tests/postgres_tests/migrations/0002_create_test_models.py

django/contrib/postgres/constraints.py

atombrella · 2019-06-03T11:39:47Z

@ngnpope Thank you 👍 I think I've addressed most of the feedback that was possible. Remaining issues are related to && versus constants such as OVERLAPS. I like the idea of F().with() and Expression().with(), but that'd introduce a subclass of F and Expression somewhere in the PostgreSQL backend just for this purpose. About documentation, referring to PostgreSQL's documentation for details on the operators will suffice. People who will want to use this feature also have a good understanding of PostgreSQL.

Tests are failing on unrelated database backends, and suggested method of silencing with try/except pass doesn't work. Help will be appreciated.

The docs part of the test fails because of customise not being recognized. @carltongibson or @felixxm Could you please fix this?

felixxm · 2019-06-03T11:41:21Z

@atombrella #11439.

ngnpope

I'll have to have a think about your questions - hopefully I'll have some time later this week.

django/contrib/postgres/constraints.py

felixxm · 2019-07-13T13:44:34Z

@atombrella I've prepared first commit (with RangeOperators) ☺️ .

Quick comments:

We should add test (with subTest) to check all operators at least once (I found and fixed a typo in RangeOperators.CONTAINED_BY).
Do we need RangeOperators.UNION, RangeOperators.INTERSECTION and RangeOperators.DIFFERENCE? I don't think that they are useful for exclusion constraints.

I'm going to review in details remaining docs and tests in the next week.

atombrella · 2019-07-13T16:16:41Z

@felixxm Yes, some of those operators may not be relevant. But I don't think it'll hurt to add them. I'll try to think of a way to test them.

I think @ngnpope gave the documentation a pretty good first review, so I don't think a review of this part will be tricky :) The tests have not yet really been looked at.

felixxm · 2019-07-13T16:35:12Z

@atombrella I think that only RangeOperators.UNION, RangeOperators.INTERSECTION and RangeOperators.DIFFERENCE are not useful for exclusion constraints. We should avoid adding unrelated code. Please remove them from this PR, we may decide to add Union(), Intersection() and Difference() functions for ranges in the future, but they aren't in scope of this PR.

Thanks for understanding.

atombrella · 2019-07-14T18:05:07Z

@felixxm I removed those three operators. The easiest way I could think that fulfills this was using the examples in PostgreSQL documentation and cursor.execute('select ...'). Thanks for the help :)

felixxm · 2019-07-15T18:21:45Z

@atombrella I made some changes:

added create_sql() and remove_sql() to ExclusionConstraint,
changed docs and signature of RangeBoundary (I think it is simpler without constants),
made edits in docs/ref/contrib/postgres/fields.txt ,
added RangeBoundary to the release notes,
simplified tests.

My plan for tomorrow is to review remaining docs and add tests for exclusion constraints with other operators.

atombrella · 2019-07-15T18:44:44Z

👍 to RangeBoundary changes. It reads a lot nicer! I'm not sure why create_sql and remove_sql are needed, but I'm indifferent about them. I see many good simplifications :) Thanks!

felixxm · 2019-07-16T08:14:49Z

@atombrella Only commutative operators can be used in exclusion constraints, so I'm going to remove currently unused LT, GT, LTE, and GTE.

felixxm · 2019-07-16T08:51:29Z

@atombrella Without create_sql() and remove_sql() you will not be able to add/remove constraints, only defining constraints for a new model will work.

felixxm · 2019-07-16T09:08:27Z

I added test for ADJACENT_TO operator and validation for expressions.

atombrella · 2019-07-16T09:56:31Z

@felixxm OK. Maybe you should add Co-Authored-By in the commit message? You've done a fair bit of the work here. I'm learning and appreciate the help.

felixxm · 2019-07-16T11:22:22Z

@atombrella You're a 🌟 ! I refactored docs and moved exclusion constraints to the main section instead of minor features, It's not minor 🚀 . Now I'm happy 😉

…ostgreSQL. Thanks to Nick Pope and Mariusz Felisiak for review. Co-Authored-By: Mariusz Felisiak <[email protected]>

felixxm · 2019-07-16T19:10:17Z

@atombrella Many thanks 🚀 🎊 Thanks y'all for comments and reviews 🙇‍♂️

atombrella force-pushed the exclude_using branch 2 times, most recently from fac7ab0 to 8c2709e Compare October 4, 2018 10:37

atombrella changed the title ~~Exclude using~~ Fixed #29824 -- Added exclude using constraint. Oct 4, 2018

charettes approved these changes Oct 4, 2018

View reviewed changes

LilyAcorn reviewed Oct 5, 2018

View reviewed changes

tests/postgres_tests/models.py Outdated Show resolved Hide resolved

tests/postgres_tests/test_constraints.py Outdated Show resolved Hide resolved

docs/ref/contrib/postgres/constraints.txt Outdated Show resolved Hide resolved

atombrella force-pushed the exclude_using branch from 48bae6b to fe815e7 Compare October 5, 2018 14:57

auvipy suggested changes Mar 10, 2019

View reviewed changes

docs/releases/2.2.txt Outdated Show resolved Hide resolved

tests/postgres_tests/migrations/0002_create_test_models.py Outdated Show resolved Hide resolved

atombrella force-pushed the exclude_using branch from fe815e7 to 924c094 Compare April 23, 2019 11:04

atombrella force-pushed the exclude_using branch 2 times, most recently from 57d5855 to 8a2f31f Compare May 24, 2019 15:02

ngnpope suggested changes May 26, 2019

View reviewed changes

atombrella force-pushed the exclude_using branch 2 times, most recently from f251951 to a187867 Compare May 26, 2019 20:35

ngnpope reviewed May 26, 2019

View reviewed changes

django/contrib/postgres/constraints.py Outdated Show resolved Hide resolved

atombrella force-pushed the exclude_using branch from a187867 to 68a99cf Compare June 3, 2019 10:47

atombrella force-pushed the exclude_using branch from 68a99cf to 649a69a Compare June 3, 2019 12:28

ngnpope reviewed Jun 3, 2019

View reviewed changes

django/contrib/postgres/constraints.py Outdated Show resolved Hide resolved

django/contrib/postgres/constraints.py Outdated Show resolved Hide resolved

atombrella force-pushed the exclude_using branch 2 times, most recently from 733b682 to a2c42ab Compare June 14, 2019 09:45

atombrella force-pushed the exclude_using branch 4 times, most recently from 5291113 to facc286 Compare July 1, 2019 12:34

carltongibson self-requested a review July 1, 2019 12:49

atombrella force-pushed the exclude_using branch from facc286 to 46653dd Compare July 9, 2019 07:04

atombrella force-pushed the exclude_using branch from ec043de to c531eba Compare July 14, 2019 18:01

atombrella force-pushed the exclude_using branch from c531eba to 914169b Compare July 14, 2019 18:17

felixxm force-pushed the exclude_using branch 4 times, most recently from e318ec5 to aa172ef Compare July 15, 2019 18:21

felixxm force-pushed the exclude_using branch from aa172ef to efaeb60 Compare July 16, 2019 09:07

felixxm force-pushed the exclude_using branch 2 times, most recently from aa0d8df to 2d7c6fb Compare July 16, 2019 11:19

felixxm force-pushed the exclude_using branch from 2d7c6fb to 9a8521a Compare July 16, 2019 11:23

auvipy approved these changes Jul 16, 2019

View reviewed changes

felixxm changed the title ~~Fixed #29824 -- Added exclude using constraint.~~ Fixed #29824 -- Added support for database exclusion constraints on PostgreSQL. Jul 16, 2019

felixxm force-pushed the exclude_using branch from 9a8521a to 9a4c6fc Compare July 16, 2019 13:24

atombrella and others added 2 commits July 16, 2019 16:57

Refs #29824 -- Added RangeOperators helper class.

7174cf0

Fixed #29824 -- Added support for database exclusion constraints on P…

a341728

…ostgreSQL. Thanks to Nick Pope and Mariusz Felisiak for review. Co-Authored-By: Mariusz Felisiak <[email protected]>

felixxm force-pushed the exclude_using branch from 9a4c6fc to a341728 Compare July 16, 2019 16:04

felixxm merged commit a341728 into django:master Jul 16, 2019

atombrella deleted the exclude_using branch July 16, 2019 19:29

Uh oh!

Fixed #29824 -- Added support for database exclusion constraints on PostgreSQL. #10478

Fixed #29824 -- Added support for database exclusion constraints on PostgreSQL. #10478

Uh oh!

Conversation

atombrella commented Oct 4, 2018 • edited by felixxm Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

charettes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timgraham commented Oct 30, 2018

Uh oh!

atombrella commented Oct 30, 2018

Uh oh!

auvipy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

atombrella commented May 26, 2019

Uh oh!

ngnpope left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

atombrella commented Jun 3, 2019

Uh oh!

felixxm commented Jun 3, 2019

Uh oh!

ngnpope left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

felixxm commented Jul 13, 2019

Uh oh!

atombrella commented Jul 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

felixxm commented Jul 13, 2019

Uh oh!

atombrella commented Jul 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

felixxm commented Jul 15, 2019

Uh oh!

atombrella commented Jul 15, 2019

Uh oh!

felixxm commented Jul 16, 2019

Uh oh!

felixxm commented Jul 16, 2019

Uh oh!

felixxm commented Jul 16, 2019

Uh oh!

atombrella commented Jul 16, 2019

Uh oh!

felixxm commented Jul 16, 2019

Uh oh!

felixxm commented Jul 16, 2019

Uh oh!

atombrella commented Oct 4, 2018 •

edited by felixxm

Loading

atombrella commented Jul 13, 2019 •

edited

Loading

atombrella commented Jul 14, 2019 •

edited

Loading