method

remove_reference

v7.1.3.4 - 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 (0)
4.1.8 (0)
4.2.1 (38)
4.2.7 (0)
4.2.9 (0)
5.0.0.1 (-14)
5.1.7 (0)
5.2.3 (0)
6.0.0 (-4)
6.1.3.1 (0)
6.1.7.7 (0)
7.0.0 (0)
7.1.3.2 (-18)
7.1.3.4 (0)
What's this?

remove_reference(table_name, ref_name, foreign_key: false, polymorphic: false, **options) public

Removes the reference(s). Also removes a type column if one exists.

Remove the reference

remove_reference(:products, :user, index: false)

Remove polymorphic reference

remove_reference(:products, :supplier, polymorphic: true)

Remove the reference with a foreign key

remove_reference(:products, :user, foreign_key: true)

Show source

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 1049
      def remove_reference(table_name, ref_name, foreign_key: false, polymorphic: false, **options)
        conditional_options = options.slice(:if_exists, :if_not_exists)

        if foreign_key
          reference_name = Base.pluralize_table_names ? ref_name.to_s.pluralize : ref_name
          if foreign_key.is_a?(Hash)
            foreign_key_options = foreign_key.merge(conditional_options)
          else
            foreign_key_options = { to_table: reference_name, **conditional_options }
          end
          foreign_key_options[:column] ||= "#{ref_name}_id"
          remove_foreign_key(table_name, **foreign_key_options)
        end

        remove_column(table_name, "#{ref_name}_id", **conditional_options)
        remove_column(table_name, "#{ref_name}_type", **conditional_options) if polymorphic
      end

remove_reference

Related methods

Remove the reference

Remove polymorphic reference

Remove the reference with a foreign key