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 = {}
  @tables       = {}
  prepare_default_proc
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.



36
37
38
39
40
41
42
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 36

def add(table_name)
  if table_exists?(table_name)
    @primary_keys[table_name]
    @columns[table_name]
    @columns_hash[table_name]
  end
end

#clear! ⇒ Object

Clears out internal caches



75
76
77
78
79
80
81
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 75

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

#clear_table_cache!(table_name) ⇒ Object

Clear out internal caches for table with table_name.



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

def clear_table_cache!(table_name)
  @columns.delete table_name
  @columns_hash.delete table_name
  @primary_keys.delete table_name
  @tables.delete table_name
end

#columns(table = nil) ⇒ Object

Get the columns for a table



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

def columns(table = nil)
  if table
    @columns[table]
  else
    ActiveSupport::Deprecation.warn('call columns with a table name!')
    @columns.dup
  end
end

#columns_hash(table = nil) ⇒ Object

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



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

def columns_hash(table = nil)
  if table
    @columns_hash[table]
  else
    ActiveSupport::Deprecation.warn('call columns_hash with a table name!')
    @columns_hash.dup
  end
end

#marshal_dump ⇒ Object 



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

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, @tables].map { |val|
    Hash[val]
  }
end

#marshal_load(array) ⇒ Object 



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

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

#primary_keys(table_name = nil) ⇒ Object 



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

def primary_keys(table_name = nil)
  if table_name
    @primary_keys[table_name]
  else
    ActiveSupport::Deprecation.warn('call primary_keys with a table name!')
    @primary_keys.dup
  end
end

#size ⇒ Object 



83
84
85
86
87
 
# File 'lib/active_record/connection_adapters/schema_cache.rb', line 83

def size
  [@columns, @columns_hash, @primary_keys, @tables].map { |x|
    x.size
  }.inject :+
end

#table_exists?(name) ⇒ Boolean

A cached lookup for table existence.

Returns:

  • (Boolean) 


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

def table_exists?(name)
  return @tables[name] if @tables.key? name

  @tables[name] = connection.table_exists?(name)
end

#tables(name = nil) ⇒ Object 



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

def tables(name = nil)
  if name
    @tables[name]
  else
    ActiveSupport::Deprecation.warn('call tables with a name!')
    @tables.dup
  end
end