This is unreleased documentation for Rasa Open Source Documentation Main/Unreleased version.
For the latest released documentation, see the latest version (3.x).

Version: Main/Unreleased


SQLEventBroker Objects

class SQLEventBroker(EventBroker)

Save events into an SQL database.

All events will be stored in a table called events.

SQLBrokerEvent Objects

class SQLBrokerEvent(Base)

ORM which represents a row in the events table.


| __init__(dialect: Text = "sqlite", host: Optional[Text] = None, port: Optional[int] = None, db: Text = "events.db", username: Optional[Text] = None, password: Optional[Text] = None) -> None

Initializes SQLBrokerEvent.


| @classmethod
| async from_endpoint_config(cls, broker_config: EndpointConfig, event_loop: Optional[AbstractEventLoop] = None) -> "SQLEventBroker"

Creates broker. See the parent class for more information.


| @contextlib.contextmanager
| session_scope() -> Generator[Session, None, None]

Provide a transactional scope around a series of operations.


| publish(event: Dict[Text, Any]) -> None

Publishes a json-formatted Rasa Core event into an event queue.