File: README — Documentation for onyx-cache-money (0.2.6.2)

## What is Cache Money ##

Cache Money is a write-through and read-through caching library for ActiveRecord.

Read-Through: Queries like ‘User.find(:all, :conditions => …)` will first look in Memcached and then look in the database for the results of that query. If there is a cache miss, it will populate the cache.

Write-Through: As objects are created, updated, and deleted, all of the caches are automatically kept up-to-date and coherent.

## Howto ## ### What kinds of queries are supported? ###

Many styles of ActiveRecord usage are supported:

* `User.find`
* `User.find_by_id`
* `User.find(:conditions => {:id => ...})`
* `User.find(:conditions => ['id = ?', ...])`
* `User.find(:conditions => 'id = ...')`
* `User.find(:conditions => 'users.id = ...')`

As you can see, the ‘find_by_`, `find_all_by`, hash, array, and string forms are all supported.

Queries with joins/includes are unsupported at this time. In general, any query involving just equality (=) and conjunction (AND) is supported by ‘Cache Money`. Disjunction (OR) and inequality (!=, <=, etc.) are not typically materialized in a hash table style index and are unsupported at this time.

Queries with limits and offsets are supported. In general, however, if you are running queries with limits and offsets you are dealing with large datasets. It’s more performant to place a limit on the size of the ‘Cache Money` index like so:

DirectMessage.index :user_id, :limit => 1000

In this example, only queries whose limit and offset are less than 1000 will use the cache.

### Multiple indices are supported ###

class User < ActiveRecord::Base
  index :screen_name
  index :email
end

#### ‘with_scope` support ####

‘with_scope` and the like (`named_scope`, `has_many`, `belongs_to`, etc.) are fully supported. For example, `user.devices.find(1)` will first look in the cache if there is an index like this:

class Device < ActiveRecord::Base
 index [:user_id, :id]
end

### Ordered indices ###

class Message < ActiveRecord::Base
  index :sender_id, :order => :desc
end

The order declaration will ensure that the index is kept in the correctly sorted order. Only queries with order clauses compatible with the ordering in the index will use the cache:

* `Message.find(:all, :conditions => {:sender_id => ...}, :order => 'id DESC')`.

Order clauses can be specified in many formats (“‘messages`.id DESC”, “`messages`.`id` DESC”, and so forth), but ordering MUST be on the primary key column.

class Message < ActiveRecord::Base
  index :sender_id, :order => :asc
end

will support queries like:

* `Message.find(:all, :conditions => {:sender_id => ...}, :order => 'id ASC')`
* `Message.find(:all, :conditions => {:sender_id => ...})`

Note that ascending order is implicit in index declarations (i.e., not specifying an order is the same as ascending). This is also true of queries (order is not nondeterministic as in MySQL).

### Window indices ###

class Message < ActiveRecord::Base
  index :sender_id, :limit => 500, :buffer => 100
end

With a limit attribute, indices will only store limit + buffer in the cache. As new objects are created the index will be truncated, and as objects are destroyed, the cache will be refreshed if it has fewer than the limit of items. The buffer is how many “extra” items to keep around in case of deletes.

It is particularly in conjunction with window indices that the ‘:order` attribute is useful.

### Calculations ###

‘Message.count(:all, :conditions => => …)` will use the cache rather than the database. This happens for “free” – no additional declarations are necessary.

### Version Numbers ###

class User < ActiveRecord::Base
  version 7
  index ...
end

You can increment the version number as you migrate your schema. Be careful how you deploy changes like this as during deployment independent mongrels may be using different versions of your code. Indices can be corrupted if you do not plan accordingly.

### Transactions ###

Because of the parallel requests writing to the same indices, race conditions are possible. We have created a pessimistic “transactional” memcache client to handle the locking issues.

The memcache client library has been enhanced to simulate transactions.

$cache.transaction do
  $cache.set(key1, value1)
  $cache.set(key2, value2)
