activerecord 3.2.6 → 6.0.0

data/lib/active_record/connection_adapters/abstract/schema_statements.rb

@@ -1,119 +1,202 @@
-require 'active_support/core_ext/array/wrap'
-require 'active_support/deprecation/reporting'
+# frozen_string_literal: true
+
+require "active_record/migration/join_table"
+require "active_support/core_ext/string/access"
+require "active_support/deprecation"
+require "digest/sha2"
 
 module ActiveRecord
   module ConnectionAdapters # :nodoc:
     module SchemaStatements
-      # Returns a Hash of mappings from the abstract data types to the native
+      include ActiveRecord::Migration::JoinTable
+
+      # Returns a hash of mappings from the abstract data types to the native
       # database types. See TableDefinition#column for details on the recognized
       # abstract data types.
       def native_database_types
         {}
       end
 
+      def table_options(table_name)
+        nil
+      end
+
+      # Returns the table comment that's stored in database metadata.
+      def table_comment(table_name)
+        nil
+      end
+
       # Truncates a table alias according to the limits of the current adapter.
       def table_alias_for(table_name)
-        table_name[0...table_alias_length].gsub(/\./, '_')
+        table_name[0...table_alias_length].tr(".", "_")
+      end
+
+      # Returns the relation names useable to back Active Record models.
+      # For most adapters this means all #tables and #views.
+      def data_sources
+        query_values(data_source_sql, "SCHEMA")
+      rescue NotImplementedError
+        tables | views
+      end
+
+      # Checks to see if the data source +name+ exists on the database.
+      #
+      #   data_source_exists?(:ebooks)
+      #
+      def data_source_exists?(name)
+        query_values(data_source_sql(name), "SCHEMA").any? if name.present?
+      rescue NotImplementedError
+        data_sources.include?(name.to_s)
+      end
+
+      # Returns an array of table names defined in the database.
+      def tables
+        query_values(data_source_sql(type: "BASE TABLE"), "SCHEMA")
       end
 
       # Checks to see if the table +table_name+ exists on the database.
       #
-      # === Example
       #   table_exists?(:developers)
+      #
       def table_exists?(table_name)
+        query_values(data_source_sql(table_name, type: "BASE TABLE"), "SCHEMA").any? if table_name.present?
+      rescue NotImplementedError
         tables.include?(table_name.to_s)
       end
 
+      # Returns an array of view names defined in the database.
+      def views
+        query_values(data_source_sql(type: "VIEW"), "SCHEMA")
+      end
+
+      # Checks to see if the view +view_name+ exists on the database.
+      #
+      #   view_exists?(:ebooks)
+      #
+      def view_exists?(view_name)
+        query_values(data_source_sql(view_name, type: "VIEW"), "SCHEMA").any? if view_name.present?
+      rescue NotImplementedError
+        views.include?(view_name.to_s)
+      end
+
       # Returns an array of indexes for the given table.
-      # def indexes(table_name, name = nil) end
+      def indexes(table_name)
+        raise NotImplementedError, "#indexes is not implemented"
+      end
 
       # Checks to see if an index exists on a table for a given index definition.
       #
-      # === Examples
-      #  # Check an index exists
-      #  index_exists?(:suppliers, :company_id)
+      #   # Check an index exists
+      #   index_exists?(:suppliers, :company_id)
+      #
+      #   # Check an index on multiple columns exists
+      #   index_exists?(:suppliers, [:company_id, :company_type])
       #
-      #  # Check an index on multiple columns exists
-      #  index_exists?(:suppliers, [:company_id, :company_type])
+      #   # Check a unique index exists
+      #   index_exists?(:suppliers, :company_id, unique: true)
       #
-      #  # Check a unique index exists
-      #  index_exists?(:suppliers, :company_id, :unique => true)
+      #   # Check an index with a custom name exists
+      #   index_exists?(:suppliers, :company_id, name: "idx_company_id")
       #
-      #  # Check an index with a custom name exists
-      #  index_exists?(:suppliers, :company_id, :name => "idx_company_id"
       def index_exists?(table_name, column_name, options = {})
-        column_names = Array.wrap(column_name)
-        index_name = options.key?(:name) ? options[:name].to_s : index_name(table_name, :column => column_names)
-        if options[:unique]
-          indexes(table_name).any?{ |i| i.unique && i.name == index_name }
-        else
-          indexes(table_name).any?{ |i| i.name == index_name }
-        end
+        column_names = Array(column_name).map(&:to_s)
+        checks = []
+        checks << lambda { |i| Array(i.columns) == column_names }
+        checks << lambda { |i| i.unique } if options[:unique]
+        checks << lambda { |i| i.name == options[:name].to_s } if options[:name]
+
+        indexes(table_name).any? { |i| checks.all? { |check| check[i] } }
       end
 
-      # Returns an array of Column objects for the table specified by +table_name+.
-      # See the concrete implementation for details on the expected parameter values.
-      def columns(table_name, name = nil) end
+      # Returns an array of +Column+ objects for the table specified by +table_name+.
+      def columns(table_name)
+        table_name = table_name.to_s
+        column_definitions(table_name).map do |field|
+          new_column_from_field(table_name, field)
+        end
+      end
 
       # Checks to see if a column exists in a given table.
       #
-      # === Examples
-      #  # Check a column exists
-      #  column_exists?(:suppliers, :name)
+      #   # Check a column exists
+      #   column_exists?(:suppliers, :name)
       #
-      #  # Check a column exists of a particular type
-      #  column_exists?(:suppliers, :name, :string)
+      #   # Check a column exists of a particular type
+      #   column_exists?(:suppliers, :name, :string)
       #
-      #  # Check a column exists with a specific definition
-      #  column_exists?(:suppliers, :name, :string, :limit => 100)
-      def column_exists?(table_name, column_name, type = nil, options = {})
-        columns(table_name).any?{ |c| c.name == column_name.to_s &&
-                                      (!type                 || c.type == type) &&
-                                      (!options[:limit]      || c.limit == options[:limit]) &&
-                                      (!options[:precision]  || c.precision == options[:precision]) &&
-                                      (!options[:scale]      || c.scale == options[:scale]) }
+      #   # Check a column exists with a specific definition
+      #   column_exists?(:suppliers, :name, :string, limit: 100)
+      #   column_exists?(:suppliers, :name, :string, default: 'default')
+      #   column_exists?(:suppliers, :name, :string, null: false)
+      #   column_exists?(:suppliers, :tax, :decimal, precision: 8, scale: 2)
+      #
+      def column_exists?(table_name, column_name, type = nil, **options)
+        column_name = column_name.to_s
+        checks = []
+        checks << lambda { |c| c.name == column_name }
+        checks << lambda { |c| c.type == type.to_sym rescue nil } if type
+        column_options_keys.each do |attr|
+          checks << lambda { |c| c.send(attr) == options[attr] } if options.key?(attr)
+        end
+
+        columns(table_name).any? { |c| checks.all? { |check| check[c] } }
+      end
+
+      # Returns just a table's primary key
+      def primary_key(table_name)
+        pk = primary_keys(table_name)
+        pk = pk.first unless pk.size > 1
+        pk
       end
 
       # Creates a new table with the name +table_name+. +table_name+ may either
       # be a String or a Symbol.
       #
-      # There are two ways to work with +create_table+. You can use the block
+      # There are two ways to work with #create_table. You can use the block
       # form or the regular form, like this:
       #
       # === Block form
-      #  # create_table() passes a TableDefinition object to the block.
-      #  # This form will not only create the table, but also columns for the
-      #  # table.
       #
-      #  create_table(:suppliers) do |t|
-      #    t.column :name, :string, :limit => 60
-      #    # Other fields here
-      #  end
+      #   # create_table() passes a TableDefinition object to the block.
+      #   # This form will not only create the table, but also columns for the
+      #   # table.
+      #
+      #   create_table(:suppliers) do |t|
+      #     t.column :name, :string, limit: 60
+      #     # Other fields here
+      #   end
       #
       # === Block form, with shorthand
-      #  # You can also use the column types as method calls, rather than calling the column method.
-      #  create_table(:suppliers) do |t|
-      #    t.string :name, :limit => 60
-      #    # Other fields here
-      #  end
+      #
+      #   # You can also use the column types as method calls, rather than calling the column method.
+      #   create_table(:suppliers) do |t|
+      #     t.string :name, limit: 60
+      #     # Other fields here
+      #   end
       #
       # === Regular form
-      #  # Creates a table called 'suppliers' with no columns.
-      #  create_table(:suppliers)
-      #  # Add a column to 'suppliers'.
-      #  add_column(:suppliers, :name, :string, {:limit => 60})
+      #
+      #   # Creates a table called 'suppliers' with no columns.
+      #   create_table(:suppliers)
+      #   # Add a column to 'suppliers'.
+      #   add_column(:suppliers, :name, :string, {limit: 60})
       #
       # The +options+ hash can include the following keys:
       # [<tt>:id</tt>]
       #   Whether to automatically add a primary key column. Defaults to true.
