instance method `drop_table`

Ruby on Rails 8.1.2

Since v4.1.16

Available in: 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:

drop_table(*table_names, **options)

Drops a table or tables from the database.

:force: Set to :cascade to drop dependent objects as well. Defaults to false.
:if_exists: Set to true to only drop the table if it exists. Defaults to false.
:temporary: Set to true to drop temporary table. Defaults to false.

Although this command ignores most options and the block if one is given, it can be helpful to provide these in a migration’s change method so it can be reverted. In that case, options and the block will be used by #create_table except if you provide more than one table which is not supported.

Parameters

table_names rest
options keyrest

Source

# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 362
      def drop_table(*table_names, **options)
        table_names.each { |table_name| schema_cache.clear_data_source_cache!(table_name.to_s) }
        execute "DROP#{' TEMPORARY' if options[:temporary]} TABLE#{' IF EXISTS' if options[:if_exists]} #{table_names.map { |table_name| quote_table_name(table_name) }.join(', ')}#{' CASCADE' if options[:force] == :cascade}"
      end

Defined in activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb line 362 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter

Signature

Parameters