Class: ActiveRecord::ConnectionAdapters::SchemaCache

Inherits:
Object
  • Object
show all
Defined in:
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 '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 '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 '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.



61
62
63
64
65
66
67
68
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 61

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



101
102
103
104
105
106
107
108
109
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 101

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.



116
117
118
119
120
121
122
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 116

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



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

def columns(table_name)
  @columns[table_name] ||= connection.columns(table_name)
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.



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

def columns_hash(table_name)
  @columns_hash[table_name] ||= Hash[columns(table_name).map { |col|
    [col.name, col]
  }]
end

#columns_hash?(table_name) ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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

#data_source_exists?(name) ⇒ Boolean

A cached lookup for table existence.

Returns:

  • (Boolean) 


53
54
55
56
57
58
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 53

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

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

#data_sources(name) ⇒ Object 



70
71
72
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 70

def data_sources(name)
  @data_sources[name]
end

#database_version ⇒ Object

:nodoc:



96
97
98
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 96

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

#encode_with(coder) ⇒ Object 



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

def encode_with(coder)
  coder["columns"]          = @columns
  coder["columns_hash"]     = @columns_hash
  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 



92
93
94
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 92

def indexes(table_name)
  @indexes[table_name] ||= connection.indexes(table_name)
end

#init_with(coder) ⇒ Object 



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

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

#initialize_dup(other) ⇒ Object 



19
20
21
22
23
24
25
26
 
# File '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 



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

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

#marshal_load(array) ⇒ Object 



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

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

#primary_keys(table_name) ⇒ Object 



48
49
50
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 48

def primary_keys(table_name)
  @primary_keys[table_name] ||= data_source_exists?(table_name) ? connection.primary_key(table_name) : nil
end

#size ⇒ Object 



111
112
113
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 111

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