-      #   Join tables for +has_and_belongs_to_many+ should set it to false.
+      #   Join tables for {ActiveRecord::Base.has_and_belongs_to_many}[rdoc-ref:Associations::ClassMethods#has_and_belongs_to_many] should set it to false.
+      #
+      #   A Symbol can be used to specify the type of the generated primary key column.
       # [<tt>:primary_key</tt>]
       #   The name of the primary key, if one is to be added automatically.
-      #   Defaults to +id+. If <tt>:id</tt> is false this option is ignored.
+      #   Defaults to +id+. If <tt>:id</tt> is false, then this option is ignored.
       #
-      #   Also note that this just sets the primary key in the table. You additionally
-      #   need to configure the primary key in the model via +self.primary_key=+.
-      #   Models do NOT auto-detect the primary key from their table definition.
+      #   If an array is passed, a composite primary key will be created.
+      #
+      #   Note that Active Record models will automatically detect their
+      #   primary key. This can be avoided by using
+      #   {self.primary_key=}[rdoc-ref:AttributeMethods::PrimaryKey::ClassMethods#primary_key=] on the model
+      #   to define the key explicitly.
       #
       # [<tt>:options</tt>]
       #   Any extra options you want appended to the table definition.
@@ -121,187 +204,468 @@ module ActiveRecord
       #   Make a temporary table.
       # [<tt>:force</tt>]
       #   Set to true to drop the table before creating it.
+      #   Set to +:cascade+ to drop dependent objects as well.
+      #   Defaults to false.
+      # [<tt>:if_not_exists</tt>]
+      #   Set to true to avoid raising an error when the table already exists.
       #   Defaults to false.
+      # [<tt>:as</tt>]
+      #   SQL to use to generate the table. When this option is used, the block is
+      #   ignored, as are the <tt>:id</tt> and <tt>:primary_key</tt> options.
       #
-      # ===== Examples
       # ====== Add a backend specific option to the generated SQL (MySQL)
-      #  create_table(:suppliers, :options => 'ENGINE=InnoDB DEFAULT CHARSET=utf8')
+      #
+      #   create_table(:suppliers, options: 'ENGINE=InnoDB DEFAULT CHARSET=utf8mb4')
+      #
       # generates:
-      #  CREATE TABLE suppliers (
-      #    id int(11) DEFAULT NULL auto_increment PRIMARY KEY
-      #  ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+      #
+      #   CREATE TABLE suppliers (
+      #     id bigint auto_increment PRIMARY KEY
+      #   ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4
       #
       # ====== Rename the primary key column
-      #  create_table(:objects, :primary_key => 'guid') do |t|
-      #    t.column :name, :string, :limit => 80
-      #  end
+      #
+      #   create_table(:objects, primary_key: 'guid') do |t|
+      #     t.column :name, :string, limit: 80
+      #   end
+      #
+      # generates:
+      #
+      #   CREATE TABLE objects (
+      #     guid bigint auto_increment PRIMARY KEY,
+      #     name varchar(80)
+      #   )
+      #
+      # ====== Change the primary key column type
+      #
+      #   create_table(:tags, id: :string) do |t|
+      #     t.column :label, :string
+      #   end
+      #
+      # generates:
+      #
+      #   CREATE TABLE tags (
+      #     id varchar PRIMARY KEY,
+      #     label varchar
+      #   )
+      #
+      # ====== Create a composite primary key
+      #
+      #   create_table(:orders, primary_key: [:product_id, :client_id]) do |t|
+      #     t.belongs_to :product
+      #     t.belongs_to :client
+      #   end
+      #
       # generates:
-      #  CREATE TABLE objects (
-      #    guid int(11) DEFAULT NULL auto_increment PRIMARY KEY,
-      #    name varchar(80)
-      #  )
+      #
+      #   CREATE TABLE order (
+      #       product_id bigint NOT NULL,
+      #       client_id bigint NOT NULL
+      #   );
+      #
+      #   ALTER TABLE ONLY "orders"
+      #     ADD CONSTRAINT orders_pkey PRIMARY KEY (product_id, client_id);
       #
       # ====== Do not add a primary key column
-      #  create_table(:categories_suppliers, :id => false) do |t|
-      #    t.column :category_id, :integer
-      #    t.column :supplier_id, :integer
-      #  end
+      #
+      #   create_table(:categories_suppliers, id: false) do |t|
+      #     t.column :category_id, :bigint
+      #     t.column :supplier_id, :bigint
+      #   end
+      #
       # generates:
-      #  CREATE TABLE categories_suppliers (
-      #    category_id int,
-      #    supplier_id int
-      #  )
+      #
+      #   CREATE TABLE categories_suppliers (
+      #     category_id bigint,
+      #     supplier_id bigint
+      #   )
+      #
+      # ====== Create a temporary table based on a query
+      #
+      #   create_table(:long_query, temporary: true,
+      #     as: "SELECT * FROM orders INNER JOIN line_items ON order_id=orders.id")
+      #
+      # generates:
+      #
+      #   CREATE TEMPORARY TABLE long_query AS
+      #     SELECT * FROM orders INNER JOIN line_items ON order_id=orders.id
       #
       # See also TableDefinition#column for details on how to create columns.
-      def create_table(table_name, options = {})
-        td = table_definition
-        td.primary_key(options[:primary_key] || Base.get_primary_key(table_name.to_s.singularize)) unless options[:id] == false
+      def create_table(table_name, **options)
+        td = create_table_definition(table_name, options)
+
+        if options[:id] != false && !options[:as]
+          pk = options.fetch(:primary_key) do
+            Base.get_primary_key table_name.to_s.singularize
+          end
+
+          if pk.is_a?(Array)
+            td.primary_keys pk
+          else
+            td.primary_key pk, options.fetch(:id, :primary_key), options.except(:comment)
+          end
+        end
 
         yield td if block_given?
 
-        if options[:force] && table_exists?(table_name)
-          drop_table(table_name, options)
+        if options[:force]
+          drop_table(table_name, options.merge(if_exists: true))
+        end
+
+        result = execute schema_creation.accept td
+
+        unless supports_indexes_in_create?
+          td.indexes.each do |column_name, index_options|
+            add_index(table_name, column_name, index_options)
+          end
+        end
+
+        if supports_comments? && !supports_comments_in_create?
+          if table_comment = options[:comment].presence
+            change_table_comment(table_name, table_comment)
+          end
+
+          td.columns.each do |column|
+            change_column_comment(table_name, column.name, column.comment) if column.comment.present?
+          end
         end
 
-        create_sql = "CREATE#{' TEMPORARY' if options[:temporary]} TABLE "
-        create_sql << "#{quote_table_name(table_name)} ("
-        create_sql << td.to_sql
-        create_sql << ") #{options[:options]}"
-        execute create_sql
+        result
+      end
+
+      # Creates a new join table with the name created using the lexical order of the first two
+      # arguments. These arguments can be a String or a Symbol.
+      #
+      #   # Creates a table called 'assemblies_parts' with no id.
+      #   create_join_table(:assemblies, :parts)
+      #
+      # You can pass an +options+ hash which can include the following keys:
+      # [<tt>:table_name</tt>]
+      #   Sets the table name, overriding the default.
+      # [<tt>:column_options</tt>]
+      #   Any extra options you want appended to the columns definition.
+      # [<tt>:options</tt>]
+      #   Any extra options you want appended to the table definition.
+      # [<tt>:temporary</tt>]
+      #   Make a temporary table.
+      # [<tt>:force</tt>]
+      #   Set to true to drop the table before creating it.
+      #   Defaults to false.
+      #
+      # Note that #create_join_table does not create any indices by default; you can use
+      # its block form to do so yourself:
+      #
+      #   create_join_table :products, :categories do |t|
+      #     t.index :product_id
+      #     t.index :category_id
+      #   end
+      #
+      # ====== Add a backend specific option to the generated SQL (MySQL)
+      #
+      #   create_join_table(:assemblies, :parts, options: 'ENGINE=InnoDB DEFAULT CHARSET=utf8')
+      #
+      # generates:
+      #
+      #   CREATE TABLE assemblies_parts (
+      #     assembly_id bigint NOT NULL,
+      #     part_id bigint NOT NULL,
+      #   ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+      #
+      def create_join_table(table_1, table_2, column_options: {}, **options)
+        join_table_name = find_join_table_name(table_1, table_2, options)
+
+        column_options.reverse_merge!(null: false, index: false)
+
+        t1_ref, t2_ref = [table_1, table_2].map { |t| t.to_s.singularize }
+
+        create_table(join_table_name, options.merge!(id: false)) do |td|
+          td.references t1_ref, column_options
+          td.references t2_ref, column_options
+          yield td if block_given?
+        end
+      end
+
+      # Drops the join table specified by the given arguments.
+      # See #create_join_table for details.
+      #
+      # Although this command ignores the block if one is given, it can be helpful
+      # to provide one in a migration's +change+ method so it can be reverted.
+      # In that case, the block will be used by #create_join_table.
+      def drop_join_table(table_1, table_2, options = {})
+        join_table_name = find_join_table_name(table_1, table_2, options)
+        drop_table(join_table_name)
       end
 
       # A block for changing columns in +table+.
       #
