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


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

def initialize(conn)
  @connection = conn

  @columns      = {}
  @columns_hash = {}
  @primary_keys = {}
  @tables       = {}
  prepare_default_proc
end

Instance Attribute Details

#connectionObject

Returns the value of attribute connection


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

def connection
  @connection
end

#versionObject (readonly)

Returns the value of attribute version


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

def version
  @version
end

Instance Method Details

#add(table_name) ⇒ Object

Add internal cache for table with table_name.


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

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


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

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.


69
70
71
72
73
74
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 69

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

Get the columns for a table


43
44
45
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 43

def columns(table)
  @columns[table]
end

#columns_hash(table) ⇒ Object

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


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

def columns_hash(table)
  @columns_hash[table]
end

#marshal_dumpObject


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

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


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

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

#primary_keys(table_name) ⇒ Object


18
19
20
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 18

def primary_keys(table_name)
  @primary_keys[table_name]
end

#sizeObject


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

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

#table_exists?(name) ⇒ Boolean

A cached lookup for table existence.


23
24
25
26
27
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 23

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

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

#tables(name) ⇒ Object


38
39
40
# File 'activerecord/lib/active_record/connection_adapters/schema_cache.rb', line 38

def tables(name)
  @tables[name]
end