Class | Sequel::ShardedSingleConnectionPool |
In: |
lib/sequel/connection_pool/sharded_single.rb
|
Parent: | Sequel::ConnectionPool |
A ShardedSingleConnectionPool is a single threaded connection pool that works with multiple shards/servers.
The single threaded pool takes the following options:
:servers : | A hash of servers to use. Keys should be symbols. If not present, will use a single :default server. |
:servers_hash : | The base hash to use for the servers. By default, Sequel uses Hash.new(:default). You can use a hash with a default proc that raises an error if you want to catch all cases where a nonexistent server is used. |
# File lib/sequel/connection_pool/sharded_single.rb, line 12 12: def initialize(db, opts=OPTS) 13: super 14: @conns = {} 15: @servers = opts.fetch(:servers_hash, Hash.new(:default)) 16: add_servers([:default]) 17: add_servers(opts[:servers].keys) if opts[:servers] 18: end
Adds new servers to the connection pool. Primarily used in conjunction with master/slave or shard configurations. Allows for dynamic expansion of the potential slaves/shards at runtime. servers argument should be an array of symbols.
# File lib/sequel/connection_pool/sharded_single.rb, line 23 23: def add_servers(servers) 24: servers.each{|s| @servers[s] = s} 25: end
Yield all of the currently established connections
# File lib/sequel/connection_pool/sharded_single.rb, line 28 28: def all_connections 29: @conns.values.each{|c| yield c} 30: end
The connection for the given server.
# File lib/sequel/connection_pool/sharded_single.rb, line 33 33: def conn(server=:default) 34: @conns[@servers[server]] 35: end
Disconnects from the database. Once a connection is requested using hold, the connection is reestablished. Options:
:server : | Should be a symbol specifing the server to disconnect from, or an array of symbols to specify multiple servers. |
# File lib/sequel/connection_pool/sharded_single.rb, line 41 41: def disconnect(opts=OPTS) 42: (opts[:server] ? Array(opts[:server]) : servers).each{|s| disconnect_server(s)} 43: end
Yields the connection to the supplied block for the given server. This method simulates the ConnectionPool#hold API.
# File lib/sequel/connection_pool/sharded_single.rb, line 47 47: def hold(server=:default) 48: begin 49: server = pick_server(server) 50: yield(@conns[server] ||= make_new(server)) 51: rescue Sequel::DatabaseDisconnectError 52: disconnect_server(server) 53: raise 54: end 55: end
The ShardedSingleConnectionPool always has a maximum size of 1.
# File lib/sequel/connection_pool/sharded_single.rb, line 58 58: def max_size 59: 1 60: end
# File lib/sequel/connection_pool/sharded_single.rb, line 84 84: def pool_type 85: :sharded_single 86: end
Remove servers from the connection pool. Primarily used in conjunction with master/slave or shard configurations. Similar to disconnecting from all given servers, except that after it is used, future requests for the server will use the :default server instead.
# File lib/sequel/connection_pool/sharded_single.rb, line 66 66: def remove_servers(servers) 67: raise(Sequel::Error, "cannot remove default server") if servers.include?(:default) 68: servers.each do |server| 69: disconnect_server(server) 70: @servers.delete(server) 71: end 72: end