-      # === Example
-      #  # change_table() yields a Table instance
-      #  change_table(:suppliers) do |t|
-      #    t.column :name, :string, :limit => 60
-      #    # Other column alterations here
-      #  end
+      #   # change_table() yields a Table instance
+      #   change_table(:suppliers) do |t|
+      #     t.column :name, :string, limit: 60
+      #     # Other column alterations here
+      #   end
       #
       # The +options+ hash can include the following keys:
       # [<tt>:bulk</tt>]
       #   Set this to true to make this a bulk alter query, such as
-      #   ALTER TABLE `users` ADD COLUMN age INT(11), ADD COLUMN birthdate DATETIME ...
+      #
+      #     ALTER TABLE `users` ADD COLUMN age INT, ADD COLUMN birthdate DATETIME ...
       #
       #   Defaults to false.
       #
-      # ===== Examples
+      #   Only supported on the MySQL and PostgreSQL adapter, ignored elsewhere.
+      #
       # ====== Add a column
-      #  change_table(:suppliers) do |t|
-      #    t.column :name, :string, :limit => 60
-      #  end
+      #
+      #   change_table(:suppliers) do |t|
+      #     t.column :name, :string, limit: 60
+      #   end
       #
       # ====== Add 2 integer columns
-      #  change_table(:suppliers) do |t|
-      #    t.integer :width, :height, :null => false, :default => 0
-      #  end
+      #
+      #   change_table(:suppliers) do |t|
+      #     t.integer :width, :height, null: false, default: 0
+      #   end
       #
       # ====== Add created_at/updated_at columns
-      #  change_table(:suppliers) do |t|
-      #    t.timestamps
-      #  end
+      #
+      #   change_table(:suppliers) do |t|
+      #     t.timestamps
+      #   end
       #
       # ====== Add a foreign key column
-      #  change_table(:suppliers) do |t|
-      #    t.references :company
-      #  end
       #
-      # Creates a <tt>company_id(integer)</tt> column
+      #   change_table(:suppliers) do |t|
+      #     t.references :company
+      #   end
+      #
+      # Creates a <tt>company_id(bigint)</tt> column.
       #
       # ====== Add a polymorphic foreign key column
+      #
       #  change_table(:suppliers) do |t|
-      #    t.belongs_to :company, :polymorphic => true
+      #    t.belongs_to :company, polymorphic: true
       #  end
       #
-      # Creates <tt>company_type(varchar)</tt> and <tt>company_id(integer)</tt> columns
+      # Creates <tt>company_type(varchar)</tt> and <tt>company_id(bigint)</tt> columns.
       #
       # ====== Remove a column
+      #
       #  change_table(:suppliers) do |t|
       #    t.remove :company
       #  end
       #
       # ====== Remove several columns
+      #
       #  change_table(:suppliers) do |t|
       #    t.remove :company_id
       #    t.remove :width, :height
       #  end
       #
       # ====== Remove an index
+      #
       #  change_table(:suppliers) do |t|
       #    t.remove_index :company_id
       #  end
       #
-      # See also Table for details on
-      # all of the various column transformation
+      # See also Table for details on all of the various column transformations.
       def change_table(table_name, options = {})
         if supports_bulk_alter? && options[:bulk]
           recorder = ActiveRecord::Migration::CommandRecorder.new(self)
-          yield Table.new(table_name, recorder)
+          yield update_table_definition(table_name, recorder)
           bulk_change_table(table_name, recorder.commands)
         else
-          yield Table.new(table_name, self)
+          yield update_table_definition(table_name, self)
         end
       end
 
       # Renames a table.
-      # ===== Example
-      #  rename_table('octopuses', 'octopi')
+      #
+      #   rename_table('octopuses', 'octopi')
+      #
       def rename_table(table_name, new_name)
         raise NotImplementedError, "rename_table is not implemented"
       end
 
       # Drops a table from the database.
+      #
+      # [<tt>:force</tt>]
+      #   Set to +:cascade+ to drop dependent objects as well.
+      #   Defaults to false.
+      # [<tt>:if_exists</tt>]
+      #   Set to +true+ to only drop the table if it exists.
+      #   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.
       def drop_table(table_name, options = {})
-        execute "DROP TABLE #{quote_table_name(table_name)}"
+        execute "DROP TABLE#{' IF EXISTS' if options[:if_exists]} #{quote_table_name(table_name)}"
       end
 
-      # Adds a new column to the named table.
-      # See TableDefinition#column for details of the options you can use.
-      def add_column(table_name, column_name, type, options = {})
-        add_column_sql = "ALTER TABLE #{quote_table_name(table_name)} ADD #{quote_column_name(column_name)} #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}"
-        add_column_options!(add_column_sql, options)
-        execute(add_column_sql)
+      # Add a new +type+ column named +column_name+ to +table_name+.
+      #
+      # The +type+ parameter is normally one of the migrations native types,
+      # which is one of the following:
+      # <tt>:primary_key</tt>, <tt>:string</tt>, <tt>:text</tt>,
+      # <tt>:integer</tt>, <tt>:bigint</tt>, <tt>:float</tt>, <tt>:decimal</tt>, <tt>:numeric</tt>,
+      # <tt>:datetime</tt>, <tt>:time</tt>, <tt>:date</tt>,
+      # <tt>:binary</tt>, <tt>:boolean</tt>.
+      #
+      # You may use a type not in this list as long as it is supported by your
+      # database (for example, "polygon" in MySQL), but this will not be database
+      # agnostic and should usually be avoided.
+      #
+      # Available options are (none of these exists by default):
+      # * <tt>:limit</tt> -
+      #   Requests a maximum column length. This is the number of characters for a <tt>:string</tt> column
+      #   and number of bytes for <tt>:text</tt>, <tt>:binary</tt>, and <tt>:integer</tt> columns.
+      #   This option is ignored by some backends.
+      # * <tt>:default</tt> -
+      #   The column's default value. Use +nil+ for +NULL+.
+      # * <tt>:null</tt> -
+      #   Allows or disallows +NULL+ values in the column.
+      # * <tt>:precision</tt> -
+      #   Specifies the precision for the <tt>:decimal</tt>, <tt>:numeric</tt>,
+      #   <tt>:datetime</tt>, and <tt>:time</tt> columns.
+      # * <tt>:scale</tt> -
+      #   Specifies the scale for the <tt>:decimal</tt> and <tt>:numeric</tt> columns.
+      # * <tt>:collation</tt> -
+      #   Specifies the collation for a <tt>:string</tt> or <tt>:text</tt> column. If not specified, the
+      #   column will have the same collation as the table.
+      # * <tt>:comment</tt> -
+      #   Specifies the comment for the column. This option is ignored by some backends.
+      #
+      # Note: The precision is the total number of significant digits,
+      # and the scale is the number of digits that can be stored following
+      # the decimal point. For example, the number 123.45 has a precision of 5
+      # and a scale of 2. A decimal with a precision of 5 and a scale of 2 can
+      # range from -999.99 to 999.99.
+      #
+      # Please be aware of different RDBMS implementations behavior with
+      # <tt>:decimal</tt> columns:
+      # * The SQL standard says the default scale should be 0, <tt>:scale</tt> <=
+      #   <tt>:precision</tt>, and makes no comments about the requirements of
+      #   <tt>:precision</tt>.
+      # * MySQL: <tt>:precision</tt> [1..63], <tt>:scale</tt> [0..30].
+      #   Default is (10,0).
+      # * PostgreSQL: <tt>:precision</tt> [1..infinity],
+      #   <tt>:scale</tt> [0..infinity]. No default.
+      # * SQLite3: No restrictions on <tt>:precision</tt> and <tt>:scale</tt>,
+      #   but the maximum supported <tt>:precision</tt> is 16. No default.
+      # * Oracle: <tt>:precision</tt> [1..38], <tt>:scale</tt> [-84..127].
+      #   Default is (38,0).
+      # * DB2: <tt>:precision</tt> [1..63], <tt>:scale</tt> [0..62].
+      #   Default unknown.
+      # * SqlServer: <tt>:precision</tt> [1..38], <tt>:scale</tt> [0..38].
+      #   Default (38,0).
+      #
+      # == Examples
+      #
+      #  add_column(:users, :picture, :binary, limit: 2.megabytes)
+      #  # ALTER TABLE "users" ADD "picture" blob(2097152)
+      #
+      #  add_column(:articles, :status, :string, limit: 20, default: 'draft', null: false)
+      #  # ALTER TABLE "articles" ADD "status" varchar(20) DEFAULT 'draft' NOT NULL
+      #
+      #  add_column(:answers, :bill_gates_money, :decimal, precision: 15, scale: 2)
+      #  # ALTER TABLE "answers" ADD "bill_gates_money" decimal(15,2)
+      #
+      #  add_column(:measurements, :sensor_reading, :decimal, precision: 30, scale: 20)
+      #  # ALTER TABLE "measurements" ADD "sensor_reading" decimal(30,20)
+      #
+      #  # While :scale defaults to zero on most databases, it
+      #  # probably wouldn't hurt to include it.
+      #  add_column(:measurements, :huge_integer, :decimal, precision: 30)
+      #  # ALTER TABLE "measurements" ADD "huge_integer" decimal(30)
+      #
+      #  # Defines a column that stores an array of a type.
+      #  add_column(:users, :skills, :text, array: true)
+      #  # ALTER TABLE "users" ADD "skills" text[]
+      #
+      #  # Defines a column with a database-specific type.
+      #  add_column(:shapes, :triangle, 'polygon')
+      #  # ALTER TABLE "shapes" ADD "triangle" polygon
+      def add_column(table_name, column_name, type, **options)
+        at = create_alter_table table_name
+        at.add_column(column_name, type, options)
+        execute schema_creation.accept at
       end
 
