docs(flows): document where @persist stores its SQLite database#5718
Open
Beandon13 wants to merge 1 commit intocrewAIInc:mainfrom
Open
docs(flows): document where @persist stores its SQLite database#5718Beandon13 wants to merge 1 commit intocrewAIInc:mainfrom
Beandon13 wants to merge 1 commit intocrewAIInc:mainfrom
Conversation
Issue crewAIInc#5372 reports that the Flow Persistence guide describes @persist saving state to SQLite but never says *where* on disk that file lives. This adds a "Where Is the State Stored?" subsection under Flow Persistence that: - Names the default file (flow_states.db) and explains it's in CrewAI's user-data dir resolved via appdirs.user_data_dir. - Tabulates the per-platform default paths (macOS / Linux / Windows), matching how appdirs ignores appauthor on POSIX but uses it on Windows. - Calls out that the project component is `cwd`'s basename by default and shows how to pin it with CREWAI_STORAGE_DIR. - Shows the runtime introspection helper (`db_storage_path()`). - Documents how to override the path entirely with `SQLiteFlowPersistence(db_path=...)`. Closes crewAIInc#5372
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@persistactually saves state. The Flow Persistence section inconcepts/flows.mdxmentions SQLite but never names the file or its path.flow_states.db) and explains it's resolved throughappdirs.user_data_dir.appdirs1.4 ignoresappauthoron POSIX but uses it on Windows — verified locally).cwd's basename by default and how to pin it withCREWAI_STORAGE_DIR.crewai.utilities.paths.db_storage_path().SQLiteFlowPersistence(db_path=...).Closes #5372
Testing
appdirs.user_data_dirandcrewai.utilities.paths.db_storage_path():