docs(sdk): add PostgreSQL-backed persistence guide and API reference#465
Open
StatPan wants to merge 1 commit intoOpenHands:mainfrom
Open
docs(sdk): add PostgreSQL-backed persistence guide and API reference#465StatPan wants to merge 1 commit intoOpenHands:mainfrom
StatPan wants to merge 1 commit intoOpenHands:mainfrom
Conversation
Document PostgreSQLFileStore usage for environments where the local filesystem is not persistent (Cloud Run, serverless, containers without mounted volumes). Covers installation, usage with LocalConversation, schema, locking behaviour, and the file_store / persistence_dir mutually-exclusive semantics. Co-authored-by: openhands <openhands@all-hands.dev>
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
2 participants
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
PostgreSQLFileStorein the SDK persistence guide (sdk/guides/convo-persistence.mdx): installation (pip install "openhands-sdk[postgresql]"), usage example withLocalConversation, table schema, locking note, and thefile_store/persistence_dirmutual exclusion semanticsfile_storeparameter to theLocalConversation.__init__()API reference (sdk/api-reference/openhands.sdk.conversation.mdx)Related SDK PR
OpenHands/software-agent-sdk#2902 — adds
PostgreSQLFileStore(openhands/sdk/io/postgresql.py), thepostgresqloptional dependency, and thefile_storeparameter toLocalConversation.__init__()/ConversationState.create()Test plan
file_storeparameter appears in theLocalConversation.__init__()API referenceTipcallout render as expected🤖 Generated with Claude Code