-      # Removes the column(s) from the table definition.
-      # ===== Examples
-      #  remove_column(:suppliers, :qualification)
-      #  remove_columns(:suppliers, :qualification, :experience)
-      def remove_column(table_name, *column_names)
-        if column_names.flatten!
-          message = 'Passing array to remove_columns is deprecated, please use ' +
-                    'multiple arguments, like: `remove_columns(:posts, :foo, :bar)`'
-          ActiveSupport::Deprecation.warn message, caller
+      # Removes the given columns from the table definition.
+      #
+      #   remove_columns(:suppliers, :qualification, :experience)
+      #
+      def remove_columns(table_name, *column_names)
+        raise ArgumentError.new("You must specify at least one column name. Example: remove_columns(:people, :first_name)") if column_names.empty?
+        column_names.each do |column_name|
+          remove_column(table_name, column_name)
         end
+      end
 
-        columns_for_remove(table_name, *column_names).each do |column_name|
-          execute "ALTER TABLE #{quote_table_name(table_name)} DROP #{column_name}"
-        end
+      # Removes the column from the table definition.
+      #
+      #   remove_column(:suppliers, :qualification)
+      #
+      # The +type+ and +options+ parameters will be ignored if present. It can be helpful
+      # to provide these in a migration's +change+ method so it can be reverted.
+      # In that case, +type+ and +options+ will be used by #add_column.
+      # Indexes on the column are automatically removed.
+      def remove_column(table_name, column_name, type = nil, options = {})
+        execute "ALTER TABLE #{quote_table_name(table_name)} #{remove_column_for_alter(table_name, column_name, type, options)}"
       end
-      alias :remove_columns :remove_column
 
       # Changes the column's definition according to the new options.
       # See TableDefinition#column for details of the options you can use.
-      # ===== Examples
-      #  change_column(:suppliers, :name, :string, :limit => 80)
-      #  change_column(:accounts, :description, :text)
+      #
+      #   change_column(:suppliers, :name, :string, limit: 80)
+      #   change_column(:accounts, :description, :text)
+      #
       def change_column(table_name, column_name, type, options = {})
         raise NotImplementedError, "change_column is not implemented"
       end
 
-      # Sets a new default value for a column.
-      # ===== Examples
-      #  change_column_default(:suppliers, :qualification, 'new')
-      #  change_column_default(:accounts, :authorized, 1)
-      #  change_column_default(:users, :email, nil)
-      def change_column_default(table_name, column_name, default)
+      # Sets a new default value for a column:
+      #
+      #   change_column_default(:suppliers, :qualification, 'new')
+      #   change_column_default(:accounts, :authorized, 1)
+      #
+      # Setting the default to +nil+ effectively drops the default:
+      #
+      #   change_column_default(:users, :email, nil)
+      #
+      # Passing a hash containing +:from+ and +:to+ will make this change
+      # reversible in migration:
+      #
+      #   change_column_default(:posts, :state, from: nil, to: "draft")
+      #
+      def change_column_default(table_name, column_name, default_or_changes)
         raise NotImplementedError, "change_column_default is not implemented"
       end
 
+      # Sets or removes a <tt>NOT NULL</tt> constraint on a column. The +null+ flag
+      # indicates whether the value can be +NULL+. For example
+      #
+      #   change_column_null(:users, :nickname, false)
+      #
+      # says nicknames cannot be +NULL+ (adds the constraint), whereas
+      #
+      #   change_column_null(:users, :nickname, true)
+      #
+      # allows them to be +NULL+ (drops the constraint).
+      #
+      # The method accepts an optional fourth argument to replace existing
+      # <tt>NULL</tt>s with some other value. Use that one when enabling the
+      # constraint if needed, since otherwise those rows would not be valid.
+      #
+      # Please note the fourth argument does not set a column's default.
+      def change_column_null(table_name, column_name, null, default = nil)
+        raise NotImplementedError, "change_column_null is not implemented"
+      end
+
       # Renames a column.
-      # ===== Example
-      #  rename_column(:suppliers, :description, :name)
+      #
+      #   rename_column(:suppliers, :description, :name)
+      #
       def rename_column(table_name, column_name, new_column_name)
         raise NotImplementedError, "rename_column is not implemented"
       end
@@ -312,165 +676,429 @@ module ActiveRecord
       # The index will be named after the table and the column name(s), unless
       # you pass <tt>:name</tt> as an option.
       #
-      # ===== Examples
-      #
       # ====== Creating a simple index
-      #  add_index(:suppliers, :name)
-      # generates
-      #  CREATE INDEX suppliers_name_index ON suppliers(name)
+      #
+      #   add_index(:suppliers, :name)
+      #
+      # generates:
+      #
+      #   CREATE INDEX suppliers_name_index ON suppliers(name)
       #
       # ====== Creating a unique index
-      #  add_index(:accounts, [:branch_id, :party_id], :unique => true)
-      # generates
-      #  CREATE UNIQUE INDEX accounts_branch_id_party_id_index ON accounts(branch_id, party_id)
+      #
+      #   add_index(:accounts, [:branch_id, :party_id], unique: true)
+      #
+      # generates:
+      #
+      #   CREATE UNIQUE INDEX accounts_branch_id_party_id_index ON accounts(branch_id, party_id)
       #
       # ====== Creating a named index
-      #  add_index(:accounts, [:branch_id, :party_id], :unique => true, :name => 'by_branch_party')
-      # generates
+      #
+      #   add_index(:accounts, [:branch_id, :party_id], unique: true, name: 'by_branch_party')
+      #
+      # generates:
+      #
       #  CREATE UNIQUE INDEX by_branch_party ON accounts(branch_id, party_id)
       #
       # ====== Creating an index with specific key length
-      #  add_index(:accounts, :name, :name => 'by_name', :length => 10)
-      # generates
-      #  CREATE INDEX by_name ON accounts(name(10))
       #
-      #  add_index(:accounts, [:name, :surname], :name => 'by_name_surname', :length => {:name => 10, :surname => 15})
-      # generates
-      #  CREATE INDEX by_name_surname ON accounts(name(10), surname(15))
+      #   add_index(:accounts, :name, name: 'by_name', length: 10)
+      #
+      # generates:
       #
-      # Note: SQLite doesn't support index length
+      #   CREATE INDEX by_name ON accounts(name(10))
+      #
+      # ====== Creating an index with specific key lengths for multiple keys
+      #
+      #   add_index(:accounts, [:name, :surname], name: 'by_name_surname', length: {name: 10, surname: 15})
+      #
+      # generates:
+      #
+      #   CREATE INDEX by_name_surname ON accounts(name(10), surname(15))
+      #
+      # Note: SQLite doesn't support index length.
       #
       # ====== Creating an index with a sort order (desc or asc, asc is the default)
-      #  add_index(:accounts, [:branch_id, :party_id, :surname], :order => {:branch_id => :desc, :part_id => :asc})
-      # generates
-      #  CREATE INDEX by_branch_desc_party ON accounts(branch_id DESC, party_id ASC, surname)
       #
