Class: ActiveRecord::ConnectionAdapters::ForeignKeyDefinition

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

Overview

:nodoc:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Struct

#as_json

Instance Attribute Details

#from_table ⇒ Object

Returns the value of attribute from_table

Returns:

  • (Object) —

    the current value of from_table



127
128
129
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 127

def from_table
  @from_table
end

#options ⇒ Object

Returns the value of attribute options

Returns:

  • (Object) —

    the current value of options



127
128
129
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 127

def options
  @options
end

#to_table ⇒ Object

Returns the value of attribute to_table

Returns:

  • (Object) —

    the current value of to_table



127
128
129
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 127

def to_table
  @to_table
end

Instance Method Details

#column ⇒ Object 



132
133
134
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 132

def column
  options[:column]
end

#custom_primary_key? ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 152

def custom_primary_key?
  options[:primary_key] != default_primary_key
end

#deferrable ⇒ Object 



148
149
150
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 148

def deferrable
  options[:deferrable]
end

#defined_for?(to_table: nil, validate: nil, **options) ⇒ Boolean

Returns:

  • (Boolean) 


165
166
167
168
169
170
171
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 165

def defined_for?(to_table: nil, validate: nil, **options)
  options = options.slice(*self.options.keys)

  (to_table.nil? || to_table.to_s == self.to_table) &&
    (validate.nil? || validate == self.options.fetch(:validate, validate)) &&
    options.all? { |k, v| Array(self.options[k]).map(&:to_s) == Array(v).map(&:to_s) }
end

#export_name_on_schema_dump? ⇒ Boolean

Returns:

  • (Boolean) 


161
162
163
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 161

def export_name_on_schema_dump?
  !ActiveRecord::SchemaDumper.fk_ignore_pattern.match?(name) if name
end

#name ⇒ Object 



128
129
130
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 128

def name
  options[:name]
end

#on_delete ⇒ Object 



140
141
142
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 140

def on_delete
  options[:on_delete]
end

#on_update ⇒ Object 



144
145
146
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 144

def on_update
  options[:on_update]
end

#primary_key ⇒ Object 



136
137
138
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 136

def primary_key
  options[:primary_key] || default_primary_key
end

#validate? ⇒ Boolean Also known as: validated?

Returns:

  • (Boolean) 


156
157
158
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 156

def validate?
  options.fetch(:validate, true)
end