module `tarantool.mesh_connection`¶

This module provides API for interaction with Tarantool servers cluster.

class tarantool.mesh_connection.MeshConnection(host=None, port=None, socket_fd=None, user=None, password=None, socket_timeout=None, reconnect_max_attempts=10, reconnect_delay=0.1, connect_now=True, encoding='utf-8', call_16=False, connection_timeout=None, transport='', ssl_key_file=None, ssl_cert_file=None, ssl_ca_file=None, ssl_ciphers=None, ssl_password=None, ssl_password_file=None, auth_type=None, addrs=None, strategy_class=<class 'tarantool.mesh_connection.RoundRobinStrategy'>, cluster_discovery_function=None, cluster_discovery_delay=60, fetch_schema=True)¶

Represents a connection to a cluster of Tarantool servers.

Parameters:

host¶ – Refer to host. Value would be used to add one more server in addrs list.
port¶ – Refer to port. Value would be used to add one more server in addrs list.
socket_fd¶ – Refer to socket_fd. Value would be used to add one more server in addrs list.
user¶ – Refer to user. Value would be used to add one more server in addrs list.
password¶ – Refer to password. Value would be used to add one more server in addrs list.
socket_timeout¶ – Refer to socket_timeout. Value would be used for the current active connection.
reconnect_max_attempts¶ – Refer to reconnect_max_attempts. Value would be used for the current active connection.
reconnect_delay¶ – Refer to reconnect_delay. Value would be used for the current active connection.
connect_now¶ (bool, optional) – If True, connect to server on initialization. Otherwise, you have to call connect() manually after initialization.
encoding¶ – Refer to encoding. Value would be used for the current active connection.
call_16¶ – Refer to call_16. Value would be used for the current active connection.
connection_timeout¶ – Refer to connection_timeout. Value would be used for the current active connection.
transport¶ – Refer to transport. Value would be used to add one more server in addrs list.
ssl_key_file¶ – Refer to ssl_key_file. Value would be used to add one more server in addrs list.
ssl_cert_file¶ – Refer to ssl_cert_file. Value would be used to add one more server in addrs list.
ssl_ca_file¶ – Refer to ssl_ca_file. Value would be used to add one more server in addrs list.
ssl_ciphers¶ – Refer to ssl_ciphers. Value would be used to add one more server in addrs list.
auth_type¶ – Refer to auth_type. Value would be used to add one more server in addrs list.
addrs¶ – Cluster servers addresses list. Refer to addrs.
strategy_class¶ (object, optional) – Strategy for choosing a server after the current server fails. Defaults to the round-robin strategy.

cluster_discovery_function¶ (str or None, optional) –

sets the name of the stored Lua function used to refresh the list of available nodes. The function takes no parameters and returns a list of strings in the format 'host:port'. A generic function for getting the list of nodes looks like this:

function get_cluster_nodes()
    return {
        '192.168.0.1:3301',
        '192.168.0.2:3302?transport=ssl&ssl_ca_file=/path/to/ca.cert',
        -- ...
    }
end

You can put in this list whatever you need, depending on your cluster topology. Chances are you’ll want to derive the list of nodes from the nodes’ replication configuration. Here is an example:

local uri_lib = require('uri')

function get_cluster_nodes()
    local nodes = {}

    local replicas = box.cfg.replication

    for i = 1, #replicas do
        local uri = uri_lib.parse(replicas[i])

        if uri.host and uri.service then
            table.insert(nodes, uri.host .. ':' .. uri.service)
        end
    end

    -- if your replication config doesn't contain the current node,
    -- you have to add it manually like this:
    table.insert(nodes, '192.168.0.1:3301')

    return nodes
end

cluster_discovery_delay¶ (float, optional) – Minimal time between address list refresh.
fetch_schema¶ – Refer to fetch_schema.

Raises:

ConfigurationError, Connection exceptions, connect exceptions

Error = <class 'tarantool.error.Error'>

DBAPI compatibility.

Value:: Error

DatabaseError = <class 'tarantool.error.DatabaseError'>

DBAPI compatibility.

Value:: DatabaseError

InterfaceError = <class 'tarantool.error.InterfaceError'>

DBAPI compatibility.

Value:: InterfaceError