-      # Note: mysql doesn't yet support index order (it accepts the syntax but ignores it)
+      #   add_index(:accounts, [:branch_id, :party_id, :surname], order: {branch_id: :desc, party_id: :asc})
+      #
+      # generates:
+      #
+      #   CREATE INDEX by_branch_desc_party ON accounts(branch_id DESC, party_id ASC, surname)
+      #
+      # Note: MySQL only supports index order from 8.0.1 onwards (earlier versions accepted the syntax but ignored it).
+      #
+      # ====== Creating a partial index
+      #
+      #   add_index(:accounts, [:branch_id, :party_id], unique: true, where: "active")
+      #
+      # generates:
+      #
+      #   CREATE UNIQUE INDEX index_accounts_on_branch_id_and_party_id ON accounts(branch_id, party_id) WHERE active
+      #
+      # Note: Partial indexes are only supported for PostgreSQL and SQLite 3.8.0+.
+      #
+      # ====== Creating an index with a specific method
+      #
+      #   add_index(:developers, :name, using: 'btree')
+      #
+      # generates:
+      #
+      #   CREATE INDEX index_developers_on_name ON developers USING btree (name) -- PostgreSQL
+      #   CREATE INDEX index_developers_on_name USING btree ON developers (name) -- MySQL
+      #
+      # Note: only supported by PostgreSQL and MySQL
+      #
+      # ====== Creating an index with a specific operator class
+      #
+      #   add_index(:developers, :name, using: 'gist', opclass: :gist_trgm_ops)
+      #   # CREATE INDEX developers_on_name ON developers USING gist (name gist_trgm_ops) -- PostgreSQL
+      #
+      #   add_index(:developers, [:name, :city], using: 'gist', opclass: { city: :gist_trgm_ops })
+      #   # CREATE INDEX developers_on_name_and_city ON developers USING gist (name, city gist_trgm_ops) -- PostgreSQL
+      #
+      #   add_index(:developers, [:name, :city], using: 'gist', opclass: :gist_trgm_ops)
+      #   # CREATE INDEX developers_on_name_and_city ON developers USING gist (name gist_trgm_ops, city gist_trgm_ops) -- PostgreSQL
+      #
+      # Note: only supported by PostgreSQL
+      #
+      # ====== Creating an index with a specific type
+      #
+      #   add_index(:developers, :name, type: :fulltext)
+      #
+      # generates:
+      #
+      #   CREATE FULLTEXT INDEX index_developers_on_name ON developers (name) -- MySQL
+      #
+      # Note: only supported by MySQL.
+      #
+      # ====== Creating an index with a specific algorithm
+      #
+      #  add_index(:developers, :name, algorithm: :concurrently)
+      #  # CREATE INDEX CONCURRENTLY developers_on_name on developers (name)
+      #
+      # Note: only supported by PostgreSQL.
+      #
+      # Concurrently adding an index is not supported in a transaction.
       #
+      # For more information see the {"Transactional Migrations" section}[rdoc-ref:Migration].
       def add_index(table_name, column_name, options = {})
-        index_name, index_type, index_columns = add_index_options(table_name, column_name, options)
-        execute "CREATE #{index_type} INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} (#{index_columns})"
+        index_name, index_type, index_columns, index_options = add_index_options(table_name, column_name, options)
+        execute "CREATE #{index_type} INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} (#{index_columns})#{index_options}"
       end
 
-      # Remove the given index from the table.
+      # Removes the given index from the table.
+      #
+      # Removes the index on +branch_id+ in the +accounts+ table if exactly one such index exists.
+      #
+      #   remove_index :accounts, :branch_id
+      #
+      # Removes the index on +branch_id+ in the +accounts+ table if exactly one such index exists.
+      #
+      #   remove_index :accounts, column: :branch_id
+      #
+      # Removes the index on +branch_id+ and +party_id+ in the +accounts+ table if exactly one such index exists.
+      #
+      #   remove_index :accounts, column: [:branch_id, :party_id]
+      #
+      # Removes the index named +by_branch_party+ in the +accounts+ table.
       #
-      # Remove the index_accounts_on_column in the accounts table.
-      #   remove_index :accounts, :column
-      # Remove the index named index_accounts_on_branch_id in the accounts table.
-      #   remove_index :accounts, :column => :branch_id
-      # Remove the index named index_accounts_on_branch_id_and_party_id 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
+      #   remove_index :accounts, name: :by_branch_party
+      #
+      # Removes the index named +by_branch_party+ in the +accounts+ table +concurrently+.
+      #
+      #   remove_index :accounts, name: :by_branch_party, algorithm: :concurrently
+      #
+      # Note: only supported by PostgreSQL.
+      #
+      # Concurrently removing an index is not supported in a transaction.
+      #
+      # For more information see the {"Transactional Migrations" section}[rdoc-ref:Migration].
       def remove_index(table_name, options = {})
-        remove_index!(table_name, index_name_for_remove(table_name, options))
-      end
-
-      def remove_index!(table_name, index_name) #:nodoc:
+        index_name = index_name_for_remove(table_name, options)
         execute "DROP INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)}"
       end
 
-      # Rename an index.
+      # Renames an index.
+      #
+      # Rename the +index_people_on_last_name+ index to +index_users_on_last_name+:
       #
-      # Rename the index_people_on_last_name index to index_users_on_last_name
       #   rename_index :people, 'index_people_on_last_name', 'index_users_on_last_name'
+      #
       def rename_index(table_name, old_name, new_name)
-        # this is a naive implementation; some DBs may support this more efficiently (Postgres, for instance)
+        validate_index_length!(table_name, new_name)
+
+        # this is a naive implementation; some DBs may support this more efficiently (PostgreSQL, for instance)
         old_index_def = indexes(table_name).detect { |i| i.name == old_name }
         return unless old_index_def
-        remove_index(table_name, :name => old_name)
-        add_index(table_name, old_index_def.columns, :name => new_name, :unique => old_index_def.unique)
+        add_index(table_name, old_index_def.columns, name: new_name, unique: old_index_def.unique)
+        remove_index(table_name, name: old_name)
       end
 
       def index_name(table_name, options) #:nodoc:
-        if Hash === options # legacy support
+        if Hash === options
           if options[:column]
-            "index_#{table_name}_on_#{Array.wrap(options[:column]) * '_and_'}"
+            "index_#{table_name}_on_#{Array(options[:column]) * '_and_'}"
           elsif options[:name]
             options[:name]
           else
             raise ArgumentError, "You must specify the index name"
           end
         else
-          index_name(table_name, :column => options)
+          index_name(table_name, index_name_options(options))
         end
       end
 
-      # Verify the existence of an index with a given name.
-      #
-      # The default argument is returned if the underlying implementation does not define the indexes method,
-      # as there's no way to determine the correct answer in that case.
-      def index_name_exists?(table_name, index_name, default)
-        return default unless respond_to?(:indexes)
+      # Verifies the existence of an index with a given name.
+      def index_name_exists?(table_name, index_name)
         index_name = index_name.to_s
         indexes(table_name).detect { |i| i.name == index_name }
       end
 
-      # Returns a string of <tt>CREATE TABLE</tt> SQL statement(s) for recreating the
-      # entire structure of the database.
-      def structure_dump
+      # Adds a reference. The reference column is a bigint by default,
+      # the <tt>:type</tt> option can be used to specify a different type.
+      # Optionally adds a +_type+ column, if <tt>:polymorphic</tt> option is provided.
+      # #add_reference and #add_belongs_to are acceptable.
+      #
+      # The +options+ hash can include the following keys:
+      # [<tt>:type</tt>]
+      #   The reference column type. Defaults to +:bigint+.
+      # [<tt>:index</tt>]
+      #   Add an appropriate index. Defaults to true.
+      #   See #add_index for usage of this option.
+      # [<tt>:foreign_key</tt>]
+      #   Add an appropriate foreign key constraint. Defaults to false.
+      # [<tt>:polymorphic</tt>]
+      #   Whether an additional +_type+ column should be added. Defaults to false.
+      # [<tt>:null</tt>]
+      #   Whether the column allows nulls. Defaults to true.
+      #
+      # ====== Create a user_id bigint column without an index
+      #
+      #   add_reference(:products, :user, index: false)
+      #
+      # ====== Create a user_id string column
+      #
+      #   add_reference(:products, :user, type: :string)
+      #
+      # ====== Create supplier_id, supplier_type columns
+      #
+      #   add_reference(:products, :supplier, polymorphic: true)
+      #
+      # ====== Create a supplier_id column with a unique index
+      #
+      #   add_reference(:products, :supplier, index: { unique: true })
+      #
+      # ====== Create a supplier_id column with a named index
+      #
+      #   add_reference(:products, :supplier, index: { name: "my_supplier_index" })
+      #
+      # ====== Create a supplier_id column and appropriate foreign key
+      #
+      #   add_reference(:products, :supplier, foreign_key: true)
+      #
+      # ====== Create a supplier_id column and a foreign key to the firms table
+      #
+      #   add_reference(:products, :supplier, foreign_key: {to_table: :firms})
+      #
+      def add_reference(table_name, ref_name, **options)
+        ReferenceDefinition.new(ref_name, options).add_to(update_table_definition(table_name, self))
       end
