module tarantool ¶

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:

Raise:

AssertionError, SchemaError, NetworkError, SslError

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

connect()¶

Create a connection to the host and port specified on initialization. There is no need to call this method explicitly until you have set connect_now=False on initialization.

Raise:: NetworkError, SslError, SchemaError, DatabaseError

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:

Raise:

crud_delete(space_name: str, key: int, opts: Optional[dict] = None) → CrudResult¶

Deletes row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
key¶ (int) – The primary key value.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_get(space_name: str, key: int, opts: Optional[dict] = None) → CrudResult¶

Gets row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
key¶ (int) – The primary key value.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_insert(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Inserts row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_insert_many(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Inserts batch rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_insert_object(space_name: str, values: dict, opts: Optional[dict] = None) → CrudResult¶

Inserts object row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (dict) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_insert_object_many(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Inserts batch object rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

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

Gets the number of tuples in the space through the crud.

Parameters:

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

Return type:

Raise:

crud_max(space_name: str, index_name: str, opts: Optional[dict] = None) → CrudResult¶

Gets rows with maximum value in the specified index through the crud.

Parameters:

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

Return type:

Raise:

crud_min(space_name: str, index_name: str, opts: Optional[dict] = None) → CrudResult¶

Gets rows with minimum value in the specified index through the crud.

Parameters:

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

Return type:

Raise:

crud_replace(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Replaces row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_replace_many(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Replaces batch rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_replace_object(space_name: str, values: dict, opts: Optional[dict] = None) → CrudResult¶

Replaces object row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (dict) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_replace_object_many(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Replaces batch object rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

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

Selects rows through the crud.

Parameters:

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

Return type:

Raise:

CrudModuleError, :exc:`~tarantool.error.DatabaseError`select

crud_stats(space_name: Optional[str] = None) → CrudResult¶

Gets statistics from the crud.

Parameters:: space_name¶ (str, optional) – The name of the target space.
Return type:: CrudResult
Raise:: DatabaseError

crud_storage_info(opts: Optional[dict] = None) → dict¶

Gets storages status through the crud.

Parameters:: opts¶ (dict, optional) – The opts for the crud module.
Return type:: dict
Raise:: CrudModuleError, DatabaseError

crud_truncate(space_name: str, opts: Optional[dict] = None) → bool¶

Truncate rows through the crud.

Parameters:

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

Return type:

bool

Raise:

crud_unflatten_rows(rows: list, metadata: list) → list¶

Makes rows unflatten through the crud.

Parameters:

rows¶ (list) – The rows to unflatten.
metadata¶ (list) – The metadata to unflatten.

Return type:

list

crud_update(space_name: str, key: int, operations: Optional[list] = None, opts: Optional[dict] = None) → CrudResult¶

Updates row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
key¶ (int) – The primary key value.
operations¶ (list, optional) – The update operations for the crud module.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_upsert(space_name: str, values: Union[tuple, list], operations: Optional[list] = None, opts: Optional[dict] = None) → CrudResult¶

Upserts row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
operations¶ (list, optional) – The update operations for the crud module.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_upsert_many(space_name: str, values_operation: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Upserts batch rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values_operation¶ (tuple or list) – The data with update operations.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_upsert_object(space_name: str, values: dict, operations: Optional[list] = None, opts: Optional[dict] = None) → CrudResult¶

Upserts object row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (dict) – Tuple to be inserted.
operations¶ (list, optional) – The update operations for the crud module.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_upsert_object_many(space_name: str, values_operation: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Upserts batch object rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values_operation¶ (tuple or list) – The data with update operations.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

delete(space_name, key, *, index=0, on_push=None, on_push_ctx=None)¶

Execute a DELETE request: delete a tuple in the space.

Parameters:

space_name¶ (str or int) – Space name or space id.
key¶ – Key of a tuple to be deleted.
index¶ (str or int, optional) – Index name or index id. If you’re using a secondary index, it must be unique. Defaults to primary index.
on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

eval(expr, *args, on_push=None, on_push_ctx=None)¶

Execute an EVAL request: evaluate a Lua expression.

Parameters:

expr¶ (str) – Lua expression.
args¶ (tuple) – Lua expression 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:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError

execute(query, params=None)¶

Execute an SQL request: see documentation for syntax reference.

The Tarantool binary protocol for SQL requests supports “qmark” and “named” param styles. A sequence of values can be used for “qmark” style. A mapping is used for “named” param style without the leading colon in the keys.

Example for “qmark” arguments:

args = ['email@example.com']
c.execute('select * from "users" where "email"=?', args)

Example for “named” arguments:

args = {'email': 'email@example.com'}
c.execute('select * from "users" where "email"=:email', args)

Parameters:

query¶ (str) – SQL query.
params¶ (dict or list or None, optional) – SQL query bind values.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError

flush_schema()¶

Reload space and index schema.

Raise:: SchemaError, DatabaseError

insert(space_name, values, *, on_push=None, on_push_ctx=None)¶

Execute an INSERT request: insert a tuple to the space. Throws an error if there is already a tuple with the same primary key.

Parameters:

space_name¶ (str or int) – Space name or space id.
values¶ (tuple or list) – Record to be inserted.
on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

is_closed()¶

Returns True if connection is closed. False otherwise.

Return type:: bool

ping(notime=False)¶

Execute a PING request: send an empty request and receive an empty response from the server.

Parameters:: notime¶ (bool, optional) – If False, returns response time. Otherwise, it returns 'Success'.
Returns:: Response time or 'Success'.
Return type:: float or str
Raise:: AssertionError, DatabaseError, SchemaError, NetworkError, SslError

replace(space_name, values, *, on_push=None, on_push_ctx=None)¶

Execute a REPLACE request: replace a tuple in the space. Doesn’t throw an error if there is no tuple with the specified primary key.

Parameters:

space_name¶ (str or int) – Space name or space id.
values¶ (tuple or list) – Tuple to be replaced.
on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

select(space_name, key=None, *, offset=0, limit=4294967295, index=0, iterator=None, on_push=None, on_push_ctx=None)¶

Execute a SELECT request: select a tuple from the space.

Parameters:

space_name¶ (str or int) – Space name or space id.
key¶ (optional) – Key of a tuple to be selected.
offset¶ (int, optional) – Number of tuples to skip.
limit¶ (str or int, optional) – Maximum number of tuples to select.
index¶ – Index name or index id to select. Defaults to primary index.

iterator¶ –

Index iterator type.

Iterator types for TREE indexes:

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.

Iterator types for HASH indexes:

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.

Iterator types for BITSET indexes:

Type

Arguments

Description

'ALL'

none

All index keys match. Tuples are returned in their order within the space.

'EQ'

bitset value

If an index key is equal to a bitset value, it matches. Tuples are returned in their order within the space. This is the default.

'BITS_ALL_SET'

bitset value

If all of the bits which are 1 in the bitset value are 1 in the index key, it matches. Tuples are returned in their order within the space.

'BITS_ANY_SET'

bitset value

If any of the bits which are 1 in the bitset value are 1 in the index key, it matches. Tuples are returned in their order within the space.

'BITS_ALL_NOT_SET'

bitset value

If all of the bits which are 1 in the bitset value are 0 in the index key, it matches. Tuples are returned in their order within the space.

on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

space(space_name)¶

Create a Space instance for a particular space.

Parameters:: space_name¶ (str or int) – Space name or space id.
Return type:: Space
Raise:: SchemaError

update(space_name, key, op_list, *, index=0, on_push=None, on_push_ctx=None)¶

Execute an UPDATE request: update a tuple in the space.

Parameters:

space_name¶ (str or int) – Space name or space id.
key¶ – Key of a tuple to be updated.
op_list¶ (tuple or list) –
The list of operations to update individual fields. Each operation is a tuple of three (or more) values: (operator, field_identifier, value).

Possible operators are:
- '+' for addition. values must be numeric
- '-' for subtraction. values must be numeric
- '&' for bitwise AND. values must be unsigned numeric
- '|' for bitwise OR. values must be unsigned numeric
- '^' for bitwise XOR. values must be unsigned numeric
- ':' for string splice. you must provide offset, count, and value for this operation
- '!' for insertion. provide any element to insert)
- '=' for assignment. (provide any element to assign)
- '#' for deletion. provide count of fields to delete)
Possible field_identifiers are:
- Positive field number. The first field is 1, the second field is 2, and so on.
- Negative field number. The last field is -1, the second-last field is -2, and so on. In other words: (#tuple + negative field number + 1).
- Name. If the space was formatted with space_object:format(), then this can be a string for the field name (Since Tarantool 2.3.1).
Operation examples:
```
# 'ADD' 55 to the second field
# Assign 'x' to the third field
[('+', 2, 55), ('=', 3, 'x')]
# 'OR' the third field with '1'
# Cut three symbols, starting from the second,
# and replace them with '!!'
# Insert 'hello, world' field before the fifth element of the tuple
[('|', 3, 1), (':', 2, 2, 3, '!!'), ('!', 5, 'hello, world')]
# Delete two fields, starting with the second field
[('#', 2, 2)]
```
index¶ (str or int, optional) – Index name or index id. If you’re using a secondary index, it must be unique. Defaults to primary index.
on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

upsert(space_name, tuple_value, op_list, *, index=0, on_push=None, on_push_ctx=None)¶

Execute an UPSERT request: upsert a tuple to the space.

If an existing tuple matches the key fields of tuple_value, then the request has the same effect as UPDATE and the [(field_1, symbol_1, arg_1), ...] parameter is used.

If there is no tuple matching the key fields of tuple_value, then the request has the same effect as INSERT and the tuple_value parameter is used. However, unlike insert or update, upsert will neither read the tuple nor perform error checks before returning – this is a design feature which enhances throughput but requires more caution on the part of the user.

Parameters:

space_name¶ (str or int) – Space name or space id.
tuple_value¶ (tuple or list) – Tuple to be upserted.
op_list¶ (tuple or list) – Refer to update() op_list.
index¶ (str or int, optional) – Index name or index id. If you’re using a secondary index, it must be unique. Defaults to primary index.
on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

class tarantool.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:

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:

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:

Raise:

crud_delete(space_name: str, key: int, opts: Optional[dict] = None) → CrudResult¶

Deletes row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
key¶ (int) – The primary key value.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_get(space_name: str, key: int, opts: Optional[dict] = None) → CrudResult¶

Gets row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
key¶ (int) – The primary key value.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_insert(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Inserts row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_insert_many(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Inserts batch rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_insert_object(space_name: str, values: dict, opts: Optional[dict] = None) → CrudResult¶

Inserts object row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (dict) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_insert_object_many(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Inserts batch object rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

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

Gets the number of tuples in the space through the crud.

Parameters:

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

Return type:

Raise:

crud_max(space_name: str, index_name: str, opts: Optional[dict] = None) → CrudResult¶

Gets rows with maximum value in the specified index through the crud.

Parameters:

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

Return type:

Raise:

crud_min(space_name: str, index_name: str, opts: Optional[dict] = None) → CrudResult¶

Gets rows with minimum value in the specified index through the crud.

Parameters:

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

Return type:

Raise:

crud_replace(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Replaces row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_replace_many(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Replaces batch rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_replace_object(space_name: str, values: dict, opts: Optional[dict] = None) → CrudResult¶

Replaces object row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (dict) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_replace_object_many(space_name: str, values: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Replaces batch object rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

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

Selects rows through the crud.

Parameters:

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

Return type:

Raise:

CrudModuleError, :exc:`~tarantool.error.DatabaseError`select

crud_stats(space_name: Optional[str] = None) → CrudResult¶

Gets statistics from the crud.

Parameters:: space_name¶ (str, optional) – The name of the target space.
Return type:: CrudResult
Raise:: DatabaseError

crud_storage_info(opts: Optional[dict] = None) → dict¶

Gets storages status through the crud.

Parameters:: opts¶ (dict, optional) – The opts for the crud module.
Return type:: dict
Raise:: CrudModuleError, DatabaseError

crud_truncate(space_name: str, opts: Optional[dict] = None) → bool¶

Truncate rows through the crud.

Parameters:

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

Return type:

bool

Raise:

crud_unflatten_rows(rows: list, metadata: list) → list¶

Makes rows unflatten through the crud.

Parameters:

rows¶ (list) – The rows to unflatten.
metadata¶ (list) – The metadata to unflatten.

Return type:

list

crud_update(space_name: str, key: int, operations: Optional[list] = None, opts: Optional[dict] = None) → CrudResult¶

Updates row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
key¶ (int) – The primary key value.
operations¶ (list, optional) – The update operations for the crud module.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_upsert(space_name: str, values: Union[tuple, list], operations: Optional[list] = None, opts: Optional[dict] = None) → CrudResult¶

Upserts row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (tuple or list) – Tuple to be inserted.
operations¶ (list, optional) – The update operations for the crud module.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_upsert_many(space_name: str, values_operation: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Upserts batch rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values_operation¶ (tuple or list) – The data with update operations.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_upsert_object(space_name: str, values: dict, operations: Optional[list] = None, opts: Optional[dict] = None) → CrudResult¶

Upserts object row through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values¶ (dict) – Tuple to be inserted.
operations¶ (list, optional) – The update operations for the crud module.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

crud_upsert_object_many(space_name: str, values_operation: Union[tuple, list], opts: Optional[dict] = None) → CrudResult¶

Upserts batch object rows through the crud.

Parameters:

space_name¶ (str) – The name of the target space.
values_operation¶ (tuple or list) – The data with update operations.
opts¶ (dict, optional) – The opts for the crud module.

Return type:

Raise:

delete(space_name, key, *, index=0, on_push=None, on_push_ctx=None)¶

Execute a DELETE request: delete a tuple in the space.

Parameters:

space_name¶ (str or int) – Space name or space id.
key¶ – Key of a tuple to be deleted.
index¶ (str or int, optional) – Index name or index id. If you’re using a secondary index, it must be unique. Defaults to primary index.
on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

eval(expr, *args, on_push=None, on_push_ctx=None)¶

Execute an EVAL request: evaluate a Lua expression.

Parameters:

expr¶ (str) – Lua expression.
args¶ (tuple) – Lua expression 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:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError

execute(query, params=None)¶

Execute an SQL request: see documentation for syntax reference.

The Tarantool binary protocol for SQL requests supports “qmark” and “named” param styles. A sequence of values can be used for “qmark” style. A mapping is used for “named” param style without the leading colon in the keys.

Example for “qmark” arguments:

args = ['email@example.com']
c.execute('select * from "users" where "email"=?', args)

Example for “named” arguments:

args = {'email': 'email@example.com'}
c.execute('select * from "users" where "email"=:email', args)

Parameters:

query¶ (str) – SQL query.
params¶ (dict or list or None, optional) – SQL query bind values.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError

flush_schema()¶

Reload space and index schema.

Raise:: SchemaError, DatabaseError

insert(space_name, values, *, on_push=None, on_push_ctx=None)¶

Execute an INSERT request: insert a tuple to the space. Throws an error if there is already a tuple with the same primary key.

Parameters:

space_name¶ (str or int) – Space name or space id.
values¶ (tuple or list) – Record to be inserted.
on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

is_closed()¶

Returns True if connection is closed. False otherwise.

Return type:: bool

ping(notime=False)¶

Execute a PING request: send an empty request and receive an empty response from the server.

Parameters:: notime¶ (bool, optional) – If False, returns response time. Otherwise, it returns 'Success'.
Returns:: Response time or 'Success'.
Return type:: float or str
Raise:: AssertionError, DatabaseError, SchemaError, NetworkError, SslError

replace(space_name, values, *, on_push=None, on_push_ctx=None)¶

Execute a REPLACE request: replace a tuple in the space. Doesn’t throw an error if there is no tuple with the specified primary key.

Parameters:

space_name¶ (str or int) – Space name or space id.
values¶ (tuple or list) – Tuple to be replaced.
on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

select(space_name, key=None, *, offset=0, limit=4294967295, index=0, iterator=None, on_push=None, on_push_ctx=None)¶

Execute a SELECT request: select a tuple from the space.

Parameters:

space_name¶ (str or int) – Space name or space id.
key¶ (optional) – Key of a tuple to be selected.
offset¶ (int, optional) – Number of tuples to skip.
limit¶ (str or int, optional) – Maximum number of tuples to select.
index¶ – Index name or index id to select. Defaults to primary index.

iterator¶ –

Index iterator type.

Iterator types for TREE indexes:

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.

Iterator types for HASH indexes:

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.

Iterator types for BITSET indexes:

Type

Arguments

Description

'ALL'

none

All index keys match. Tuples are returned in their order within the space.

'EQ'

bitset value

If an index key is equal to a bitset value, it matches. Tuples are returned in their order within the space. This is the default.

'BITS_ALL_SET'

bitset value

If all of the bits which are 1 in the bitset value are 1 in the index key, it matches. Tuples are returned in their order within the space.

'BITS_ANY_SET'

bitset value

If any of the bits which are 1 in the bitset value are 1 in the index key, it matches. Tuples are returned in their order within the space.

'BITS_ALL_NOT_SET'

bitset value

If all of the bits which are 1 in the bitset value are 0 in the index key, it matches. Tuples are returned in their order within the space.

on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

space(space_name)¶

Create a Space instance for a particular space.

Parameters:: space_name¶ (str or int) – Space name or space id.
Return type:: Space
Raise:: SchemaError

update(space_name, key, op_list, *, index=0, on_push=None, on_push_ctx=None)¶

Execute an UPDATE request: update a tuple in the space.

Parameters:

space_name¶ (str or int) – Space name or space id.
key¶ – Key of a tuple to be updated.
op_list¶ (tuple or list) –
The list of operations to update individual fields. Each operation is a tuple of three (or more) values: (operator, field_identifier, value).

Possible operators are:
- '+' for addition. values must be numeric
- '-' for subtraction. values must be numeric
- '&' for bitwise AND. values must be unsigned numeric
- '|' for bitwise OR. values must be unsigned numeric
- '^' for bitwise XOR. values must be unsigned numeric
- ':' for string splice. you must provide offset, count, and value for this operation
- '!' for insertion. provide any element to insert)
- '=' for assignment. (provide any element to assign)
- '#' for deletion. provide count of fields to delete)
Possible field_identifiers are:
- Positive field number. The first field is 1, the second field is 2, and so on.
- Negative field number. The last field is -1, the second-last field is -2, and so on. In other words: (#tuple + negative field number + 1).
- Name. If the space was formatted with space_object:format(), then this can be a string for the field name (Since Tarantool 2.3.1).
Operation examples:
```
# 'ADD' 55 to the second field
# Assign 'x' to the third field
[('+', 2, 55), ('=', 3, 'x')]
# 'OR' the third field with '1'
# Cut three symbols, starting from the second,
# and replace them with '!!'
# Insert 'hello, world' field before the fifth element of the tuple
[('|', 3, 1), (':', 2, 2, 3, '!!'), ('!', 5, 'hello, world')]
# Delete two fields, starting with the second field
[('#', 2, 2)]
```
index¶ (str or int, optional) – Index name or index id. If you’re using a secondary index, it must be unique. Defaults to primary index.
on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

upsert(space_name, tuple_value, op_list, *, index=0, on_push=None, on_push_ctx=None)¶

Execute an UPSERT request: upsert a tuple to the space.

If an existing tuple matches the key fields of tuple_value, then the request has the same effect as UPDATE and the [(field_1, symbol_1, arg_1), ...] parameter is used.

If there is no tuple matching the key fields of tuple_value, then the request has the same effect as INSERT and the tuple_value parameter is used. However, unlike insert or update, upsert will neither read the tuple nor perform error checks before returning – this is a design feature which enhances throughput but requires more caution on the part of the user.

Parameters:

space_name¶ (str or int) – Space name or space id.
tuple_value¶ (tuple or list) – Tuple to be upserted.
op_list¶ (tuple or list) – Refer to update() op_list.
index¶ (str or int, optional) – Index name or index id. If you’re using a secondary index, it must be unique. Defaults to primary index.
on_push¶ (function, optional) – Сallback for processing out-of-band messages.
on_push_ctx¶ (optional) – Сontext for working with on_push callback.

Return type:

Raise:

AssertionError, DatabaseError, SchemaError, NetworkError, SslError, NotSupportedError

exception tarantool.Error

Base class for error exceptions.

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

exception tarantool.DatabaseError(*args, extra_info=None)

Exception raised for errors that are related to the database.

Parameters:

args (tuple) – (code, message) or (message,).
extra_info (BoxError or None, optional) – Additional box.error information with backtrace.

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

exception tarantool.DatabaseError(*args, extra_info=None)

Exception raised for errors that are related to the database.

Parameters:

args (tuple) – (code, message) or (message,).
extra_info (BoxError or None, optional) – Additional box.error information with backtrace.

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

exception tarantool.NetworkError(*args, **kwargs)

Error related to network.

Parameters:

args (dict, optional) – Exception arguments. If the first argument is a socket exception, it is wrapped.
kwargs – Exception to wrap.

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

exception tarantool.NetworkWarning

Warning related to network.

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

exception tarantool.SchemaError(value)

Error related to extracting space and index schema.

Parameters:: value – Error value.

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

class tarantool.BoxError(type: Union[str, bytes], file: Union[str, bytes], line: int, message: Union[str, bytes], errno: int, errcode: int, fields: Optional[dict] = None, prev: Optional[List[BoxError]] = None)¶

Type representing Tarantool box.error object: a single MP_ERROR_STACK object with a link to the previous stack error.

errcode: int¶: Number of the error as defined in errcode.h.

errno: int¶: Ordinal number of the error.

fields: Optional[dict] = None¶: Additional fields depending on error type. For example, if type is "AccessDeniedError", then it will include "object_type", "object_name", "access_type".

file: Union[str, bytes]¶

Source code file where error was caught.

Value type depends on Connection encoding.

line: int¶: Line number in source code file.

message: Union[str, bytes]¶

Text of reason.

Value type depends on Connection encoding.

prev: Optional[List[BoxError]] = None¶: Previous error in stack.

type: Union[str, bytes]¶

Type that implies source, for example "ClientError".

Value type depends on Connection encoding.

class tarantool.ConnectionPool(addrs, user=None, password=None, socket_timeout=None, reconnect_max_attempts=0, reconnect_delay=0, connect_now=True, encoding='utf-8', call_16=False, connection_timeout=None, strategy_class=<class 'tarantool.connection_pool.RoundRobinStrategy'>, refresh_delay=1, fetch_schema=True)¶

Represents the pool of connections to a cluster of Tarantool servers.

To work with ConnectionPool, box.info must be callable for the user on each server.

ConnectionPool is best suited to work with a single replicaset. Its API is the same as a single server Connection, but requests support mode parameter (a tarantool.Mode value) to choose between read-write and read-only pool instances:

>>> resp = conn.select('demo', 'AAAA', mode=tarantool.Mode.PREFER_RO)
>>> resp
- ['AAAA', 'Alpha']

Parameters:

addrs¶ (list) –

List of dictionaries describing server addresses:

{
    "host': "str" or None,     # mandatory
    "port": int or "str",      # mandatory
    "socket_fd": int,          # optional
    "transport": "str",        # optional
    "ssl_key_file": "str",     # optional
    "ssl_cert_file": "str",    # optional
    "ssl_ca_file": "str",      # optional
    "ssl_ciphers": "str"       # optional
    "ssl_password": "str",     # optional
    "ssl_password_file": "str" # optional
    "auth_type": "str"         # optional
}

Refer to corresponding Connection parameters.

user¶ – Refer to user. The value is used for each connection in the pool.
password¶ – Refer to password. The value is used for each connection in the pool.
socket_timeout¶ – Refer to socket_timeout. The value is used for each connection in the pool.
reconnect_max_attempts¶ – Refer to reconnect_max_attempts. The value is used for each connection in the pool. Be careful: it is internal Connection reconnect unrelated to pool reconnect mechanisms.
reconnect_delay¶ – Refer to reconnect_delay. The value is used for each connection in the pool. Be careful: it is internal Connection reconnect unrelated to pool reconnect mechanisms.
connect_now¶ (bool, optional) – If True, connect to all pool servers on initialization. Otherwise, you have to call connect() manually after initialization.
encoding¶ – Refer to encoding. The value is used for each connection in the pool.
call_16¶ – Refer to call_16. The value is used for each connection in the pool.
connection_timeout¶ (float, optional) – Refer to connection_timeout. The value is used for each connection in the pool.
strategy_class¶ (StrategyInterface, optional) – Strategy for choosing a server based on a request mode. Defaults to the round-robin strategy.
refresh_delay¶ – Minimal time between pool server box.info.ro status background refreshes, in seconds.
fetch_schema¶ – Refer to fetch_schema.

Raise:

ConfigurationError, Connection exceptions

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

Execute a CALL request on the pool server: call a stored Lua function. Refer to call().

Parameters:

func_name¶ – Refer to func_name.
args¶ – Refer to args.
mode¶ (Mode) – Request mode.
on_push¶ – Refer to on_push.
on_push_ctx¶ – Refer to on_push_ctx.

Return type:

Raise:

ValueError, call() exceptions

close()¶: Stop request processing, close each connection in the pool.

connect()¶

Create a connection to each address specified on initialization and start background process threads for them. There is no need to call this method explicitly until you have set connect_now=False on initialization.

If some connections have failed to connect successfully or provide box.info status (including the case when all of them have failed), no exceptions are raised. Attempts to reconnect and refresh the info would be processed in the background.

crud_count(space_name, conditions=None, opts=None, *, mode=Mode.ANY)¶

Execute an crud_count request on the pool server: gets rows count through the crud. Refer to crud_count().

Parameters:

space_name¶ – Refer to space_name.
conditions¶ – Refer to conditions.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_delete(space_name, key, opts=None, *, mode=Mode.ANY)¶

Execute an crud_delete request on the pool server: deletes row through the crud. Refer to crud_delete().

Parameters:

space_name¶ – Refer to space_name.
key¶ – Refer to key.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_get(space_name, key, opts=None, *, mode=Mode.ANY)¶

Execute an crud_get request on the pool server: gets row through the crud. Refer to crud_get().

Parameters:

space_name¶ – Refer to space_name.
key¶ – Refer to key.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_insert(space_name, values, opts=None, *, mode=Mode.ANY)¶

Execute an crud_insert request on the pool server: inserts row through the crud. Refer to crud_insert().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_insert_many(space_name, values, opts=None, *, mode=Mode.ANY)¶

Execute an crud_insert_many request on the pool server: inserts batch rows through the crud. Refer to crud_insert_many().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_insert_object(space_name, values, opts=None, *, mode=Mode.ANY)¶

Execute an crud_insert_object request on the pool server: inserts object row through the crud. Refer to crud_insert_object().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_insert_object_many(space_name, values, opts=None, *, mode=Mode.ANY)¶

Execute an crud_insert_object_many request on the pool server: inserts batch object rows through the crud. Refer to crud_insert_object_many().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_len(space_name, opts=None, *, mode=Mode.ANY)¶

Execute an crud_len request on the pool server: gets the number of tuples in the space through crud. Refer to crud_len().

Parameters:

space_name¶ – Refer to space_name.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_max(space_name, index_name, opts=None, *, mode=Mode.ANY)¶

Execute an crud_max request on the pool server: gets rows with maximum value in the specified index through crud. Refer to crud_max().

Parameters:

space_name¶ – Refer to space_name.
index_name¶ – Refer to index_name.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_min(space_name, index_name, opts=None, *, mode=Mode.ANY)¶

Execute an crud_min request on the pool server: gets rows with minimum value in the specified index through crud. Refer to crud_min().

Parameters:

space_name¶ – Refer to space_name.
index_name¶ – Refer to index_name.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_replace(space_name, values, opts=None, *, mode=Mode.ANY)¶

Execute an crud_replace request on the pool server: replaces row through the crud. Refer to crud_replace().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_replace_many(space_name, values, opts=None, *, mode=Mode.ANY)¶

Execute an crud_replace_many request on the pool server: replaces batch rows through the crud. Refer to crud_replace_many().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_replace_object(space_name, values, opts=None, *, mode=Mode.ANY)¶

Execute an crud_replace_object request on the pool server: replaces object row through the crud. Refer to crud_replace_object().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_replace_object_many(space_name, values, opts=None, *, mode=Mode.ANY)¶

Execute an crud_replace_object_many request on the pool server: replaces batch object rows through the crud. Refer to crud_replace_object_many().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_select(space_name, conditions=None, opts=None, *, mode=Mode.ANY)¶

Execute an crud_select request on the pool server: selects rows through the crud. Refer to crud_select().

Parameters:

space_name¶ – Refer to space_name.
conditions¶ – Refer to conditions.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_stats(space_name=None, *, mode=Mode.ANY)¶

Execute an crud_stats request on the pool server: gets statistics through the crud. Refer to crud_stats().

Parameters:

space_name¶ – Refer to space_name.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_storage_info(opts=None, *, mode=Mode.ANY)¶

Execute an crud_storage_info request on the pool server: gets storages status through the crud. Refer to crud_storage_info().

Parameters:

opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_truncate(space_name, opts=None, *, mode=Mode.ANY)¶

Execute an crud_truncate request on the pool server: truncates rows through crud. Refer to crud_truncate().

Parameters:

space_name¶ – Refer to space_name.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_unflatten_rows(rows, metadata, *, mode=Mode.ANY)¶

Makes rows unflatten through the crud. Refer to crud_unflatten_rows().

Parameters:

rows¶ – Refer to rows.
metadata¶ – Refer to metadata.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_update(space_name, key, operations=None, opts=None, *, mode=Mode.ANY)¶

Execute an crud_update request on the pool server: updates row through the crud. Refer to crud_update().

Parameters:

space_name¶ – Refer to space_name.
key¶ – Refer to key.
operations¶ – Refer to operations.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_upsert(space_name, values, operations=None, opts=None, *, mode=Mode.ANY)¶

Execute an crud_upsert request on the pool server: upserts row through the crud. Refer to crud_upsert().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
operations¶ – Refer to operations.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_upsert_many(space_name, values_operation, opts=None, *, mode=Mode.ANY)¶

Execute an crud_upsert_many request on the pool server: upserts batch rows through the crud. Refer to crud_upsert_many().

Parameters:

space_name¶ – Refer to space_name.
values_operation¶ – Refer to values_operation.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_upsert_object(space_name, values, operations=None, opts=None, *, mode=Mode.ANY)¶

Execute an crud_upsert_object request on the pool server: upserts object row through the crud. Refer to crud_upsert_object().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
operations¶ – Refer to operations.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

crud_upsert_object_many(space_name, values_operation, opts=None, *, mode=Mode.ANY)¶

Execute an crud_upsert_object_many request on the pool server: upserts batch object rows through the crud. Refer to crud_upsert_object_many().

Parameters:

space_name¶ – Refer to space_name.
values_operation¶ – Refer to values_operation.
opts¶ – Refer to opts.
mode¶ (Mode, optional) – Request mode.

Return type:

Raise:

delete(space_name, key, *, index=0, mode=Mode.RW, on_push=None, on_push_ctx=None)¶

Execute an DELETE request on the pool server: delete a tuple in the space. Refer to delete().

Parameters:

space_name¶ – Refer to space_name.
key¶ – Refer to key.
index¶ – Refer to index.
mode¶ (Mode, optional) – Request mode.
on_push¶ – Refer to on_push.
on_push_ctx¶ – Refer to on_push_ctx.

Return type:

Raise:

delete() exceptions

eval(expr, *args, mode=None, on_push=None, on_push_ctx=None)¶

Execute an EVAL request on the pool server: evaluate a Lua expression. Refer to eval().

Parameters:

expr¶ – Refer to expr.
args¶ – Refer to args.
mode¶ (Mode) – Request mode.
on_push¶ – Refer to on_push.
on_push_ctx¶ – Refer to on_push_ctx.

Return type:

Raise:

ValueError, eval() exceptions

execute(query, params=None, *, mode=None)¶

Execute an SQL request on the pool server. Refer to execute().

Parameters:

query¶ – Refer to query.
params¶ – Refer to params.
mode¶ (Mode) – Request mode.

Return type:

Raise:

ValueError, execute() exceptions

insert(space_name, values, *, mode=Mode.RW, on_push=None, on_push_ctx=None)¶

Execute an INSERT request on the pool server: insert a tuple to the space. Refer to insert().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
mode¶ (Mode, optional) – Request mode.
on_push¶ – Refer to on_push.
on_push_ctx¶ – Refer to on_push_ctx.

Return type:

Raise:

insert() exceptions

is_closed()¶

Returns False if at least one connection is not closed and is ready to process requests. Otherwise, returns True.

Return type:: bool

ping(notime=False, *, mode=None)¶

Execute a PING request on the pool server: send an empty request and receive an empty response from the server. Refer to ping().

Parameters:

notime¶ – Refer to notime.
mode¶ (Mode) – Request mode.

Returns:

Refer to ping().

Raise:

ValueError, ping() exceptions

replace(space_name, values, *, mode=Mode.RW, on_push=None, on_push_ctx=None)¶

Execute a REPLACE request on the pool server: replace a tuple in the space. Refer to replace().

Parameters:

space_name¶ – Refer to space_name.
values¶ – Refer to values.
mode¶ (Mode, optional) – Request mode.
on_push¶ – Refer to on_push.
on_push_ctx¶ – Refer to on_push_ctx.

Return type:

Raise:

replace() exceptions

select(space_name, key, *, offset=0, limit=4294967295, index=0, iterator=None, mode=Mode.ANY, on_push=None, on_push_ctx=None)¶

Execute a SELECT request on the pool server: update a tuple from the space. Refer to select().

Parameters:

space_name¶ – Refer to space_name.
key¶ – Refer to key.
offset¶ – Refer to offset.
limit¶ – Refer to limit.
index¶ – Refer to index.
iterator¶ – Refer to iterator.
mode¶ (Mode, optional) – Request mode.
on_push¶ – Refer to on_push.
on_push_ctx¶ – Refer to on_push_ctx.

Return type:

Raise:

select() exceptions

update(space_name, key, op_list, *, index=0, mode=Mode.RW, on_push=None, on_push_ctx=None)¶

Execute an UPDATE request on the pool server: update a tuple in the space. Refer to update().

Parameters:

space_name¶ – Refer to space_name.
key¶ – Refer to key.
op_list¶ – Refer to op_list.
index¶ – Refer to index.
mode¶ (Mode, optional) – Request mode.
on_push¶ – Refer to on_push.
on_push_ctx¶ – Refer to on_push_ctx.

Return type:

Raise:

upsert() exceptions

upsert(space_name, tuple_value, op_list, *, index=0, mode=Mode.RW, on_push=None, on_push_ctx=None)¶

Execute an UPSERT request on the pool server: upsert a tuple to the space. Refer to upsert().

Parameters:

space_name¶ – Refer to space_name.
tuple_value¶ – Refer to tuple_value.
op_list¶ – Refer to op_list.
index¶ – Refer to index.
mode¶ (Mode, optional) – Request mode.
on_push¶ – Refer to on_push.
on_push_ctx¶ – Refer to on_push_ctx.

Return type: