Methods

Attributes

[RW] connection
[R] version

Class Public methods

load_from(filename)

📝 Source code
# 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
🔎 See on GitHub

new(conn)

📝 Source code
# 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
🔎 See on GitHub

Instance Public methods

add(table_name)

Add internal cache for table with table_name.

📝 Source code
# File activerecord/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
🔎 See on GitHub

clear!()

Clears out internal caches

📝 Source code
# File activerecord/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
🔎 See on GitHub

clear_data_source_cache!(name)

Clear out internal caches for the data source name.

📝 Source code
# File activerecord/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
🔎 See on GitHub

columns(table_name)

Get the columns for a table

📝 Source code
# File activerecord/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
🔎 See on GitHub

columns_hash(table_name)

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

📝 Source code
# File activerecord/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
🔎 See on GitHub

columns_hash?(table_name)

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

📝 Source code
# File activerecord/lib/active_record/connection_adapters/schema_cache.rb, line 125
      def columns_hash?(table_name)
        @columns_hash.key?(table_name)
      end
🔎 See on GitHub

data_source_exists?(name)

A cached lookup for table existence.

📝 Source code
# File activerecord/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
🔎 See on GitHub

data_sources(name)

📝 Source code
# File activerecord/lib/active_record/connection_adapters/schema_cache.rb, line 105
      def data_sources(name)
        @data_sources[name]
      end
🔎 See on GitHub

dump_to(filename)

📝 Source code
# File activerecord/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
🔎 See on GitHub

encode_with(coder)

📝 Source code
# 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
🔎 See on GitHub

indexes(table_name)

📝 Source code
# File activerecord/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
🔎 See on GitHub

init_with(coder)

📝 Source code
# 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
🔎 See on GitHub

initialize_dup(other)

📝 Source code
# 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
🔎 See on GitHub

marshal_dump()

📝 Source code
# File activerecord/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
🔎 See on GitHub

marshal_load(array)

📝 Source code
# File activerecord/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
🔎 See on GitHub

primary_keys(table_name)

📝 Source code
# 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
🔎 See on GitHub

size()

📝 Source code
# File activerecord/lib/active_record/connection_adapters/schema_cache.rb, line 150
      def size
        [@columns, @columns_hash, @primary_keys, @data_sources].sum(&:size)
      end
🔎 See on GitHub