instance method `index`

Ruby on Rails 4.0.13

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:

index(column_name, options = {})

Adds a new index to the table. column_name can be a single Symbol, or an Array of Symbols. See SchemaStatements#add_index

Creating a simple index

t.index(:name)

Creating a unique index

t.index([:branch_id, :party_id], unique: true)

Creating a named index

t.index([:branch_id, :party_id], unique: true, name: 'by_branch_party')

Parameters

column_name req
options opt = {}

Source

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 377
      def index(column_name, options = {})
        @base.add_index(@table_name, column_name, options)
      end

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

Defined in ActiveRecord::ConnectionAdapters::Table

Signature

Creating a simple index

Creating a unique index

Creating a named index

Parameters