mirror of
https://github.com/mperham/connection_pool
synced 2023-03-27 23:22:21 -04:00
Update readme
This commit is contained in:
parent
3d3ce24d39
commit
2d8762b073
1 changed files with 19 additions and 5 deletions
24
README.md
24
README.md
|
@ -5,11 +5,6 @@ Generic connection pooling for Ruby.
|
|||
|
||||
MongoDB has its own connection pool. ActiveRecord has its own connection pool. This is a generic connection pool that can be used with anything, e.g. Redis, Dalli and other Ruby network clients.
|
||||
|
||||
Requirements
|
||||
--------------
|
||||
|
||||
connection_pool requires Ruby 1.9 because it uses BasicObject.
|
||||
|
||||
|
||||
Install
|
||||
------------
|
||||
|
@ -29,6 +24,25 @@ Then use the pool in your application:
|
|||
dalli.get('some-count')
|
||||
end
|
||||
|
||||
You can use `ConnectionPool::Wrapper` to wrap a single global connection, making
|
||||
it easier to port your connection code over time:
|
||||
|
||||
$redis = ConnectionPool::Wrapper.new(:size => 5, :timeout => 3) { Redis.connect }
|
||||
$redis.sadd('foo', 1)
|
||||
$redis.smembers('foo')
|
||||
|
||||
The Wrapper uses `method_missing` to checkout a connection, run the
|
||||
requested method and then immediately check the connection back into the
|
||||
pool. It's **not** high-performance so you'll want to port your
|
||||
performance sensitive code to use `with_connection` as soon as possible.
|
||||
|
||||
$redis.with_connection do |conn|
|
||||
conn.sadd('foo', 1)
|
||||
conn.smembers('foo')
|
||||
end
|
||||
|
||||
Once you've ported your entire system to use `with`, you can simply
|
||||
remove ::Wrapper and use a simple, fast ConnectionPool.
|
||||
|
||||
Author
|
||||
--------------
|
||||
|
|
Loading…
Reference in a new issue