Add support for exclusion constraints (PostgreSQL-only) #40224

agrobbin · 2020-09-13T02:47:18Z

Summary

Similar to #31323, this extends Active Record's migration/schema dumping to support exclusion constraints!

add_exclusion_constraint :invoices, "daterange(start_date, end_date) WITH &&", using: :gist, name: "invoices_date_overlap"
remove_exclusion_constraint :invoices, name: "invoices_date_overlap"

Hopefully the approach is reasonable, but definitely let me know if there is anything that looks out of whack.

rails-bot · 2020-12-12T02:57:04Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
Thank you for your contributions.

agrobbin · 2020-12-13T19:42:51Z

I know this missed the 6.1 release milestone, but I'd still love to get some eyes on this if someone has time!

hernanat · 2021-04-23T00:00:21Z

+1

hernanat · 2021-05-06T17:32:59Z

@agrobbin you have some merge conflicts, could you resolve them and maybe put a thread up on the mailing list if you can't get anyone's attention here?

agrobbin · 2021-06-02T16:28:34Z

@hernanat merge conflicts resolved! I will post something on the discussion forum in a bit.

zzak · 2021-06-03T02:52:39Z

👀 This seems like a really thorough piece of work, @agrobbin nice work! I'm not sure I have enough context here but from what I've read so far it looks good.

Hopefully we can get some more 👀 on it and move things forward 🙏

activerecord/lib/active_record/connection_adapters/abstract/schema_creation.rb

ghiculescu · 2021-06-03T19:04:25Z

activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb

+      # [<tt>:name</tt>]
+      #   The constraint name. Defaults to <tt>excl_rails_<identifier></tt>.
+      def add_exclusion_constraint(table_name, expression, **options)
+        return unless supports_exclusion_constraints?


I am not sure what the usual approach in Rails is here, but thinking out loud - I feel like you'd want your migration to fail noisely, not silently, if you ran a command that your DB doesn't support.

that's a great point

As with some of your other comments, I don't necessarily disagree with them, but I also think there is a lot of value in consistency of this functionality with the check constraint functionality that already exists in AR, which is why I did this explicit return.

ghiculescu · 2021-06-03T19:06:18Z

activerecord/lib/active_record/schema_dumper.rb

@@ -237,6 +250,27 @@ def check_constraints_in_create(table, stream)
        end
      end

+      def exclusion_constraints_in_create(table, stream)
+        if (exclusion_constraints = @connection.exclusion_constraints(table)).any?


do you need to check @connection.supports_exclusion_constraints? here?

Nope, we shouldn't need to, as the caller of this private method does that for us!

activerecord/lib/active_record/schema_dumper.rb

ghiculescu · 2021-06-03T19:08:51Z

activerecord/test/cases/migration/exclusion_constraint_test.rb

+        end
+
+        def test_add_exclusion_constraint_should_be_noop
+          @connection.add_exclusion_constraint :test_exclusion_constraints, "daterange(start_date, end_date) WITH &&", using: :gist, where: "start_date IS NOT NULL and end_date IS NOT NULL", name: "date_overlap"


as above. i think these should fail loudly.

activerecord/test/schema/schema.rb

hernanat · 2021-08-31T05:03:02Z

left another reply on the mailing list thread trying to get this moving forward

agrobbin · 2021-09-06T23:52:27Z

@ghiculescu thanks for the review here! I left some responses on some comments, but I think there are a couple of overarching questions that the Rails Core Team needs to answer ...

Should some of this code move to the PG-specific AR schema classes?
Should exceptions be raised in migrations by AR when someone tries to use a feature that is not supported by their database?

I followed the existing convention for both of those things, and while I think they're both great questions, they are significant deviations from the existing patterns, so I don't feel comfortable going down those roads without input from the Core Team.

rails-bot · 2021-12-06T00:38:57Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
Thank you for your contributions.

agrobbin · 2021-12-06T13:09:53Z

I would still love to get some resolution here!

hernanat · 2021-12-06T16:50:41Z

I would still love to get some resolution here!

+1

rails-bot · 2022-03-06T17:18:32Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
Thank you for your contributions.

agrobbin · 2022-05-26T01:27:30Z

@yahonda I just rebased off of the latest main, and resolved the outstanding comment I saw from @ghiculescu. Let me know if there's anything else I missed!

yahonda · 2022-05-31T11:53:27Z

While check constraints are popular and available for MySQL 8.0.16+, PostgreSQL, and SQLite3, exclusion constraints are available for PostgreSQL only.

