Class: ActiveRecord::ConnectionAdapters::ReferenceDefinition

Inherits:
Object
  • Object
show all
Defined in:
activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb

Overview

:nodoc:

Instance Method Summary collapse

Constructor Details

#initialize(name, polymorphic: false, index: true, foreign_key: false, type: :bigint, **options) ⇒ ReferenceDefinition

Returns a new instance of ReferenceDefinition.


141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 141

def initialize(
  name,
  polymorphic: false,
  index: true,
  foreign_key: false,
  type: :bigint,
  **options
)
  @name = name
  @polymorphic = polymorphic
  @index = index
  @foreign_key = foreign_key
  @type = type
  @options = options

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

Instance Method Details

#add_to(table) ⇒ Object


161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 161

def add_to(table)
  columns.each do |name, type, options|
    table.column(name, type, **options)
  end

  if index
    table.index(column_names, **index_options)
  end

  if foreign_key
    table.foreign_key(foreign_table_name, **foreign_key_options)
  end
end