instance method drop_enum

Ruby on Rails edge

Since v7.1.6

Available in: v7.1.6 v7.2.3.2 v8.0.5.1 v8.1.3.1 edge

Signature

drop_enum(name, values = nil, **options)

Drops an enum type.

If the if_exists: true option is provided, the enum is dropped only if it exists. Otherwise, if the enum doesn’t exist, an error is raised.

The values parameter will be ignored if present. It can be helpful to provide this in a migration’s change method so it can be reverted. In that case, values will be used by #create_enum.

Parameters

name req
values opt = nil
options keyrest
Source
# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 660
      def drop_enum(name, values = nil, **options)
        query = <<~SQL
          DROP TYPE#{' IF EXISTS' if options[:if_exists]} #{quote_table_name(name)};
        SQL
        query_command(query)
        reload_type_map
      end

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

Defined in ActiveRecord::ConnectionAdapters::PostgreSQLAdapter

Type at least 2 characters to search.

Use the arrow keys to navigate results, Enter to open one, Escape to close.

Keyboard shortcuts

/
Focus search
⌘K / Ctrl-K
Command palette
?
This help
Esc
Close