method

add_check_constraint

v7.1.3.2 - Show latest stable - 0 notes - Class: ActiveRecord::ConnectionAdapters::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 (0)
6.1.7.7 (0)
7.0.0 (0)
7.1.3.2 (38)
7.1.3.4 (0)
What's this?

add_check_constraint(table_name, expression, if_not_exists: false, **options) public

Adds a new check constraint to the table. expression is a String representation of verifiable boolean condition.

add_check_constraint :products, "price > 0", name: "price_check"

generates:

ALTER TABLE "products" ADD CONSTRAINT price_check CHECK (price > 0)

The options hash can include the following keys:

:name: The constraint name. Defaults to chk_rails_<identifier>.
:if_not_exists: Silently ignore if the constraint already exists, rather than raise an error.
:validate: (PostgreSQL only) Specify whether or not the constraint should be validated. Defaults to true.

Show source

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 1260
      def add_check_constraint(table_name, expression, if_not_exists: false, **options)
        return unless supports_check_constraints?

        options = check_constraint_options(table_name, expression, options)
        return if if_not_exists && check_constraint_exists?(table_name, **options)

        at = create_alter_table(table_name)
        at.add_check_constraint(expression, options)

        execute schema_creation.accept(at)
      end

add_check_constraint

Related methods