patx/pickledb
Update documentation for SQLite backend details
Commit b6588e7 · patx · 2025-12-21T14:25:52-05:00
Update documentation for SQLite backend details Clarified that the SQLite backend does not use in-memory caching and that all operations are executed directly against the database.
Comments
No comments yet.
Diff
diff --git a/docs/index.html b/docs/index.html
index bc15ec7..d4da365 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -906,6 +906,7 @@ asyncio.run(main())</code></pre>
use <code>PickleDBSQLite</code> (SQLite handles locking and ACID transactions). For networked or multi-host workloads,
consider <a href="https://github.com/patx/mongokv">mongoKV</a>.
</li>
+ <li><strong>The optional SQLite backend is not in-memory:</strong> <code>PickleDBSQLite</code> does <em>not</em> load data into RAM. Every operation executes directly against SQLite.</li>
</ul>
</div>
</section>
@@ -1087,7 +1088,7 @@ asyncio.run(main())</code></pre>
class PickleDBSQLite(sqlite_path: str = "pickledb.sqlite3", table_name: str = "kv")
</div>
<div class="api-class-note">
- Optional SQLite-backed key-value store using the same sync/async method names.
+ Optional SQLite-backed key-value store using the same sync/async method names. <strong>No in-memory cache</strong>; all operations hit the database directly.
</div>
</div>