# File 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
class ActiveRecord::ConnectionAdapters::SchemaCache
Attributes
connection[RW]
version[R]
Public Class Methods
load_from(filename)
click to toggle source
# File 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
new(conn)
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 38 def initialize(conn) @connection = conn @columns = {} @columns_hash = {} @primary_keys = {} @data_sources = {} @indexes = {} end
Private Class Methods
read(filename) { |read| ... }
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 24 def self.read(filename, &block) if File.extname(filename) == ".gz" Zlib::GzipReader.open(filename) { |gz| yield gz.read } else yield File.read(filename) end end
Public Instance Methods
add(table_name)
click to toggle source
Add internal cache for table with table_name
.
# File lib/active_record/connection_adapters/schema_cache.rb, line 96 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!()
click to toggle source
Clears out internal caches
# File lib/active_record/connection_adapters/schema_cache.rb, line 140 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)
click to toggle source
Clear out internal caches for the data source name
.
# File lib/active_record/connection_adapters/schema_cache.rb, line 155 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)
click to toggle source
Get the columns for a table
# File lib/active_record/connection_adapters/schema_cache.rb, line 110 def columns(table_name) @columns.fetch(table_name) do @columns[deep_deduplicate(table_name)] = deep_deduplicate(connection.columns(table_name)) end end
columns_hash(table_name)
click to toggle source
Get the columns for a table as a hash, key is the column name value is the column object.
# File lib/active_record/connection_adapters/schema_cache.rb, line 118 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)
click to toggle source
Checks whether the columns hash is already cached for a table.
# File lib/active_record/connection_adapters/schema_cache.rb, line 125 def columns_hash?(table_name) @columns_hash.key?(table_name) end
data_source_exists?(name)
click to toggle source
A cached lookup for table existence.
# File lib/active_record/connection_adapters/schema_cache.rb, line 88 def data_source_exists?(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)
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 105 def data_sources(name) @data_sources[name] end
dump_to(filename)
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 163 def dump_to(filename) clear! connection.data_sources.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)
click to toggle source
# File 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)
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 129 def indexes(table_name) @indexes.fetch(table_name) do @indexes[deep_deduplicate(table_name)] = deep_deduplicate(connection.indexes(table_name)) end end
init_with(coder)
click to toggle source
# File 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)
click to toggle source
Calls superclass method
# File 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_dump()
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 175 def marshal_dump reset_version! [@version, @columns, {}, @primary_keys, @data_sources, @indexes, database_version] end
marshal_load(array)
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 181 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)
click to toggle source
size()
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 150 def size [@columns, @columns_hash, @primary_keys, @data_sources].sum(&:size) end
Private Instance Methods
deep_deduplicate(value)
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 202 def deep_deduplicate(value) case value when Hash value.transform_keys { |k| deep_deduplicate(k) }.transform_values { |v| deep_deduplicate(v) } when Array value.map { |i| deep_deduplicate(i) } when String if value.tainted? # Ruby 2.6 and 2.7 have slightly different implementations of the String#-@ method. # In Ruby 2.6, the receiver of the String#-@ method is modified under certain # circumstances, and this was later identified as a bug # (https://bugs.ruby-lang.org/issues/15926) and only fixed in Ruby 2.7. value = value.dup end -value when Deduplicable -value else value end end
derive_columns_hash_and_deduplicate_values()
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 193 def derive_columns_hash_and_deduplicate_values @columns = deep_deduplicate(@columns) @columns_hash = @columns.transform_values { |columns| columns.index_by(&:name) } @primary_keys = deep_deduplicate(@primary_keys) @data_sources = deep_deduplicate(@data_sources) @indexes = deep_deduplicate(@indexes) end
open(filename) { |zipper| ... }
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 242 def open(filename) File.atomic_write(filename) do |file| if File.extname(filename) == ".gz" zipper = Zlib::GzipWriter.new file yield zipper zipper.flush zipper.close else yield file end end end
prepare_data_sources()
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 238 def prepare_data_sources connection.data_sources.each { |source| @data_sources[source] = true } end
reset_version!()
click to toggle source
# File lib/active_record/connection_adapters/schema_cache.rb, line 189 def reset_version! @version = connection.migration_context.current_version end