Class: ActiveRecord::ConnectionAdapters::SchemaCache

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(conn) ⇒ SchemaCache

Returns a new instance of SchemaCache.


38
39
40
41
42
43
44
45
46
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 38

def initialize(conn)
  @connection = conn

  @columns      = {}
  @columns_hash = {}
  @primary_keys = {}
  @data_sources = {}
  @indexes      = {}
end

Instance Attribute Details

#connectionObject

Returns the value of attribute connection.


36
37
38
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 36

def connection
  @connection
end

#versionObject (readonly)

Returns the value of attribute version.


35
36
37
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 35

def version
  @version
end

Class Method Details

.load_from(filename) ⇒ Object


8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 8

def self.load_from(filename)
  return unless File.file?(filename)

  read(filename) do |file|
    if filename.include?(".dump")
      Marshal.load(file)
    else
      if YAML.respond_to?(:unsafe_load)
        YAML.unsafe_load(file)
      else
        YAML.load(file)
      end
    end
  end
end

Instance Method Details

#add(table_name) ⇒ Object

Add internal cache for table with table_name.


97
98
99
100
101
102
103
104
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 97

def add(table_name)
  if data_source_exists?(table_name)
    primary_keys(table_name)
    columns(table_name)
    columns_hash(table_name)
    indexes(table_name)
  end
end

#clear!Object

Clears out internal caches


149
150
151
152
153
154
155
156
157
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 149

def clear!
  @columns.clear
  @columns_hash.clear
  @primary_keys.clear
  @data_sources.clear
  @indexes.clear
  @version = nil
  @database_version = nil
end

#clear_data_source_cache!(name) ⇒ Object

Clear out internal caches for the data source name.


164
165
166
167
168
169
170
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 164

def clear_data_source_cache!(name)
  @columns.delete name
  @columns_hash.delete name
  @primary_keys.delete name
  @data_sources.delete name
  @indexes.delete name
end

#columns(table_name) ⇒ Object

Get the columns for a table


111
112
113
114
115
116
117
118
119
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 111

def columns(table_name)
  if ignored_table?(table_name)
    raise ActiveRecord::StatementInvalid, "Table '#{table_name}' doesn't exist"
  end

  @columns.fetch(table_name) do
    @columns[deep_deduplicate(table_name)] = deep_deduplicate(connection.columns(table_name))
  end
end

#columns_hash(table_name) ⇒ Object

Get the columns for a table as a hash, key is the column name value is the column object.


123
124
125
126
127
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 123

def columns_hash(table_name)
  @columns_hash.fetch(table_name) do
    @columns_hash[deep_deduplicate(table_name)] = columns(table_name).index_by(&:name).freeze
  end
end

#columns_hash?(table_name) ⇒ Boolean

Checks whether the columns hash is already cached for a table.

Returns:

  • (Boolean)

130
131
132
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 130

def columns_hash?(table_name)
  @columns_hash.key?(table_name)
end

#data_source_exists?(name) ⇒ Boolean

A cached lookup for table existence.

Returns:

  • (Boolean)

88
89
90
91
92
93
94
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 88

def data_source_exists?(name)
  return if ignored_table?(name)
  prepare_data_sources if @data_sources.empty?
  return @data_sources[name] if @data_sources.key? name

  @data_sources[deep_deduplicate(name)] = connection.data_source_exists?(name)
end

#data_sources(name) ⇒ Object


106
107
108
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 106

def data_sources(name)
  @data_sources[name]
end

#database_versionObject

:nodoc:


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

def database_version # :nodoc:
  @database_version ||= connection.get_database_version
end

#dump_to(filename) ⇒ Object


172
173
174
175
176
177
178
179
180
181
182
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 172

def dump_to(filename)
  clear!
  tables_to_cache.each { |table| add(table) }
  open(filename) { |f|
    if filename.include?(".dump")
      f.write(Marshal.dump(self))
    else
      f.write(YAML.dump(self))
    end
  }
end

#encode_with(coder) ⇒ Object


57
58
59
60
61
62
63
64
65
66
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 57

def encode_with(coder)
  reset_version!

  coder["columns"]          = @columns
  coder["primary_keys"]     = @primary_keys
  coder["data_sources"]     = @data_sources
  coder["indexes"]          = @indexes
  coder["version"]          = @version
  coder["database_version"] = database_version
end

#indexes(table_name) ⇒ Object


134
135
136
137
138
139
140
141
142
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 134

def indexes(table_name)
  @indexes.fetch(table_name) do
    if data_source_exists?(table_name)
      @indexes[deep_deduplicate(table_name)] = deep_deduplicate(connection.indexes(table_name))
    else
      []
    end
  end
end

#init_with(coder) ⇒ Object


68
69
70
71
72
73
74
75
76
77
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 68

def init_with(coder)
  @columns          = coder["columns"]
  @primary_keys     = coder["primary_keys"]
  @data_sources     = coder["data_sources"]
  @indexes          = coder["indexes"] || {}
  @version          = coder["version"]
  @database_version = coder["database_version"]

  derive_columns_hash_and_deduplicate_values
end

#initialize_dup(other) ⇒ Object


48
49
50
51
52
53
54
55
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 48

def initialize_dup(other)
  super
  @columns      = @columns.dup
  @columns_hash = @columns_hash.dup
  @primary_keys = @primary_keys.dup
  @data_sources = @data_sources.dup
  @indexes      = @indexes.dup
end

#marshal_dumpObject


184
185
186
187
188
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 184

def marshal_dump
  reset_version!

  [@version, @columns, {}, @primary_keys, @data_sources, @indexes, database_version]
end

#marshal_load(array) ⇒ Object


190
191
192
193
194
195
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 190

def marshal_load(array)
  @version, @columns, _columns_hash, @primary_keys, @data_sources, @indexes, @database_version = array
  @indexes ||= {}

  derive_columns_hash_and_deduplicate_values
end

#primary_keys(table_name) ⇒ Object


79
80
81
82
83
84
85
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 79

def primary_keys(table_name)
  @primary_keys.fetch(table_name) do
    if data_source_exists?(table_name)
      @primary_keys[deep_deduplicate(table_name)] = deep_deduplicate(connection.primary_key(table_name))
    end
  end
end

#sizeObject


159
160
161
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 159

def size
  [@columns, @columns_hash, @primary_keys, @data_sources].sum(&:size)
end