Storages

Storages out of the box

MemoryStorage

class aiogram.fsm.storage.memory.MemoryStorage

Default FSM storage, stores all data in dict and loss everything on shutdown

Warning

Is not recommended using in production in due to you will lose all data when your bot restarts

__init__() → None

RedisStorage

class aiogram.fsm.storage.redis.RedisStorage(redis: ~redis.asyncio.client.Redis, key_builder: ~typing.Optional[~aiogram.fsm.storage.redis.KeyBuilder] = None, state_ttl: ~typing.Optional[~typing.Union[int, ~datetime.timedelta]] = None, data_ttl: ~typing.Optional[~typing.Union[int, ~datetime.timedelta]] = None, json_loads: ~typing.Callable[[...], ~typing.Any] = <function loads>, json_dumps: ~typing.Callable[[...], str] = <function dumps>)

Redis storage required redis package installed (pip install redis)

__init__(redis: ~redis.asyncio.client.Redis, key_builder: ~typing.Optional[~aiogram.fsm.storage.redis.KeyBuilder] = None, state_ttl: ~typing.Optional[~typing.Union[int, ~datetime.timedelta]] = None, data_ttl: ~typing.Optional[~typing.Union[int, ~datetime.timedelta]] = None, json_loads: ~typing.Callable[[...], ~typing.Any] = <function loads>, json_dumps: ~typing.Callable[[...], str] = <function dumps>) → None

Parameters:

• redis – Instance of Redis connection

• key_builder – builder that helps to convert contextual key to string

• state_ttl – TTL for state records

• data_ttl – TTL for data records

classmethod from_url(url: str, connection_kwargs: Optional[Dict[str, Any]] = None, **kwargs: Any) → RedisStorage

Create an instance of RedisStorage with specifying the connection string

Parameters:

• url – for example redis://user:password@host:port/db

• connection_kwargs – see redis docs

• kwargs – arguments to be passed to RedisStorage

Returns:

an instance of RedisStorage

Keys inside storage can be customized via key builders:

class aiogram.fsm.storage.redis.KeyBuilder

Base class for Redis key builder

abstract build(key: StorageKey, part: Literal['data', 'state', 'lock']) → str

This method should be implemented in subclasses

Parameters:

• key – contextual key

• part – part of the record

Returns:

key to be used in Redis queries

class aiogram.fsm.storage.redis.DefaultKeyBuilder(*, prefix: str = 'fsm', separator: str = ':', with_bot_id: bool = False, with_destiny: bool = False)

Simple Redis key builder with default prefix.

Generates a colon-joined string with prefix, chat_id, user_id, optional bot_id and optional destiny.

build(key: StorageKey, part: Literal['data', 'state', 'lock']) → str

This method should be implemented in subclasses

Parameters:

• key – contextual key

• part – part of the record

Returns:

key to be used in Redis queries

Writing own storages

class aiogram.fsm.storage.base.BaseStorage

Base class for all FSM storages

abstract async set_state(key: StorageKey, state: Optional[Union[str, State]] = None) → None

Set state for specified key

Parameters:

• key – storage key

• state – new state

abstract async get_state(key: StorageKey) → Optional[str]

Get key state

Parameters:

key – storage key

Returns:

current state

abstract async set_data(key: StorageKey, data: Dict[str, Any]) → None

Write data (replace)

Parameters:

• key – storage key

• data – new data

abstract async get_data(key: StorageKey) → Dict[str, Any]

Get current data for key

Parameters:

key – storage key

Returns:

current data

async update_data(key: StorageKey, data: Dict[str, Any]) → Dict[str, Any]

Update date in the storage for key (like dict.update)

Parameters:

• key – storage key

• data – partial data

Returns:

new data

abstract async close() → None

Close storage (database connection, file or etc.)