asynctnt.connection

Module Contents

Classes

ConnectionState	Enum where members are also (and must be) ints
Connection

Functions

connect(→ Connection)

connect shorthand. See asynctnt.Connection for kwargs details

class asynctnt.connection.ConnectionState

Bases: enum.IntEnum

Enum where members are also (and must be) ints

CONNECTING = 1

CONNECTED = 2

RECONNECTING = 3

DISCONNECTING = 4

DISCONNECTED = 5

class asynctnt.connection.Connection(*, host: str = '127.0.0.1', port: int | str = 3301, username: str | None = None, password: str | None = None, fetch_schema: bool = True, auto_refetch_schema: bool = True, connect_timeout: float = 3.0, request_timeout: float = -1.0, reconnect_timeout: float = 1.0 / 3.0, ping_timeout: float = 5.0, encoding: str | None = None, initial_read_buffer_size: int | None = None)

Bases: asynctnt.api.Api

property fingerprint: str

property host: str

Tarantool host

property port: int

Tarantool port

property username: str | None

Tarantool username

property password: str | None

Tarantool password

property fetch_schema: bool

fetch_schema flag

property auto_refetch_schema: bool

auto_refetch_schema flag

property encoding: str

Connection encoding

property reconnect_timeout: float

Reconnect timeout value

property connect_timeout: float

Connect timeout value

property request_timeout: float

Request timeout value

property version: tuple | None

Protocol version tuple. ex.: (1, 6, 7)

property state: ConnectionState

Current connection state

Return type:

ConnectionState

property is_connected: bool

Check if an underlying connection is active

property is_fully_connected: bool

Check if connection is fully active (performed auth and schema fetching)

property schema_id: int | None

Tarantool’s current schema id

property schema: asynctnt.iproto.protocol.Schema | None

Current Tarantool schema with all spaces, indexes and fields

property initial_read_buffer_size: int

initial_read_buffer_size value

property features: asynctnt.iproto.protocol.IProtoFeatures

Lookup available Tarantool features - https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_iproto/feature/ :return:

__slots__ = ('_host', '_port', '_username', '_password', '_fetch_schema', '_auto_refetch_schema',...

_set_state(new_state: ConnectionState)

connection_lost(exc)

async _ping_task_func()

_start_reconnect(return_exceptions: bool = False)

protocol_factory(connected_fut: asyncio.Future, loop: asyncio.AbstractEventLoop, cls: Type[asynctnt.iproto.protocol.Protocol] = protocol.Protocol)

async _connect(return_exceptions: bool = True)

async _wait_reconnect(exc: Exception | None = None)

async connect() → Connection

Connect coroutine

async disconnect()

Disconnect coroutine

close()

Same as disconnect, but not a coroutine, i.e. it does not wait for disconnect to finish.

async reconnect()

Reconnect coroutine. Just calls disconnect() and connect()

async __aenter__() → Connection

Executed on entering the async with section. Connects to Tarantool instance.

async __aexit__(exc_type, exc_val, exc_tb)

Executed on leaving the async with section. Disconnects from Tarantool instance.

async refetch_schema()

Coroutine to force refetch schema

_normalize_api()

__repr__()

Return repr(self).

stream() → asynctnt.stream.Stream

Create new stream suitable for interactive transactions

async asynctnt.connection.connect(**kwargs) → Connection

connect shorthand. See asynctnt.Connection for kwargs details

Returns:

asynctnt.Connection object