Class: ActiveRecord::ConnectionAdapters::SchemaCache

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(conn) ⇒ SchemaCache

Returns a new instance of SchemaCache.



9
10
11
12
13
14
15
16
17
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 9

def initialize(conn)
  @connection = conn

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

Instance Attribute Details

#connection ⇒ Object

Returns the value of attribute connection



7
8
9
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 7

def connection
  @connection
end

#version ⇒ Object (readonly)

Returns the value of attribute version



6
7
8
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 6

def version
  @version
end

Instance Method Details

#add(table_name) ⇒ Object

Add internal cache for table with table_name.



65
66
67
68
69
70
71
72
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 65

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



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

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.



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

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



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

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) ⇒ Object

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



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

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

#columns_hash?(table_name) ⇒ Boolean

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

Returns:

  • (Boolean) 


94
95
96
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 94

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

#data_source_exists?(name) ⇒ Boolean

A cached lookup for table existence.

Returns:

  • (Boolean) 


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

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) ⇒ Object 



74
75
76
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 74

def data_sources(name)
  @data_sources[name]
end

#database_version ⇒ Object

:nodoc:



104
105
106
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 104

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

#encode_with(coder) ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 28

def encode_with(coder)
  coder["columns"]          = @columns
  coder["primary_keys"]     = @primary_keys
  coder["data_sources"]     = @data_sources
  coder["indexes"]          = @indexes
  coder["version"]          = connection.migration_context.current_version
  coder["database_version"] = database_version
end

#indexes(table_name) ⇒ Object 



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

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) ⇒ Object 



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

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 



19
20
21
22
23
24
25
26
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 19

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 ⇒ Object 



132
133
134
135
136
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 132

def marshal_dump
  # if we get current version during initialization, it happens stack over flow.
  @version = connection.migration_context.current_version
  [@version, @columns, {}, @primary_keys, @data_sources, @indexes, database_version]
end

#marshal_load(array) ⇒ Object 



138
139
140
141
142
143
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 138

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 



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

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

#size ⇒ Object 



119
120
121
 
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 119

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