[do] SQL docs

Author: jamesgpearce

site/guides/01_the_basics/9_architectural_options.md

@@ -164,7 +164,10 @@ A reliable all-in-one solution is to run both synchronization and storage on
 Cloudflare. Check out the Cloudflare Durable Objects guide and the dedicated
 [Vite starter
 template](https://github.com/tinyplex/vite-tinybase-ts-react-sync-durable-object)
-to see how to set this up.
+to see how to set this up. This approach can use either the
+DurableObjectStoragePersister (for KV-based storage) or the
+DurableObjectSqlStoragePersister (for SQLite-based storage) to persist data in a
+Durable Object.
 
 ## 6. Third-Party Synchronization
 

site/guides/04_persistence/1_an_intro_to_persistence.md

@@ -54,6 +54,19 @@ is available.
 
 See the Database Persistence guide for details on how to work with databases.
 
+### Durable Object Persisters
+
+These Persisters are designed to work with Durable Objects, which are a
+specialized type of server-side storage provided by CloudFlare. In conjunction
+with a WsServerDurableObject, they allow you to synchronize clients and then
+also persist data in a Durable Object, either in its key-value, or SQlite
+storage form.
+
+| Persister                        | Storage                                     |
+| -------------------------------- | ------------------------------------------- |
+| DurableObjectStoragePersister    | Cloudflare Durable Object key-value storage |
+| DurableObjectSqlStoragePersister | Cloudflare Durable Object SQLite storage    |
+
 ### Third-Party CRDT & Socket Persisters
 
 These Persisters can bind your Store into third-party CRDT frameworks, or

site/guides/15_releases.md

@@ -5,6 +5,55 @@ highlighted features.
 
 ---
 
+# v6.3
+
+This release includes the new persister-durable-object-sql-storage module, which
+allows you to persist data in a Cloudflare Durable Object's SQLite-based storage
+in conjunction with websocket-based synchronization (using the
+WsServerDurableObject class).
+
+```js yolo
+import {createMergeableStore} from 'tinybase';
+import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
+import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
+
+const config = {
+  mode: 'fragmented',
+  storagePrefix: 'my_app_',
+};
+
+export class MyDurableObject extends WsServerDurableObject {
+  createPersister() {
+    const store = createMergeableStore();
+    const persister = createDurableObjectSqlStoragePersister(
+      store,
+      this.ctx.storage.sql,
+      config,
+    );
+    return persister;
+  }
+}
+```
+
+Prior to this release, the only way to persist data in a Durable Object was to
+use the persister-durable-object-storage module, which uses CloudFlare's
+key-value storage backend behind the scenes.
+
+However, Cloudflare's SQLite storage backend for Durable Objects offers
+significantly better pricing compared to the key-value storage backend. The
+SQLite storage backend is Cloudflare's recommended storage option for new
+Durable Object namespaces.
+
+Note that, before using this persister, you must configure your Durable Object
+class to use SQLite storage by adding a migration to your `wrangler.toml` or
+`wrangler.json` configuration file. Use `new_sqlite_classes` in your migration
+configuration to enable SQLite storage for your Durable Object class. See the
+module documentation for more information.
+
+This release also addresses a local-storage persistence issue, #[257](https://github.com/tinyplex/tinybase/issues/257).
+
+---
+
 # v6.2
 
 This release contains various packaging improvements and exposes some internal
@@ -60,6 +109,8 @@ generated in TinyBase MergeableStore objects.
 The rarely-used GetNow and Hash types have been moved from the mergeable-store
 module into the common module.
 
+---
+
 # v6.1
 
 ## In Summary
@@ -188,6 +239,8 @@ base Persister interface have been marked asynchronous and return Promises. The
 stopSync method in the Synchronizer interface and the destroy method in the
 Synchronizer server interfaces should also be considered asynchronous.
 
+---
+
 # v6.0
 
 This major release is about updating dependencies and infrastructure rather than
@@ -225,6 +278,8 @@ to upgrade as soon as you can.
 Please let us know how these changes find you, and please file an issue on
 GitHub if you need help adapting to any of them.
 
+---
+
 # v5.4
 
 ## Durable Objects synchronization

src/@types/persisters/docs.js

@@ -7,8 +7,8 @@
  * Many entry points are provided (in separately installed modules), each of
  * which returns different types of Persister that can load and save a Store.
  * Between them, these allow you to store your TinyBase data locally, remotely,
- * to SQLite and PostgreSQL databases, and across synchronization boundaries
- * with CRDT frameworks.
+ * to a Durable Object, to SQLite and PostgreSQL databases, and across
+ * synchronization boundaries with CRDT frameworks.
  *
  * |Persister|Storage|Store|MergeableStore
  * |-|-|-|-|
@@ -17,6 +17,8 @@
  * |FilePersister|Local file (where possible)|Yes|Yes
  * |IndexedDbPersister|Browser IndexedDB|Yes|No
  * |RemotePersister|Remote server|Yes|No
+ * |DurableObjectStoragePersister|Cloudflare Durable Object (KV)|No|Yes
+ * |DurableObjectSqlStoragePersister|Cloudflare Durable Object (SQLite)|No|Yes
  * |Sqlite3Persister|SQLite in Node, via [sqlite3](https://github.com/TryGhost/node-sqlite3)|Yes|Yes*
  * |SqliteBunPersister| SQLite in Bun, via [bun:sqlite](https://bun.sh/docs/api/sqlite)|Yes|Yes*
  * |SqliteWasmPersister|SQLite in a browser, via [sqlite-wasm](https://github.com/tomayac/sqlite-wasm)|Yes|Yes*