+      alias :add_belongs_to :add_reference
 
-      def dump_schema_information #:nodoc:
-        sm_table = ActiveRecord::Migrator.schema_migrations_table_name
-        migrated = select_values("SELECT version FROM #{sm_table} ORDER BY version")
-        migrated.map { |v| "INSERT INTO #{sm_table} (version) VALUES ('#{v}');" }.join("\n\n")
+      # Removes the reference(s). Also removes a +type+ column if one exists.
+      # #remove_reference and #remove_belongs_to are acceptable.
+      #
+      # ====== 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)
+      #
+      def remove_reference(table_name, ref_name, foreign_key: false, polymorphic: false, **options)
+        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
+          else
+            foreign_key_options = { to_table: reference_name }
+          end
+          foreign_key_options[:column] ||= "#{ref_name}_id"
+          remove_foreign_key(table_name, foreign_key_options)
+        end
+
+        remove_column(table_name, "#{ref_name}_id")
+        remove_column(table_name, "#{ref_name}_type") if polymorphic
       end
+      alias :remove_belongs_to :remove_reference
 
-      # Should not be called normally, but this operation is non-destructive.
-      # The migrations module handles this automatically.
-      def initialize_schema_migrations_table
-        sm_table = ActiveRecord::Migrator.schema_migrations_table_name
+      # Returns an array of foreign keys for the given table.
+      # The foreign keys are represented as ForeignKeyDefinition objects.
+      def foreign_keys(table_name)
+        raise NotImplementedError, "foreign_keys is not implemented"
+      end
 
-        unless table_exists?(sm_table)
-          create_table(sm_table, :id => false) do |schema_migrations_table|
-            schema_migrations_table.column :version, :string, :null => false
-          end
-          add_index sm_table, :version, :unique => true,
-            :name => "#{Base.table_name_prefix}unique_schema_migrations#{Base.table_name_suffix}"
+      # Adds a new foreign key. +from_table+ is the table with the key column,
+      # +to_table+ contains the referenced primary key.
+      #
+      # The foreign key will be named after the following pattern: <tt>fk_rails_<identifier></tt>.
+      # +identifier+ is a 10 character long string which is deterministically generated from the
+      # +from_table+ and +column+. A custom name can be specified with the <tt>:name</tt> option.
+      #
+      # ====== Creating a simple foreign key
+      #
+      #   add_foreign_key :articles, :authors
+      #
+      # generates:
+      #
+      #   ALTER TABLE "articles" ADD CONSTRAINT fk_rails_e74ce85cbc FOREIGN KEY ("author_id") REFERENCES "authors" ("id")
+      #
+      # ====== Creating a foreign key on a specific column
+      #
+      #   add_foreign_key :articles, :users, column: :author_id, primary_key: "lng_id"
+      #
+      # generates:
+      #
+      #   ALTER TABLE "articles" ADD CONSTRAINT fk_rails_58ca3d3a82 FOREIGN KEY ("author_id") REFERENCES "users" ("lng_id")
+      #
+      # ====== Creating a cascading foreign key
+      #
+      #   add_foreign_key :articles, :authors, on_delete: :cascade
+      #
+      # generates:
+      #
+      #   ALTER TABLE "articles" ADD CONSTRAINT fk_rails_e74ce85cbc FOREIGN KEY ("author_id") REFERENCES "authors" ("id") ON DELETE CASCADE
+      #
+      # The +options+ hash can include the following keys:
+      # [<tt>:column</tt>]
+      #   The foreign key column name on +from_table+. Defaults to <tt>to_table.singularize + "_id"</tt>
+      # [<tt>:primary_key</tt>]
+      #   The primary key column name on +to_table+. Defaults to +id+.
+      # [<tt>:name</tt>]
+      #   The constraint name. Defaults to <tt>fk_rails_<identifier></tt>.
+      # [<tt>:on_delete</tt>]
+      #   Action that happens <tt>ON DELETE</tt>. Valid values are +:nullify+, +:cascade+ and +:restrict+
+      # [<tt>:on_update</tt>]
+      #   Action that happens <tt>ON UPDATE</tt>. Valid values are +:nullify+, +:cascade+ and +:restrict+
+      # [<tt>:validate</tt>]
+      #   (PostgreSQL only) Specify whether or not the constraint should be validated. Defaults to +true+.
+      def add_foreign_key(from_table, to_table, options = {})
+        return unless supports_foreign_keys?
 
-          # Backwards-compatibility: if we find schema_info, assume we've
-          # migrated up to that point:
-          si_table = Base.table_name_prefix + 'schema_info' + Base.table_name_suffix
+        options = foreign_key_options(from_table, to_table, options)
+        at = create_alter_table from_table
+        at.add_foreign_key to_table, options
 
-          if table_exists?(si_table)
-            ActiveSupport::Deprecation.warn "Usage of the schema table `#{si_table}` is deprecated. Please switch to using `schema_migrations` table"
+        execute schema_creation.accept(at)
+      end
 
-            old_version = select_value("SELECT version FROM #{quote_table_name(si_table)}").to_i
-            assume_migrated_upto_version(old_version)
-            drop_table(si_table)
-          end
-        end
+      # Removes the given foreign key from the table. Any option parameters provided
+      # will be used to re-add the foreign key in case of a migration rollback.
+      # It is recommended that you provide any options used when creating the foreign
+      # key so that the migration can be reverted properly.
+      #
+      # Removes the foreign key on +accounts.branch_id+.
+      #
+      #   remove_foreign_key :accounts, :branches
+      #
+      # Removes the foreign key on +accounts.owner_id+.
+      #
+      #   remove_foreign_key :accounts, column: :owner_id
+      #
+      # Removes the foreign key on +accounts.owner_id+.
+      #
+      #   remove_foreign_key :accounts, to_table: :owners
+      #
+      # Removes the foreign key named +special_fk_name+ on the +accounts+ table.
+      #
+      #   remove_foreign_key :accounts, name: :special_fk_name
+      #
+      # The +options+ hash accepts the same keys as SchemaStatements#add_foreign_key
+      # with an addition of
+      # [<tt>:to_table</tt>]
+      #   The name of the table that contains the referenced primary key.
+      def remove_foreign_key(from_table, to_table = nil, **options)
+        return unless supports_foreign_keys?
+
+        fk_name_to_delete = foreign_key_for!(from_table, to_table: to_table, **options).name
+
+        at = create_alter_table from_table
+        at.drop_foreign_key fk_name_to_delete
+
+        execute schema_creation.accept(at)
       end
 
-      def assume_migrated_upto_version(version, migrations_paths = ActiveRecord::Migrator.migrations_paths)
-        migrations_paths = Array.wrap(migrations_paths)
-        version = version.to_i
-        sm_table = quote_table_name(ActiveRecord::Migrator.schema_migrations_table_name)
+      # Checks to see if a foreign key exists on a table for a given foreign key definition.
+      #
+      #   # Checks to see if a foreign key exists.
+      #   foreign_key_exists?(:accounts, :branches)
+      #
+      #   # Checks to see if a foreign key on a specified column exists.
+      #   foreign_key_exists?(:accounts, column: :owner_id)
+      #
+      #   # Checks to see if a foreign key with a custom name exists.
+      #   foreign_key_exists?(:accounts, name: "special_fk_name")
+      #
+      def foreign_key_exists?(from_table, to_table = nil, **options)
+        foreign_key_for(from_table, to_table: to_table, **options).present?
+      end
+
+      def foreign_key_column_for(table_name) # :nodoc:
+        name = strip_table_name_prefix_and_suffix(table_name)
+        "#{name.singularize}_id"
+      end
 
-        migrated = select_values("SELECT version FROM #{sm_table}").map { |v| v.to_i }
-        paths = migrations_paths.map {|p| "#{p}/[0-9]*_*.rb" }
-        versions = Dir[*paths].map do |filename|
-          filename.split('/').last.split('_').first.to_i
+      def foreign_key_options(from_table, to_table, options) # :nodoc:
+        options = options.dup
+        options[:column] ||= foreign_key_column_for(to_table)
+        options[:name]   ||= foreign_key_name(from_table, options)
+        options
+      end
+
+      def dump_schema_information # :nodoc:
+        versions = schema_migration.all_versions
+        insert_versions_sql(versions) if versions.any?
+      end
+
+      def internal_string_options_for_primary_key # :nodoc:
+        { primary_key: true }
+      end
+
+      def assume_migrated_upto_version(version, migrations_paths = nil)
+        unless migrations_paths.nil?
+          ActiveSupport::Deprecation.warn(<<~MSG.squish)
+            Passing migrations_paths to #assume_migrated_upto_version is deprecated and will be removed in Rails 6.1.
+          MSG
         end
 
+        version = version.to_i
+        sm_table = quote_table_name(schema_migration.table_name)
+
+        migrated = migration_context.get_all_versions
+        versions = migration_context.migrations.map(&:version)
+
         unless migrated.include?(version)
