crewai-persistence-sql

SQL persistence backend for CrewAI Flows via SQLAlchemy — one provider for SQLite, PostgreSQL, MySQL, and more, selected by connection URL. Optional built-in message pruning via agentstate-reducer. Implements CrewAI's FlowPersistence interface.

Installation

pip install crewai-persistence-sql               # SQLite built-in
pip install "crewai-persistence-sql[postgres]"   # + psycopg
pip install "crewai-persistence-sql[mysql]"      # + pymysql
pip install "crewai-persistence-sql[reducer]"    # + message pruning

Requires Python 3.10–3.13.

Usage

from crewai.flow.flow import Flow, start
from crewai.flow.persistence import persist
from crewai_persistence_sql import SQLFlowPersistence

backend = SQLFlowPersistence(url="sqlite:///crewai_flows.db")
# or  "postgresql+psycopg://user:pass@host/db"  /  "mysql+pymysql://user:pass@host/db"

@persist(backend)
class MyFlow(Flow[MyState]):
    @start()
    def begin(self):
        self.state.counter += 1

With message pruning:

from agentstate_reducer import MessageReducer
backend = SQLFlowPersistence(
    url="sqlite:///crewai_flows.db",
    reducer=MessageReducer(min_messages=10, max_messages=20),
    messages_key="messages",
)

API

SQLFlowPersistence(url=None, *, table_name="crewai_flow_states", engine=None, reducer=None, messages_key="messages")

Data model

One row per flow: flow_uuid (primary key) + data (the flow state as a JSON string). Each save upserts (portable update-then-insert), so load_state returns the latest.

License

MIT