method

add_exclusion_constraint

v8.0.0 - Show latest stable - 0 notes - Class: SchemaStatements

1.0.0
1.1.6
1.2.6
2.0.3
2.1.0
2.2.1
2.3.8
3.0.0
3.0.9
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0
7.1.3.2 (0)
7.1.3.4 (0)
7.2.3 (38)
8.0.0 (0)
8.1.1 (0)
What's this?

add_exclusion_constraint(table_name, expression, **options) public

Adds a new exclusion constraint to the table. expression is a String representation of a list of exclusion elements and operators.

add_exclusion_constraint :products, "price WITH =, availability_range WITH &&", using: :gist, name: "price_check"

generates:

ALTER TABLE "products" ADD CONSTRAINT price_check EXCLUDE USING gist (price WITH =, availability_range WITH &&)

The options hash can include the following keys:

:name: The constraint name. Defaults to excl_rails_<identifier>.
:deferrable: Specify whether or not the exclusion constraint should be deferrable. Valid values are false or :immediate or :deferred to specify the default behavior. Defaults to false.
:using: Specify which index method to use when creating this exclusion constraint (e.g. :btree, :gist etc).
:where: Specify an exclusion constraint on a subset of the table (internally PostgreSQL creates a partial index for this).

Show source

# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 745
        def add_exclusion_constraint(table_name, expression, **options)
          options = exclusion_constraint_options(table_name, expression, options)
          at = create_alter_table(table_name)
          at.add_exclusion_constraint(expression, options)

          execute schema_creation.accept(at)
        end

add_exclusion_constraint

Related methods