-          execute "INSERT INTO #{sm_table} (version) VALUES ('#{version}')"
+          execute "INSERT INTO #{sm_table} (version) VALUES (#{quote(version)})"
         end
 
-        inserted = Set.new
-        (versions - migrated).each do |v|
-          if inserted.include?(v)
-            raise "Duplicate migration #{v}. Please renumber your migrations to resolve the conflict."
-          elsif v < version
-            execute "INSERT INTO #{sm_table} (version) VALUES ('#{v}')"
-            inserted << v
+        inserting = (versions - migrated).select { |v| v < version }
+        if inserting.any?
+          if (duplicate = inserting.detect { |v| inserting.count(v) > 1 })
+            raise "Duplicate migration #{duplicate}. Please renumber your migrations to resolve the conflict."
           end
+          execute insert_versions_sql(inserting)
         end
       end
 
-      def type_to_sql(type, limit = nil, precision = nil, scale = nil) #:nodoc:
-        if native = native_database_types[type.to_sym]
+      def type_to_sql(type, limit: nil, precision: nil, scale: nil, **) # :nodoc:
+        type = type.to_sym if type
+        if native = native_database_types[type]
           column_type_sql = (native.is_a?(Hash) ? native[:name] : native).dup
 
           if type == :decimal # ignore limit, use precision and scale
@@ -483,124 +1111,365 @@ module ActiveRecord
                 column_type_sql << "(#{precision})"
               end
             elsif scale
-              raise ArgumentError, "Error adding decimal column: precision cannot be empty if scale if specified"
+              raise ArgumentError, "Error adding decimal column: precision cannot be empty if scale is specified"
             end
 
+          elsif [:datetime, :timestamp, :time, :interval].include?(type) && precision ||= native[:precision]
+            if (0..6) === precision
+              column_type_sql << "(#{precision})"
+            else
+              raise ArgumentError, "No #{native[:name]} type has precision of #{precision}. The allowed range of precision is from 0 to 6"
+            end
           elsif (type != :primary_key) && (limit ||= native.is_a?(Hash) && native[:limit])
             column_type_sql << "(#{limit})"
           end
 
           column_type_sql
         else
-          type
+          type.to_s
         end
       end
 
-      def add_column_options!(sql, options) #:nodoc:
-        sql << " DEFAULT #{quote(options[:default], options[:column])}" if options_include_default?(options)
-        # must explicitly check for :null to allow change_column to work on migrations
-        if options[:null] == false
-          sql << " NOT NULL"
-        end
+      # Given a set of columns and an ORDER BY clause, returns the columns for a SELECT DISTINCT.
+      # PostgreSQL, MySQL, and Oracle override this for custom DISTINCT syntax - they
+      # require the order columns appear in the SELECT.
+      #
+      #   columns_for_distinct("posts.id", ["posts.created_at desc"])
+      #
+      def columns_for_distinct(columns, orders) # :nodoc:
+        columns
       end
 
-      # SELECT DISTINCT clause for a given set of columns and a given ORDER BY clause.
-      # Both PostgreSQL and Oracle overrides this for custom DISTINCT syntax.
+      # Adds timestamps (+created_at+ and +updated_at+) columns to +table_name+.
+      # Additional options (like +:null+) are forwarded to #add_column.
       #
-      #   distinct("posts.id", "posts.created_at desc")
-      def distinct(columns, order_by)
-        "DISTINCT #{columns}"
-      end
+      #   add_timestamps(:suppliers, null: true)
+      #
+      def add_timestamps(table_name, options = {})
+        options[:null] = false if options[:null].nil?
+
+        if !options.key?(:precision) && supports_datetime_with_precision?
+          options[:precision] = 6
+        end
 
-      # Adds timestamps (created_at and updated_at) columns to the named table.
-      # ===== Examples
-      #  add_timestamps(:suppliers)
-      def add_timestamps(table_name)
-        add_column table_name, :created_at, :datetime
-        add_column table_name, :updated_at, :datetime
+        add_column table_name, :created_at, :datetime, options
+        add_column table_name, :updated_at, :datetime, options
       end
 
-      # Removes the timestamp columns (created_at and updated_at) from the table definition.
-      # ===== Examples
+      # Removes the timestamp columns (+created_at+ and +updated_at+) from the table definition.
+      #
       #  remove_timestamps(:suppliers)
-      def remove_timestamps(table_name)
+      #
+      def remove_timestamps(table_name, options = {})
         remove_column table_name, :updated_at
         remove_column table_name, :created_at
       end
 
-      protected
-        def add_index_sort_order(option_strings, column_names, options = {})
-          if options.is_a?(Hash) && order = options[:order]
-            case order
-            when Hash
-              column_names.each {|name| option_strings[name] += " #{order[name].to_s.upcase}" if order.has_key?(name)}
-            when String
-              column_names.each {|name| option_strings[name] += " #{order.upcase}"}
-            end
-          end
+      def update_table_definition(table_name, base) #:nodoc:
+        Table.new(table_name, base)
+      end
+
+      def add_index_options(table_name, column_name, comment: nil, **options) # :nodoc:
+        column_names = index_column_names(column_name)
+
+        options.assert_valid_keys(:unique, :order, :name, :where, :length, :internal, :using, :algorithm, :type, :opclass)
+
+        index_type = options[:type].to_s if options.key?(:type)
+        index_type ||= options[:unique] ? "UNIQUE" : ""
+        index_name = options[:name].to_s if options.key?(:name)
+        index_name ||= index_name(table_name, column_names)
+
+        if options.key?(:algorithm)
+          algorithm = index_algorithms.fetch(options[:algorithm]) {
+            raise ArgumentError.new("Algorithm must be one of the following: #{index_algorithms.keys.map(&:inspect).join(', ')}")
+          }
+        end
 
-          return option_strings
+        using = "USING #{options[:using]}" if options[:using].present?
+
+        if supports_partial_index?
+          index_options = options[:where] ? " WHERE #{options[:where]}" : ""
+        end
+
+        validate_index_length!(table_name, index_name, options.fetch(:internal, false))
+
+        if data_source_exists?(table_name) && index_name_exists?(table_name, index_name)
+          raise ArgumentError, "Index name '#{index_name}' on table '#{table_name}' already exists"
         end
+        index_columns = quoted_columns_for_index(column_names, options).join(", ")
+
+        [index_name, index_type, index_columns, index_options, algorithm, using, comment]
+      end
+
+      def options_include_default?(options)
+        options.include?(:default) && !(options[:null] == false && options[:default].nil?)
+      end
 
-        # Overridden by the mysql adapter for supporting index lengths
-        def quoted_columns_for_index(column_names, options = {})
-          option_strings = Hash[column_names.map {|name| [name, '']}]
+      # Changes the comment for a table or removes it if +nil+.
+      #
+      # Passing a hash containing +:from+ and +:to+ will make this change
+      # reversible in migration:
+      #
+      #   change_table_comment(:posts, from: "old_comment", to: "new_comment")
+      def change_table_comment(table_name, comment_or_changes)
+        raise NotImplementedError, "#{self.class} does not support changing table comments"
+      end
 
-          # add index sort order if supported
+      # Changes the comment for a column or removes it if +nil+.
+      #
+      # Passing a hash containing +:from+ and +:to+ will make this change
+      # reversible in migration:
+      #
+      #   change_column_comment(:posts, :state, from: "old_comment", to: "new_comment")
+      def change_column_comment(table_name, column_name, comment_or_changes)
+        raise NotImplementedError, "#{self.class} does not support changing column comments"
+      end
+
+      def create_schema_dumper(options) # :nodoc:
+        SchemaDumper.create(self, options)
+      end
+
+      private
+        def column_options_keys
+          [:limit, :precision, :scale, :default, :null, :collation, :comment]
+        end
+
+        def add_index_sort_order(quoted_columns, **options)
+          orders = options_for_index_columns(options[:order])
+          quoted_columns.each do |name, column|
+            column << " #{orders[name].upcase}" if orders[name].present?
+          end
+        end
+
+        def options_for_index_columns(options)
+          if options.is_a?(Hash)
+            options.symbolize_keys
+          else
+            Hash.new { |hash, column| hash[column] = options }
+          end
+        end
+
+        # Overridden by the MySQL adapter for supporting index lengths and by
+        # the PostgreSQL adapter for supporting operator classes.
+        def add_options_for_index_columns(quoted_columns, **options)
           if supports_index_sort_order?
-            option_strings = add_index_sort_order(option_strings, column_names, options)
+            quoted_columns = add_index_sort_order(quoted_columns, options)
           end
 
-          column_names.map {|name| quote_column_name(name) + option_strings[name]}
+          quoted_columns
         end
 