Therefore ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaCreation#visit_AlterTable should be modified to support exclusion constraints not ActiveRecord::ConnectionAdapters::SchemaCreation#visit_AlterTable.

agrobbin · 2022-05-31T12:25:11Z

@yahonda updated!

agrobbin · 2022-05-31T12:30:38Z

@yahonda I'm going to do a quick pass and move some more of this into the PG-specific adapter code.

agrobbin · 2022-05-31T13:40:07Z

@yahonda OK, just passed tests, and should be more isolated to the PG-specific adapter code! Let me know if you see anything else worth adjusting, and thanks for the review.

yahonda

Left some review comments. Actually, this pull request size is relatively large (for me). I'll add some other reviews later.

activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb

activerecord/lib/active_record/connection_adapters.rb

activerecord/lib/active_record/connection_adapters/abstract/schema_creation.rb

yahonda

Add some more review comments.

activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb

yahonda · 2022-06-07T12:27:04Z

It would be appreciated if you push another commit, not force one because the review is in progress and it makes it difficult for me to review new changes. Once reviews are completed, I (or someone else) may ask you to squash commits.

agrobbin · 2022-06-07T12:28:25Z

@yahonda sorry about that, I'll do that going forward.

yahonda · 2022-06-14T11:46:02Z

It looks good to me. Please address the conflict with CHANGELOG.md and squash your commits.

```ruby add_exclusion_constraint :invoices, "daterange(start_date, end_date) WITH &&", using: :gist, name: "invoices_date_overlap" remove_exclusion_constraint :invoices, name: "invoices_date_overlap" ``` See PostgreSQL's [`CREATE TABLE ... EXCLUDE ...`](https://www.postgresql.org/docs/12/sql-createtable.html#SQL-CREATETABLE-EXCLUDE) documentation for more on exclusion constraints.

agrobbin · 2022-06-14T12:10:38Z

@yahonda conflict addressed and squash+rebased off of the latest main!

agrobbin · 2022-06-14T12:57:41Z

Woo, thanks so much for your help getting this over the line @yahonda!

rails-bot bot added the activerecord label Sep 13, 2020

agrobbin force-pushed the postgresql-exclusion-constraints branch from 8ab6c83 to 1ac2c8e Compare September 13, 2020 02:49

rails-bot bot added the stale label Dec 12, 2020

rails-bot bot removed the stale label Dec 13, 2020

Base automatically changed from master to main January 14, 2021 17:02

agrobbin force-pushed the postgresql-exclusion-constraints branch 2 times, most recently from 8e10e68 to 425de72 Compare March 29, 2021 13:46

agrobbin force-pushed the postgresql-exclusion-constraints branch from 425de72 to 8ec4fcb Compare June 2, 2021 15:55

ghiculescu reviewed Jun 3, 2021

View reviewed changes

activerecord/lib/active_record/connection_adapters/abstract/schema_creation.rb Outdated Show resolved Hide resolved

ghiculescu reviewed Jun 3, 2021

View reviewed changes

activerecord/lib/active_record/connection_adapters/abstract/schema_creation.rb Outdated Show resolved Hide resolved

ghiculescu reviewed Jun 3, 2021

View reviewed changes

activerecord/lib/active_record/schema_dumper.rb Show resolved Hide resolved

ghiculescu reviewed Jun 3, 2021

View reviewed changes

activerecord/test/schema/schema.rb Outdated Show resolved Hide resolved

rails-bot bot added the stale label Dec 6, 2021

rails-bot bot removed the stale label Dec 6, 2021

quorak mentioned this pull request Feb 28, 2022

Using methods as column name in add_exclusion_constraint nullobject/rein#58

Open

agrobbin force-pushed the postgresql-exclusion-constraints branch from e3cf854 to 427b5e9 Compare May 26, 2022 01:26

ghiculescu approved these changes May 26, 2022

View reviewed changes

agrobbin force-pushed the postgresql-exclusion-constraints branch from 427b5e9 to 28cfdc5 Compare May 31, 2022 12:22

agrobbin force-pushed the postgresql-exclusion-constraints branch 2 times, most recently from 81abed9 to 34b5d06 Compare May 31, 2022 13:24

yahonda reviewed Jun 7, 2022

View reviewed changes

agrobbin force-pushed the postgresql-exclusion-constraints branch from 34b5d06 to 1f6bae9 Compare June 7, 2022 12:22

