method

add_reference

v4.2.7 - Show latest stable - 1 note - Class: ActiveRecord::ConnectionAdapters::SchemaStatements

1.0.0
1.1.6
1.2.6
2.0.3
2.1.0
2.2.1
2.3.8
3.0.0
3.0.9
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2 (0)
4.1.8 (0)
4.2.1 (13)
4.2.7 (15)
4.2.9 (0)
5.0.0.1 (38)
5.1.7 (0)
5.2.3 (0)
6.0.0 (0)
6.1.3.1 (9)
6.1.7.7 (0)
7.0.0 (0)
7.1.3.2 (-3)
7.1.3.4 (0)
What's this?

add_reference(table_name, ref_name, options = {}) public

Adds a reference. The reference column is an integer by default, the :type option can be used to specify a different type. Optionally adds a _type column, if :polymorphic option is provided. add_reference and add_belongs_to are acceptable.

The options hash can include the following keys:

:type: The reference column type. Defaults to :integer.
:index: Add an appropriate index. Defaults to false.
:foreign_key: Add an appropriate foreign key. Defaults to false.
:polymorphic: Wether an additional _type column should be added. Defaults to false.

Create a user_id integer column

add_reference(:products, :user)

Create a user_id string column

add_reference(:products, :user, type: :string)

Create supplier_id, supplier_type columns and appropriate index

add_reference(:products, :supplier, polymorphic: true, index: true)

Show source

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 667
      def add_reference(table_name, ref_name, options = {})
        polymorphic = options.delete(:polymorphic)
        index_options = options.delete(:index)
        type = options.delete(:type) || :integer
        foreign_key_options = options.delete(:foreign_key)

        if polymorphic && foreign_key_options
          raise ArgumentError, "Cannot add a foreign key to a polymorphic relation"
        end

        add_column(table_name, "#{ref_name}_id", type, options)
        add_column(table_name, "#{ref_name}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options) if polymorphic
        add_index(table_name, polymorphic ? ]type id].map{ |t| "#{ref_name}_#{t}" } : "#{ref_name}_id", index_options.is_a?(Hash) ? index_options : {}) if index_options
        if foreign_key_options
          to_table = Base.pluralize_table_names ? ref_name.to_s.pluralize : ref_name
          add_foreign_key(table_name, to_table, foreign_key_options.is_a?(Hash) ? foreign_key_options : {})
        end
      end

June 7, 2016

0 thanks

foreign_key option

It is also possible to specify that add_foreign_key should be added to the schema:

add_reference(:products, :supplier, foreign_key: true)

add_reference

Related methods

Create a user_id integer column

Create a user_id string column

Create supplier_id, supplier_type columns and appropriate index

foreign_key option