class Sequel::ShardedThreadedConnectionPool
The slowest and most advanced connection, dealing with both multi-threaded access and configurations with multiple shards/servers.
In addition, this pool subclass also handles scheduling in-use connections to be removed from the pool when they are returned to it.
Public Class Methods
The following additional options are respected:
- :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.
Sequel::ThreadedConnectionPool::new
# File lib/sequel/connection_pool/sharded_threaded.rb 18 def initialize(db, opts = OPTS) 19 super 20 @available_connections = {} 21 @connections_to_remove = [] 22 @connections_to_disconnect = [] 23 @servers = opts.fetch(:servers_hash, Hash.new(:default)) 24 remove_instance_variable(:@waiter) 25 @waiters = {} 26 27 add_servers([:default]) 28 add_servers(opts[:servers].keys) if opts[:servers] 29 end
Public Instance Methods
Adds new servers to the connection pool. Allows for dynamic expansion of the potential replicas/shards at runtime. servers
argument should be an array of symbols.
# File lib/sequel/connection_pool/sharded_threaded.rb 33 def add_servers(servers) 34 sync do 35 servers.each do |server| 36 unless @servers.has_key?(server) 37 @servers[server] = server 38 @available_connections[server] = [] 39 @allocated[server] = {} 40 @waiters[server] = ConditionVariable.new 41 end 42 end 43 end 44 end
Yield all of the available connections, and the ones currently allocated to this thread. This will not yield connections currently allocated to other threads, as it is not safe to operate on them. This holds the mutex while it is yielding all of the connections, which means that until the method's block returns, the pool is locked.
# File lib/sequel/connection_pool/sharded_threaded.rb 59 def all_connections 60 t = Sequel.current 61 sync do 62 @allocated.values.each do |threads| 63 threads.each do |thread, conn| 64 yield conn if t == thread 65 end 66 end 67 @available_connections.values.each{|v| v.each{|c| yield c}} 68 end 69 end
A hash of connections currently being used for the given server, key is the Thread, value is the connection. Nonexistent servers will return nil. Treat this as read only, do not modify the resulting object. The calling code should already have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 50 def allocated(server=:default) 51 @allocated[server] 52 end
An array of connections opened but not currently used, for the given server. Nonexistent servers will return nil. Treat this as read only, do not modify the resulting object. The calling code should already have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 75 def available_connections(server=:default) 76 @available_connections[server] 77 end
Removes all connections currently available on all servers, optionally yielding each connection to the given block. This method has the effect of disconnecting from the database, assuming that no connections are currently being used. If connections are being used, they are scheduled to be disconnected as soon as they are returned to the pool.
Once a connection is requested using hold
, the connection pool creates new connections to the database. 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_threaded.rb 96 def disconnect(opts=OPTS) 97 (opts[:server] ? Array(opts[:server]) : sync{@servers.keys}).each do |s| 98 disconnect_connections(sync{disconnect_server_connections(s)}) 99 end 100 end
# File lib/sequel/connection_pool/sharded_threaded.rb 102 def freeze 103 @servers.freeze 104 super 105 end
Chooses the first available connection to the given server, or if none are available, creates a new connection. Passes the connection to the supplied block:
pool.hold {|conn| conn.execute('DROP TABLE posts')}
Pool#hold is re-entrant, meaning it can be called recursively in the same thread without blocking.
If no connection is immediately available and the pool is already using the maximum number of connections, Pool#hold will block until a connection is available or the timeout expires. If the timeout expires before a connection can be acquired, a Sequel::PoolTimeout is raised.
# File lib/sequel/connection_pool/sharded_threaded.rb 120 def hold(server=:default) 121 server = pick_server(server) 122 t = Sequel.current 123 if conn = owned_connection(t, server) 124 return yield(conn) 125 end 126 begin 127 conn = acquire(t, server) 128 yield conn 129 rescue Sequel::DatabaseDisconnectError, *@error_classes => e 130 sync{@connections_to_remove << conn} if conn && disconnect_error?(e) 131 raise 132 ensure 133 sync{release(t, conn, server)} if conn 134 while dconn = sync{@connections_to_disconnect.shift} 135 disconnect_connection(dconn) 136 end 137 end 138 end
# File lib/sequel/connection_pool/sharded_threaded.rb 168 def pool_type 169 :sharded_threaded 170 end
Remove servers from the connection pool. 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_threaded.rb 143 def remove_servers(servers) 144 conns = nil 145 sync do 146 raise(Sequel::Error, "cannot remove default server") if servers.include?(:default) 147 servers.each do |server| 148 if @servers.include?(server) 149 conns = disconnect_server_connections(server) 150 @waiters.delete(server) 151 @available_connections.delete(server) 152 @allocated.delete(server) 153 @servers.delete(server) 154 end 155 end 156 end 157 158 if conns 159 disconnect_connections(conns) 160 end 161 end
Return an array of symbols for servers in the connection pool.
# File lib/sequel/connection_pool/sharded_threaded.rb 164 def servers 165 sync{@servers.keys} 166 end
The total number of connections opened for the given server. Nonexistent servers will return the created count of the default server. The calling code should NOT have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 82 def size(server=:default) 83 @mutex.synchronize{_size(server)} 84 end
Private Instance Methods
The total number of connections opened for the given server. The calling code should already have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 176 def _size(server) 177 server = @servers[server] 178 @allocated[server].length + @available_connections[server].length 179 end
Assigns a connection to the supplied thread, if one is available. The calling code should NOT already have the mutex when calling this.
This should return a connection is one is available within the timeout, or nil if a connection could not be acquired within the timeout.
# File lib/sequel/connection_pool/sharded_threaded.rb 187 def acquire(thread, server) 188 if conn = assign_connection(thread, server) 189 return conn 190 end 191 192 timeout = @timeout 193 timer = Sequel.start_timer 194 195 sync do 196 @waiters[server].wait(@mutex, timeout) 197 if conn = next_available(server) 198 return(allocated(server)[thread] = conn) 199 end 200 end 201 202 until conn = assign_connection(thread, server) 203 elapsed = Sequel.elapsed_seconds_since(timer) 204 # :nocov: 205 raise_pool_timeout(elapsed, server) if elapsed > timeout 206 207 # It's difficult to get to this point, it can only happen if there is a race condition 208 # where a connection cannot be acquired even after the thread is signalled by the condition variable 209 sync do 210 @waiters[server].wait(@mutex, timeout - elapsed) 211 if conn = next_available(server) 212 return(allocated(server)[thread] = conn) 213 end 214 end 215 # :nocov: 216 end 217 218 conn 219 end
Assign a connection to the thread, or return nil if one cannot be assigned. The caller should NOT have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 223 def assign_connection(thread, server) 224 alloc = nil 225 226 do_make_new = false 227 sync do 228 alloc = allocated(server) 229 if conn = next_available(server) 230 alloc[thread] = conn 231 return conn 232 end 233 234 if (n = _size(server)) >= (max = @max_size) 235 alloc.to_a.each do |t,c| 236 unless t.alive? 237 remove(t, c, server) 238 end 239 end 240 n = nil 241 end 242 243 if (n || _size(server)) < max 244 do_make_new = alloc[thread] = true 245 end 246 end 247 248 # Connect to the database outside of the connection pool mutex, 249 # as that can take a long time and the connection pool mutex 250 # shouldn't be locked while the connection takes place. 251 if do_make_new 252 begin 253 conn = make_new(server) 254 sync{alloc[thread] = conn} 255 ensure 256 unless conn 257 sync{alloc.delete(thread)} 258 end 259 end 260 end 261 262 conn 263 end
Return a connection to the pool of available connections for the server, returns the connection. The calling code should already have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 268 def checkin_connection(server, conn) 269 available_connections(server) << conn 270 @waiters[server].signal 271 conn 272 end
Disconnect all available connections immediately, and schedule currently allocated connections for disconnection as soon as they are returned to the pool. The calling code should NOT have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 294 def disconnect_connections(conns) 295 conns.each{|conn| disconnect_connection(conn)} 296 end
Clear the array of available connections for the server, returning an array of previous available connections that should be disconnected (or nil if none should be). Mark any allocated connections to be removed when they are checked back in. The calling code should already have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 278 def disconnect_server_connections(server) 279 remove_conns = allocated(server) 280 dis_conns = available_connections(server) 281 raise Sequel::Error, "invalid server: #{server}" unless remove_conns && dis_conns 282 283 @connections_to_remove.concat(remove_conns.values) 284 285 conns = dis_conns.dup 286 dis_conns.clear 287 @waiters[server].signal 288 conns 289 end
Return the next available connection in the pool for the given server, or nil if there is not currently an available connection for the server. The calling code should already have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 301 def next_available(server) 302 case @connection_handling 303 when :stack 304 available_connections(server).pop 305 else 306 available_connections(server).shift 307 end 308 end
Returns the connection owned by the supplied thread for the given server, if any. The calling code should NOT already have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 312 def owned_connection(thread, server) 313 sync{@allocated[server][thread]} 314 end
If the server given is in the hash, return it, otherwise, return the default server.
# File lib/sequel/connection_pool/sharded_threaded.rb 317 def pick_server(server) 318 sync{@servers[server]} 319 end
Create the maximum number of connections immediately. The calling code should NOT have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 323 def preconnect(concurrent = false) 324 conn_servers = @servers.keys.map!{|s| Array.new(max_size - _size(s), s)}.flatten! 325 326 if concurrent 327 conn_servers.map!{|s| Thread.new{[s, make_new(s)]}}.map!(&:value) 328 else 329 conn_servers.map!{|s| [s, make_new(s)]} 330 end 331 332 sync{conn_servers.each{|s, conn| checkin_connection(s, conn)}} 333 end
Raise a PoolTimeout error showing the current timeout, the elapsed time, the server the connection attempt was made to, and the database's name (if any).
# File lib/sequel/connection_pool/sharded_threaded.rb 337 def raise_pool_timeout(elapsed, server) 338 name = db.opts[:name] 339 raise ::Sequel::PoolTimeout, "timeout: #{@timeout}, elapsed: #{elapsed}, server: #{server}#{", database name: #{name}" if name}" 340 end
Releases the connection assigned to the supplied thread and server. If the server or connection given is scheduled for disconnection, remove the connection instead of releasing it back to the pool. The calling code should already have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 346 def release(thread, conn, server) 347 if @connections_to_remove.include?(conn) 348 remove(thread, conn, server) 349 else 350 conn = allocated(server).delete(thread) 351 352 if @connection_handling == :disconnect 353 @connections_to_disconnect << conn 354 else 355 checkin_connection(server, conn) 356 end 357 end 358 359 if waiter = @waiters[server] 360 waiter.signal 361 end 362 end
Removes the currently allocated connection from the connection pool. The calling code should already have the mutex before calling this.
# File lib/sequel/connection_pool/sharded_threaded.rb 366 def remove(thread, conn, server) 367 @connections_to_remove.delete(conn) 368 allocated(server).delete(thread) if @servers.include?(server) 369 @connections_to_disconnect << conn 370 end