end

The writes to the cache are buffered until the transaction is committed. Reads within the transaction read from the buffer. The writes are performed as if atomically, by acquiring locks, performing writes, and finally releasing locks. Special attention has been paid to ensure that deadlocks cannot occur and that the critical region (the duration of lock ownership) is as small as possible.

Writes are not truly atomic as reads do not pay attention to locks. Therefore, it is possible to peak inside a partially committed transaction. This is a performance compromise, since acquiring a lock for a read was deemed too expensive. Again, the critical region is as small as possible, reducing the frequency of such “peeks”.

#### Rollbacks ####

$cache.transaction do
  $cache.set(k, v)
  raise
end

Because transactions buffer writes, an exception in a transaction ensures that the writes are cleanly rolled-back (i.e., never committed to memcache). Database transactions are wrapped in memcache transactions, ensuring a database rollback also rolls back cache transactions.

Nested transactions are fully supported, with partial rollback and (apparent) partial commitment (this is simulated with nested buffers).

### Mocks ###

For your unit tests, it is faster to use a Memcached mock than the real deal. Just place this in your initializer for your test environment:

$memcache = Cash::Mock.new

### Locks ###

In most cases locks are unnecessary; the transactional Memcached client will take care locks for you automatically and guarantees that no deadlocks can occur. But for very complex distributed transactions, shared locks are necessary.

$lock.synchronize('lock_name') do
  $memcache.set("key", "value")
end

### Local Cache ###

Sometimes your code will request the same cache key twice in one request. You can avoid a round trip to the Memcached server by using a local, per-request cache. Add this to your initializer:

$local = Cash::Local.new($memcache)
$cache = Cash::Transactional.new($local, $lock)

## Installation ##

#### Step 0: Install MemCached

#### Step 1: Get the GEM ####

% gem sources -a http://gems.github.com
% sudo gem install nkallen-cache-money

#### Step 2: Configure MemCached.

Place a YAML file in ‘config/memcached.yml` with contents like:

test:
  ttl: 604800
  namespace: ...
  sessions: false
  debug: false
  servers: localhost:11211

development: 
   ....

#### Step 3: ‘config/initializers/cache_money.rb` ####

Place this in ‘config/initializers/cache_money.rb`

require 'cache_money'

config = YAML.load(IO.read(File.join(RAILS_ROOT, "config", "memcached.yml")))[RAILS_ENV]
$memcache = MemCache.new(config)
$memcache.servers = config['servers']

$local = Cash::Local.new($memcache)
$lock = Cash::Lock.new($memcache)
$cache = Cash::Transactional.new($local, $lock)

class ActiveRecord::Base
  is_cached :repository => $cache
end

#### Step 2: Add indices to your ActiveRecord models ####

Queries like ‘User.find(1)` will use the cache automatically. For more complex queries you must add indices on the attributes that you will query on. For example, a query like `User.find(:all, :conditions => => ’bob’)‘ will require an index like:

class User < ActiveRecord::Base
  index :name
end

For queries on multiple attributes, combination indexes are necessary. For example, ‘User.find(:all, :conditions => => ’bob’, :age => 26)‘

class User < ActiveRecord::Base
  index [:name, :age]
end

## Version ##

WARNING: This is currently a RELEASE CANDIDATE. A version of this code is in production use at Twitter but the extraction and refactoring process may have introduced bugs and/or performance problems. There are no known major defects at this point, but still.

## Acknowledgments ##

Thanks to

* Twitter for commissioning the development of this library and supporting the effort to open-source it.
* Sam Luckenbill for pairing with me on most of the hard stuff.
* Matthew and Chris for pairing a few days, offering useful feedback on the readability of the code, and the initial implementation of the Memcached mock.
* Evan Weaver for helping to reason-through software and testing strategies to deal with replication lag, and the initial implementation of the Memcached lock.