Module: Sequel::Plugins::Caching::ClassMethods

Defined in:
lib/sequel/plugins/caching.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#cache_ignore_exceptionsObject (readonly)

If true, ignores exceptions when gettings cached records (the memcached API).


54
55
56
# File 'lib/sequel/plugins/caching.rb', line 54

def cache_ignore_exceptions
  @cache_ignore_exceptions
end

#cache_storeObject (readonly)

The cache store object for the model, which should implement the Ruby-Memcache (or memcached) API


58
59
60
# File 'lib/sequel/plugins/caching.rb', line 58

def cache_store
  @cache_store
end

#cache_ttlObject (readonly)

The time to live for the cache store, in seconds.


61
62
63
# File 'lib/sequel/plugins/caching.rb', line 61

def cache_ttl
  @cache_ttl
end

Instance Method Details

#cache_delete_pk(pk) ⇒ Object

Delete the cached object with the given primary key.


64
65
66
# File 'lib/sequel/plugins/caching.rb', line 64

def cache_delete_pk(pk)
  cache_delete(cache_key(pk))
end

#cache_get_pk(pk) ⇒ Object

Return the cached object with the given primary key, or nil if no such object is in the cache.


70
71
72
# File 'lib/sequel/plugins/caching.rb', line 70

def cache_get_pk(pk)
  cache_get(cache_key(pk))
end

#cache_key(pk) ⇒ Object

Return a key string for the given primary key.

Raises:


80
81
82
83
# File 'lib/sequel/plugins/caching.rb', line 80

def cache_key(pk)
  raise(Error, 'no primary key for this record') unless pk.is_a?(Array) ? pk.all? : pk
  "#{cache_key_prefix}:#{Array(pk).join(',')}"
end

#cache_key_prefixObject

Returns the prefix used to namespace this class in the cache.


75
76
77
# File 'lib/sequel/plugins/caching.rb', line 75

def cache_key_prefix
  to_s
end

#set_cache_ttl(ttl) ⇒ Object

Set the time to live for the cache store, in seconds (default is 3600, # so 1 hour).


88
89
90
# File 'lib/sequel/plugins/caching.rb', line 88

def set_cache_ttl(ttl)
  @cache_ttl = ttl
end