ConfigurationError = <class 'tarantool.error.ConfigurationError'>

DBAPI compatibility.

Value:: ConfigurationError

SchemaError = <class 'tarantool.error.SchemaError'>

DBAPI compatibility.

Value:: SchemaError

NetworkError = <class 'tarantool.error.NetworkError'>

DBAPI compatibility.

Value:: NetworkError

Warning = <class 'Warning'>

DBAPI compatibility.

Value:: Warning

DataError = <class 'tarantool.error.DataError'>

DBAPI compatibility.

Value:: DataError

OperationalError = <class 'tarantool.error.OperationalError'>

DBAPI compatibility.

Value:: OperationalError

IntegrityError = <class 'tarantool.error.IntegrityError'>

DBAPI compatibility.

Value:: IntegrityError

InternalError = <class 'tarantool.error.InternalError'>

DBAPI compatibility.

Value:: InternalError

ProgrammingError = <class 'tarantool.error.ProgrammingError'>

DBAPI compatibility.

Value:: ProgrammingError

NotSupportedError = <class 'tarantool.error.NotSupportedError'>

DBAPI compatibility.

Value:: NotSupportedError

exception CrudModuleError(_, error)¶

Exception raised for errors that are related to the operation result of crud module.

Sets fields with result and errors.

Parameters:: args (tuple) – The tuple from the crud module with result and errors.

with_traceback()¶: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

authenticate(user, password)¶

Execute an AUTHENTICATE request: authenticate a connection. There is no need to call this method explicitly until you want to reauthenticate with different parameters.

Parameters:

user¶ (str) – User to authenticate.
password¶ (str) – Password for the user.

Return type:

Response

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError

call(func_name, *args, on_push=None, on_push_ctx=None)¶

Execute a CALL request: call a stored Lua function.

Parameters:

func_name¶ (str) – Stored Lua function name.
args¶ (tuple) – Stored Lua function arguments.
on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Response

Raise:

AssertionError, SchemaError, NetworkError, SslError

close()¶: Close a connection to the server. The method is idempotent.

connect()¶

Create a connection to some server in the cluster. Refresh addresses info after success. There is no need to call this method explicitly until you have set connect_now=False on initialization.

Raise:: AssertionError, SchemaError, NetworkError, connect exceptions

crud_count(space_name: str, conditions: Optional[list] = None, opts: Optional[dict] = None) → int¶

Gets rows count through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
conditions¶ (list, optional) – The conditions for the crud module.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

int

Raise:

Iterator type	Arguments	Description
`'EQ'`	search value	The comparison operator is ‘==’ (equal to). If an index key is equal to a search value, it matches. Tuples are returned in ascending order by index key. This is the default.
`'REQ'`	search value	Matching is the same as for `'EQ'`. Tuples are returned in descending order by index key.
`'GT'`	search value	The comparison operator is ‘>’ (greater than). If an index key is greater than a search value, it matches. Tuples are returned in ascending order by index key.
`'GE'`	search value	The comparison operator is ‘>=’ (greater than or equal to). If an index key is greater than or equal to a search value, it matches. Tuples are returned in ascending order by index key.
`'ALL'`	search value	Same as `'GE'`
`'LT'`	search value	The comparison operator is ‘<’ (less than). If an index key is less than a search value, it matches. Tuples are returned in descending order by index key.
`'LE'`	search value	The comparison operator is ‘<=’ (less than or equal to). If an index key is less than or equal to a search value, it matches. Tuples are returned in descending order by index key.

Type	Arguments	Description
`'ALL'`	none	All index keys match. Tuples are returned in ascending order by hash of index key, which will appear to be random.
`'EQ'`	search value	The comparison operator is ‘==’ (equal to). If an index key is equal to a search value, it matches. The number of returned tuples will be 0 or 1. This is the default.
`'GT'`	search value	The comparison operator is ‘>’ (greater than). If a hash of an index key is greater than a hash of a search value, it matches. Tuples are returned in ascending order by hash of index key, which will appear to be random. Provided that the space is not being updated, one can retrieve all the tuples in a space, N tuples at a time, by using `iterator='GT',limit=N` in each search, and using the last returned value from the previous result as the start search value for the next search.

module tarantool.mesh_connection¶

module `tarantool.mesh_connection`¶