Module cartridge.pool
Connection pool.
Reuse tarantool net.box connections with ease.
Functions
connect (uri[, opts]) | Connect a remote or get cached connection. |
Local Functions
format_uri (uri) | Enrich URI with credentials. |
map_call (fn_name[, args[, opts]]) | Perform a remote call to multiple URIs and map results. |
Functions
- connect (uri[, opts])
-
Connect a remote or get cached connection.
Connection is established using
net.box.connect()
.Parameters:
- uri string
- opts
- wait_connected
boolean or number
by default, connection creation is blocked until the
connection is established, but passing
wait_connected=false
makes it return immediately. Also, passing a timeout makes it wait before returning (e.g.wait_connected=1.5
makes it wait at most 1.5 seconds). - connect_timeout
optional number
(deprecated)
Use
wait_connected
instead - user (deprecated) don't use it
- password (deprecated) don't use it
- reconnect_after (deprecated) don't use it
- wait_connected
boolean or number
by default, connection creation is blocked until the
connection is established, but passing
Returns:
net.box
connectionOr
- nil
- table Error description
Local Functions
- format_uri (uri)
-
Enrich URI with credentials.
Suitable to connect other cluster instances.
Parameters:
- uri
string
host:port
Returns:
-
string
username:password@host:port
- uri
string
- map_call (fn_name[, args[, opts]])
-
Perform a remote call to multiple URIs and map results.
(Added in v1.2.0-17)
Parameters:
- fn_name string
- args table function arguments (optional)
- opts
- uri_list {string,...} array of URIs for performing remote call
- timeout
optional number
passed to
net.box
conn:call()
Returns:
- {URI=value,...} Call results mapping for every URI.
- table United error object, gathering errors for every URI that failed.