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.


7
8
9
10
11
12
13
14
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 7

def initialize(conn)
  @connection = conn

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

Instance Attribute Details

#connectionObject

Returns the value of attribute connection


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

def connection
  @connection
end

#versionObject (readonly)

Returns the value of attribute version


4
5
6
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 4

def version
  @version
end

Instance Method Details

#add(table_name) ⇒ Object

Add internal cache for table with table_name.


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

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

#clear!Object

Clears out internal caches


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

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

#clear_data_source_cache!(name) ⇒ Object

Clear out internal caches for the data source name.


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

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

#columns(table_name) ⇒ Object

Get the columns for a table


66
67
68
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 66

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.


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

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

#data_source_exists?(name) ⇒ Boolean

A cached lookup for table existence.

Returns:

  • (Boolean)

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

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


61
62
63
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 61

def data_sources(name)
  @data_sources[name]
end

#encode_with(coder) ⇒ Object


24
25
26
27
28
29
30
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 24

def encode_with(coder)
  coder["columns"] = @columns
  coder["columns_hash"] = @columns_hash
  coder["primary_keys"] = @primary_keys
  coder["data_sources"] = @data_sources
  coder["version"] = ActiveRecord::Migrator.current_version
end

#init_with(coder) ⇒ Object


32
33
34
35
36
37
38
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 32

def init_with(coder)
  @columns = coder["columns"]
  @columns_hash = coder["columns_hash"]
  @primary_keys = coder["primary_keys"]
  @data_sources = coder["data_sources"]
  @version = coder["version"]
end

#initialize_dup(other) ⇒ Object


16
17
18
19
20
21
22
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 16

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

#marshal_dumpObject


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

def marshal_dump
  # if we get current version during initialization, it happens stack over flow.
  @version = ActiveRecord::Migrator.current_version
  [@version, @columns, @columns_hash, @primary_keys, @data_sources]
end

#marshal_load(array) ⇒ Object


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

def marshal_load(array)
  @version, @columns, @columns_hash, @primary_keys, @data_sources = array
end

#primary_keys(table_name) ⇒ Object


40
41
42
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 40

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

#sizeObject


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

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