Skip to content

docs: document memory backend fallback behavior#822

Merged
MervinPraison merged 1 commit into
mainfrom
claude/issue-820-20260623-1201
Jun 23, 2026
Merged

docs: document memory backend fallback behavior#822
MervinPraison merged 1 commit into
mainfrom
claude/issue-820-20260623-1201

Conversation

@MervinPraison

@MervinPraison MervinPraison commented Jun 23, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a new Backend Fallback section to docs/features/advanced-memory.mdx between "Configuration Options" and "Quality Scoring System"
  • Documents the automatic SQLite fallback when a configured backend (Redis, Valkey, Postgres) is unavailable
  • Includes a Mermaid diagram, behavior table, runnable code example, <Note> callout about PR #2190, and a troubleshooting <AccordionGroup>
  • Does NOT touch docs/concepts/ (HUMAN-ONLY per AGENTS.md rule 1.8)

Fixes #820

Upstream fix: MervinPraison/PraisonAI#2190

Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added documentation for automatic memory backend fallback behavior, including examples and troubleshooting guidance for scenarios when primary backends (Redis/Valkey/Postgres) are unavailable.

Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request adds a new 'Backend Fallback' section to the advanced memory documentation, detailing how PraisonAI automatically falls back to SQLite when configured backends like Redis, Valkey, or Postgres are unavailable. It includes a Python code example, a Mermaid architecture diagram, a fallback behavior table, and troubleshooting steps for a legacy schema error. The review feedback suggests updating the MongoDB row in the fallback table to specify that it raises an ImportError for consistency with the Mem0 row.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

| `sqlite` | n/a (native) | `memory_adapter.*` (direct) |
| `file` | n/a (native) | FileMemory (direct) |
| `mem0` | raises `ImportError` | direct Mem0 client |
| `mongodb` | raises error | direct Mongo client |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

For consistency with the mem0 row, specify that mongodb also raises an ImportError when its dependencies are missing and it is unavailable.

Suggested change:

| `mongodb` | raises `ImportError` | direct Mongo client |

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bbc4f0a8-3862-4b30-a0f8-120de6fae7eb

📥 Commits

Reviewing files that changed from the base of the PR and between e201d44 and 3d75966.

📒 Files selected for processing (1)
  • docs/features/advanced-memory.mdx

📝 Walkthrough

Walkthrough

A new "Backend Fallback" section is added to docs/features/advanced-memory.mdx. It documents the automatic SQLite fallback when a configured backend is unavailable, includes a runnable Agent+MemoryConfig example, a Mermaid flowchart, a provider-to-fallback mapping table, and a troubleshooting accordion for the historical no such table: short_mem error.

Changes

Backend Fallback documentation

Layer / File(s) Summary
Backend Fallback section
docs/features/advanced-memory.mdx
Adds the complete "Backend Fallback" block (lines 320–376): intro text, Agent+MemoryConfig(backend="redis") example, Mermaid flowchart of the fallback/search/store flow through SqliteMemoryAdapter, backend mapping table, and a Symptom/Cause/Fix accordion documenting the historical sqlite3.OperationalError: no such table: short_mem issue and its resolution via PR #2190.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 A rabbit once searched for its carrot in Redis,
But Redis was gone — oh, what a crisis!
SQLite stepped in with a hop and a bound,
New tables were set, the carrot was found!
No more short_mem errors to dread,
Just warm fuzzy docs and fresh carrots instead. 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: document memory backend fallback behavior' clearly and concisely summarizes the main change—adding documentation for backend fallback behavior to the advanced-memory documentation file.
Linked Issues check ✅ Passed The PR fulfills all coding requirements from issue #820: adds Backend Fallback section with one-sentence intro, Mermaid diagram with correct color scheme, behavior table, runnable Python code example, Note callout referencing PR #2190, and troubleshooting accordion for the schema mismatch error.
Out of Scope Changes check ✅ Passed All changes are within scope: only +58 lines added to docs/features/advanced-memory.mdx documenting backend fallback behavior, with no modifications to docs/concepts/ (HUMAN-ONLY per AGENTS.md) or unrelated files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/issue-820-20260623-1201

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
praisonai 🟢 Ready View Preview Jun 23, 2026, 12:16 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@MervinPraison MervinPraison merged commit 47f0594 into main Jun 23, 2026
18 checks passed
@MervinPraison MervinPraison deleted the claude/issue-820-20260623-1201 branch June 23, 2026 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document memory backend fallback behavior (PR #2190 in PraisonAI)

1 participant