Skip to content

Conversation

@rahul-langchain
Copy link
Contributor

Overview

We currently say you have to call setup for a saver or store but don't specify what that does or best practices for when to call it.

Type of change

Type: Update existing documentation

Checklist

  • I have read the contributing guidelines
  • I have tested my changes locally using docs dev
  • I have used root relative paths for internal links

@github-actions github-actions bot added langgraph For docs changes to LangGraph oss labels Dec 5, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 5, 2025

Mintlify preview ID generated: preview-rahuld-1764974092-c1936da

<Info>
**LangGraph API handles checkpointing automatically**
When using the LangGraph API, you don't need to implement or configure checkpointers manually. The API handles all persistence infrastructure for you behind the scenes.
**Agent Server handles checkpointing automatically**
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated but noticed while I was doing this so I decided to fix as well!


## Database management

If you are using Postgres or Redis to store short and/or long-term memory, you will need to call the LangGraph-provided `saver` or `store`'s `setup` method before you can use it with your database.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This applies to any checkpointer or store really - any DB-backed persistence implementation would have migrations.

The convention is to define a setup() method to run the required migrations for that instance, but the user should check with their specific implementation of the BaseCheckpointSaver or BaseStore to confirm.

We'd recommend running migration as a dedicated deployment step. Or you can ensure they're run as a part of server startup.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 8, 2025

Mintlify preview ID generated: preview-rahuld-1765213882-08c5736

@github-actions
Copy link
Contributor

github-actions bot commented Dec 8, 2025

Mintlify preview ID generated: preview-rahuld-1765221422-431da96

@lnhsingh lnhsingh merged commit cd5ffd2 into main Dec 8, 2025
14 checks passed
@lnhsingh lnhsingh deleted the rahul/document-saver-setup branch December 8, 2025 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

langgraph For docs changes to LangGraph oss

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants