instance method `remove_index`

Ruby on Rails 2.3.18

Since v2.2.3

Available in: v2.2.3 v2.3.18 v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

remove_index(table_name, options = {})

Remove the given index from the table.

Remove the suppliers_name_index in the suppliers table.

remove_index :suppliers, :name

Remove the index named accounts_branch_id_index in the accounts table.

remove_index :accounts, :column => :branch_id

Remove the index named accounts_branch_id_party_id_index in the accounts table.

remove_index :accounts, :column => [:branch_id, :party_id]

Remove the index named by_branch_party in the accounts table.

remove_index :accounts, :name => :by_branch_party

Parameters

table_name req
options opt = {}

Source

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 305
      def remove_index(table_name, options = {})
        index_name = index_name(table_name, options)
        unless index_exists?(table_name, index_name, true)
          @logger.warn("Index name '#{index_name}' on table '#{table_name}' does not exist. Skipping.")
          return
        end
        remove_index!(table_name, index_name)
      end

Defined in activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb line 305 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveRecord::ConnectionAdapters::SchemaStatements

Signature

Parameters