-        def options_include_default?(options)
-          options.include?(:default) && !(options[:null] == false && options[:default].nil?)
+        def quoted_columns_for_index(column_names, **options)
+          return [column_names] if column_names.is_a?(String)
+
+          quoted_columns = Hash[column_names.map { |name| [name.to_sym, quote_column_name(name).dup] }]
+          add_options_for_index_columns(quoted_columns, options).values
         end
 
-        def add_index_options(table_name, column_name, options = {})
-          column_names = Array.wrap(column_name)
-          index_name   = index_name(table_name, :column => column_names)
+        def index_name_for_remove(table_name, options = {})
+          return options[:name] if can_remove_index_by_name?(options)
+
+          checks = []
 
-          if Hash === options # legacy support, since this param was a string
-            index_type = options[:unique] ? "UNIQUE" : ""
-            index_name = options[:name].to_s if options.key?(:name)
+          if options.is_a?(Hash)
+            checks << lambda { |i| i.name == options[:name].to_s } if options.key?(:name)
+            column_names = index_column_names(options[:column])
           else
-            index_type = options
+            column_names = index_column_names(options)
           end
 
-          if index_name.length > index_name_length
-            raise ArgumentError, "Index name '#{index_name}' on table '#{table_name}' is too long; the limit is #{index_name_length} characters"
+          if column_names.present?
+            checks << lambda { |i| index_name(table_name, i.columns) == index_name(table_name, column_names) }
           end
-          if index_name_exists?(table_name, index_name, false)
-            raise ArgumentError, "Index name '#{index_name}' on table '#{table_name}' already exists"
+
+          raise ArgumentError, "No name or columns specified" if checks.none?
+
+          matching_indexes = indexes(table_name).select { |i| checks.all? { |check| check[i] } }
+
+          if matching_indexes.count > 1
+            raise ArgumentError, "Multiple indexes found on #{table_name} columns #{column_names}. " \
+                                 "Specify an index name from #{matching_indexes.map(&:name).join(', ')}"
+          elsif matching_indexes.none?
+            raise ArgumentError, "No indexes found on #{table_name} with the options provided."
+          else
+            matching_indexes.first.name
           end
-          index_columns = quoted_columns_for_index(column_names, options).join(", ")
+        end
 
-          [index_name, index_type, index_columns]
+        def rename_table_indexes(table_name, new_name)
+          indexes(new_name).each do |index|
+            generated_index_name = index_name(table_name, column: index.columns)
+            if generated_index_name == index.name
+              rename_index new_name, generated_index_name, index_name(new_name, column: index.columns)
+            end
+          end
         end
 
-        def index_name_for_remove(table_name, options = {})
-          index_name = index_name(table_name, options)
+        def rename_column_indexes(table_name, column_name, new_column_name)
+          column_name, new_column_name = column_name.to_s, new_column_name.to_s
+          indexes(table_name).each do |index|
+            next unless index.columns.include?(new_column_name)
+            old_columns = index.columns.dup
+            old_columns[old_columns.index(new_column_name)] = column_name
+            generated_index_name = index_name(table_name, column: old_columns)
+            if generated_index_name == index.name
+              rename_index table_name, generated_index_name, index_name(table_name, column: index.columns)
+            end
+          end
+        end
 
-          unless index_name_exists?(table_name, index_name, true)
-            raise ArgumentError, "Index name '#{index_name}' on table '#{table_name}' does not exist"
+        def schema_creation
+          SchemaCreation.new(self)
+        end
+
+        def create_table_definition(*args)
+          TableDefinition.new(self, *args)
+        end
+
+        def create_alter_table(name)
+          AlterTable.new create_table_definition(name)
+        end
+
+        def fetch_type_metadata(sql_type)
+          cast_type = lookup_cast_type(sql_type)
+          SqlTypeMetadata.new(
+            sql_type: sql_type,
+            type: cast_type.type,
+            limit: cast_type.limit,
+            precision: cast_type.precision,
+            scale: cast_type.scale,
+          )
+        end
+
+        def index_column_names(column_names)
+          if column_names.is_a?(String) && /\W/.match?(column_names)
+            column_names
+          else
+            Array(column_names)
+          end
+        end
+
+        def index_name_options(column_names)
+          if column_names.is_a?(String) && /\W/.match?(column_names)
+            column_names = column_names.scan(/\w+/).join("_")
+          end
+
+          { column: column_names }
+        end
+
+        def strip_table_name_prefix_and_suffix(table_name)
+          prefix = Base.table_name_prefix
+          suffix = Base.table_name_suffix
+          table_name.to_s =~ /#{prefix}(.+)#{suffix}/ ? $1 : table_name.to_s
+        end
+
+        def foreign_key_name(table_name, options)
+          options.fetch(:name) do
+            identifier = "#{table_name}_#{options.fetch(:column)}_fk"
+            hashed_identifier = Digest::SHA256.hexdigest(identifier).first(10)
+
+            "fk_rails_#{hashed_identifier}"
           end
+        end
+
+        def foreign_key_for(from_table, **options)
+          return unless supports_foreign_keys?
+          foreign_keys(from_table).detect { |fk| fk.defined_for?(options) }
+        end
+
+        def foreign_key_for!(from_table, to_table: nil, **options)
+          foreign_key_for(from_table, to_table: to_table, **options) ||
+            raise(ArgumentError, "Table '#{from_table}' has no foreign key for #{to_table || options}")
+        end
 
-          index_name
+        def extract_foreign_key_action(specifier)
+          case specifier
+          when "CASCADE"; :cascade
+          when "SET NULL"; :nullify
+          when "RESTRICT"; :restrict
+          end
         end
 
-        def columns_for_remove(table_name, *column_names)
-          column_names = column_names.flatten
+        def validate_index_length!(table_name, new_name, internal = false)
+          max_index_length = internal ? index_name_length : allowed_index_name_length
 
-          raise ArgumentError.new("You must specify at least one column name. Example: remove_column(:people, :first_name)") if column_names.blank?
-          column_names.map {|column_name| quote_column_name(column_name) }
+          if new_name.length > max_index_length
+            raise ArgumentError, "Index name '#{new_name}' on table '#{table_name}' is too long; the limit is #{allowed_index_name_length} characters"
+          end
         end
 
-      private
-      def table_definition
-        TableDefinition.new(self)
-      end
+        def extract_new_default_value(default_or_changes)
+          if default_or_changes.is_a?(Hash) && default_or_changes.has_key?(:from) && default_or_changes.has_key?(:to)
+            default_or_changes[:to]
+          else
+            default_or_changes
+          end
+        end
+        alias :extract_new_comment_value :extract_new_default_value
+
+        def can_remove_index_by_name?(options)
+          options.is_a?(Hash) && options.key?(:name) && options.except(:name, :algorithm).empty?
+        end
+
+        def bulk_change_table(table_name, operations)
+          sql_fragments = []
+          non_combinable_operations = []
+
+          operations.each do |command, args|
+            table, arguments = args.shift, args
+            method = :"#{command}_for_alter"
+
+            if respond_to?(method, true)
+              sqls, procs = Array(send(method, table, *arguments)).partition { |v| v.is_a?(String) }
+              sql_fragments << sqls
+              non_combinable_operations.concat(procs)
+            else
+              execute "ALTER TABLE #{quote_table_name(table_name)} #{sql_fragments.join(", ")}" unless sql_fragments.empty?
+              non_combinable_operations.each(&:call)
+              sql_fragments = []
+              non_combinable_operations = []
+              send(command, table, *arguments)
+            end
+          end
+
+          execute "ALTER TABLE #{quote_table_name(table_name)} #{sql_fragments.join(", ")}" unless sql_fragments.empty?
+          non_combinable_operations.each(&:call)
+        end
+
+        def add_column_for_alter(table_name, column_name, type, options = {})
+          td = create_table_definition(table_name)
+          cd = td.new_column_definition(column_name, type, options)
+          schema_creation.accept(AddColumnDefinition.new(cd))
+        end
+
+        def remove_column_for_alter(table_name, column_name, type = nil, options = {})
+          "DROP COLUMN #{quote_column_name(column_name)}"
+        end
+
+        def remove_columns_for_alter(table_name, *column_names)
+          column_names.map { |column_name| remove_column_for_alter(table_name, column_name) }
+        end
+
+        def insert_versions_sql(versions)
+          sm_table = quote_table_name(schema_migration.table_name)
+
+          if versions.is_a?(Array)
+            sql = +"INSERT INTO #{sm_table} (version) VALUES\n"
+            sql << versions.map { |v| "(#{quote(v)})" }.join(",\n")
+            sql << ";\n\n"
+            sql
+          else
+            "INSERT INTO #{sm_table} (version) VALUES (#{quote(versions)});"
+          end
+        end
+
+        def data_source_sql(name = nil, type: nil)
+          raise NotImplementedError
+        end
+
+        def quoted_scope(name = nil, type: nil)
+          raise NotImplementedError
+        end
     end
   end
 end