add_index_options(table_name, column_name, options = {}) protected

No documentation

This method has no description. You can help the Ruby on Rails community by adding new notes.

Hide source
# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 773
        def add_index_options(table_name, column_name, options = {})
          column_names = Array(column_name)
          index_name   = index_name(table_name, column: column_names)

          options.assert_valid_keys(:unique, :order, :name, :where, :length, :internal, :using, :algorithm, :type)

          index_type = options[:unique] ? "UNIQUE" : ""
          index_type = options[:type].to_s if options.key?(:type)
          index_name = options[:name].to_s if options.key?(:name)
          max_index_length = options.fetch(:internal, false) ? index_name_length : allowed_index_name_length

          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(', ')}")

          using = "USING #{options[:using]}" if options[:using].present?

          if supports_partial_index?
            index_options = options[:where] ? " WHERE #{options[:where]}" : ""

          if index_name.length > max_index_length
            raise ArgumentError, "Index name '#{index_name}' on table '#{table_name}' is too long; the limit is #{max_index_length} characters"
          if index_name_exists?(table_name, index_name, false)
            raise ArgumentError, "Index name '#{index_name}' on table '#{table_name}' already exists"
          index_columns = quoted_columns_for_index(column_names, options).join(", ")

          [index_name, index_type, index_columns, index_options, algorithm, using]
Register or log in to add new notes.