Skip to content

Session Persistence¤

amqtt.contrib.persistence.SessionDBPlugin

Plugin to store session information and retained topic messages in the event that the broker terminates abnormally.

Config dataclass ¤

Configuration variables.

clear_on_shutdown class-attribute instance-attribute ¤
clear_on_shutdown: bool = True

if the broker shutdowns down normally, clear retained persistence data.

connection class-attribute instance-attribute ¤
connection: str | None = None

SQLAlchemy connection string for the asyncio version of the database connector:

  • mysql+aiomysql://user:password@host:port/dbname
  • postgresql+asyncpg://user:password@host:port/dbname
  • sqlite+aiosqlite:///amqtt.db # default
file class-attribute instance-attribute ¤
file: str | Path | None = None

path & filename to store the sqlite session db Deprecated: use connection instead. Existing configurations will continue to work.