agrobbin force-pushed the postgresql-exclusion-constraints branch from 1f6bae9 to 1ceffeb Compare June 14, 2022 12:09

yahonda merged commit 6d70379 into rails:main Jun 14, 2022

cbortz mentioned this pull request Jul 28, 2022

[Idea] Are there any concerns about creating PostgreSQL exclusion constraints (gist)? ankane/strong_migrations#191

Closed

alpaca-tc mentioned this pull request Oct 4, 2022

Add support for unique constraints (PostgreSQL-only). #46192

Merged

9 tasks

roleme mentioned this pull request Nov 10, 2022

[BDX-10135] add support rails 7.x quorso/active_record-postgres-constraints#2

Merged

alpaca-tc mentioned this pull request Mar 13, 2023

Adds support for deferrable exclude constraints in PostgreSQL. #47655

Merged

4 tasks

ghiculescu mentioned this pull request Apr 21, 2023

Missing Postgres features in Postgres guide #48011

Closed

agrobbin mentioned this pull request Apr 22, 2023

Add a section on exclusion constraints to the AR PostgreSQL guide #48019

Merged

alpaca-tc mentioned this pull request Oct 14, 2023

Support rails 7.1 ridgepole/ridgepole#441

Merged

This was referenced Dec 22, 2023

Add exclusion_constraint_exists? and unique_constraint_exists? helpers #50431

Open

Document missing :using and :where options for add_exclusion_constraint [skip ci] #50432

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for exclusion constraints (PostgreSQL-only) #40224

Add support for exclusion constraints (PostgreSQL-only) #40224

agrobbin commented Sep 13, 2020

rails-bot bot commented Dec 12, 2020

agrobbin commented Dec 13, 2020

hernanat commented Apr 23, 2021

hernanat commented May 6, 2021

agrobbin commented Jun 2, 2021

zzak commented Jun 3, 2021

ghiculescu Jun 3, 2021

hernanat Jun 3, 2021

agrobbin Sep 6, 2021

ghiculescu Jun 3, 2021

agrobbin Sep 6, 2021

ghiculescu Jun 3, 2021

hernanat commented Aug 31, 2021

agrobbin commented Sep 6, 2021

rails-bot bot commented Dec 6, 2021

agrobbin commented Dec 6, 2021

hernanat commented Dec 6, 2021

rails-bot bot commented Mar 6, 2022

agrobbin commented May 26, 2022 •

edited

yahonda commented May 31, 2022

agrobbin commented May 31, 2022

agrobbin commented May 31, 2022

agrobbin commented May 31, 2022

yahonda left a comment

yahonda left a comment

yahonda commented Jun 7, 2022

agrobbin commented Jun 7, 2022

yahonda commented Jun 14, 2022

agrobbin commented Jun 14, 2022

agrobbin commented Jun 14, 2022

Add support for exclusion constraints (PostgreSQL-only) #40224

Add support for exclusion constraints (PostgreSQL-only) #40224

Conversation

agrobbin commented Sep 13, 2020

Summary

rails-bot bot commented Dec 12, 2020

agrobbin commented Dec 13, 2020

hernanat commented Apr 23, 2021

hernanat commented May 6, 2021

agrobbin commented Jun 2, 2021

zzak commented Jun 3, 2021

ghiculescu Jun 3, 2021

Choose a reason for hiding this comment

hernanat Jun 3, 2021

Choose a reason for hiding this comment

agrobbin Sep 6, 2021

Choose a reason for hiding this comment

ghiculescu Jun 3, 2021

Choose a reason for hiding this comment

agrobbin Sep 6, 2021

Choose a reason for hiding this comment

ghiculescu Jun 3, 2021

Choose a reason for hiding this comment

hernanat commented Aug 31, 2021

agrobbin commented Sep 6, 2021

rails-bot bot commented Dec 6, 2021

agrobbin commented Dec 6, 2021

hernanat commented Dec 6, 2021

rails-bot bot commented Mar 6, 2022

agrobbin commented May 26, 2022 • edited

yahonda commented May 31, 2022

agrobbin commented May 31, 2022

agrobbin commented May 31, 2022

agrobbin commented May 31, 2022

yahonda left a comment

Choose a reason for hiding this comment

yahonda left a comment

Choose a reason for hiding this comment

yahonda commented Jun 7, 2022

agrobbin commented Jun 7, 2022

yahonda commented Jun 14, 2022

agrobbin commented Jun 14, 2022

agrobbin commented Jun 14, 2022

agrobbin commented May 26, 2022 •

edited