Skip to content

Commit 944112b

Browse files
committed
[do] SQL module
r
1 parent 41f8b8d commit 944112b

File tree

5 files changed

+29
-21
lines changed

5 files changed

+29
-21
lines changed

site/build.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,9 @@ const addApi = (docs: Docs): Docs =>
231231
.addApiFile(
232232
'dist/@types/persisters/persister-durable-object-storage/index.d.ts',
233233
)
234+
.addApiFile(
235+
'dist/@types/persisters/persister-durable-object-sql-storage/index.d.ts',
236+
)
234237
.addApiFile('dist/@types/persisters/persister-electric-sql/index.d.ts')
235238
.addApiFile('dist/@types/persisters/persister-expo-sqlite/index.d.ts')
236239
.addApiFile('dist/@types/persisters/persister-file/index.d.ts')

site/guides/06_integrations/1_cloudflare_durable_objects.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,11 @@ new_sqlite_classes = ["TinyBaseDurableObject"]
193193
Then create the persister using the recommended SQL storage. The
194194
`createDurableObjectSqlStoragePersister` supports several persistence modes:
195195
196-
**JSON Mode (Default)**: Stores the entire Store as JSON in a single database
197-
row. This is efficient for smaller stores and uses fewer database writes, but
198-
may hit Cloudflare's 2MB row limit for very large stores.
196+
#### JSON Mode (Default)
197+
198+
Stores the entire Store as JSON in a single database row. This is efficient for
199+
smaller stores and uses fewer database writes, but may hit Cloudflare's 2MB row
200+
limit for very large stores.
199201
200202
```js yolo
201203
// ...
@@ -208,10 +210,12 @@ createPersister() {
208210
// ...
209211
```
210212
211-
**Fragmented Mode**: Stores each table, row, cell, and value as separate database
212-
rows. Use this mode if you're concerned about hitting Cloudflare's 2MB row
213-
limit with large stores in JSON mode. This mode creates more database writes
214-
but avoids row size limitations:
213+
#### Fragmented Mode
214+
215+
Stores each table, row, cell, and value as separate database rows. Use this mode
216+
if you're concerned about hitting Cloudflare's 2MB row limit with large stores
217+
in JSON mode. This mode creates more database writes but avoids row size
218+
limitations:
215219
216220
```js yolo
217221
// ...
@@ -226,10 +230,10 @@ createPersister() {
226230
```
227231
228232
The `createDurableObjectSqlStoragePersister` function supports several optional
229-
parameters for more advanced use cases:
233+
parameters for more advanced use cases.
230234
231-
- **Custom table name**: You can specify a custom table name for JSON
232-
serialization mode:
235+
If you need a custom table name, you can specify a custom table name for the
236+
JSON serialization mode:
233237
234238
```js yolo
235239
// ...
@@ -243,8 +247,7 @@ createPersister() {
243247
// ...
244248
```
245249
246-
- **Fragmented mode with custom prefix**: You can use fragmented mode with a
247-
custom storage prefix:
250+
You can use fragmented mode with a custom storage prefix:
248251
249252
```js yolo
250253
// ...
@@ -258,8 +261,8 @@ createPersister() {
258261
// ...
259262
```
260263
261-
- **Debugging and logging**: You can add SQL command logging and error handling
262-
for development:
264+
And for debugging and logging, you can add SQL command logging and error
265+
handling. This is useful for development:
263266
264267
```js yolo
265268
// ...

src/@types/omni/index.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ export * from '../persisters/index.d.ts';
1212
export * from '../persisters/persister-automerge/index.d.ts';
1313
export * from '../persisters/persister-browser/index.d.ts';
1414
export * from '../persisters/persister-cr-sqlite-wasm/index.d.ts';
15+
export * from '../persisters/persister-durable-object-sql-storage/index.d.ts';
1516
export * from '../persisters/persister-durable-object-storage/index.d.ts';
1617
export * from '../persisters/persister-electric-sql/index.d.ts';
1718
export * from '../persisters/persister-expo-sqlite/index.d.ts';

src/@types/omni/with-schemas/index.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ export * from '../../metrics/with-schemas/index.d.ts';
1111
export * from '../../persisters/persister-automerge/with-schemas/index.d.ts';
1212
export * from '../../persisters/persister-browser/with-schemas/index.d.ts';
1313
export * from '../../persisters/persister-cr-sqlite-wasm/with-schemas/index.d.ts';
14+
export * from '../../persisters/persister-durable-object-sql-storage/with-schemas/index.d.ts';
1415
export * from '../../persisters/persister-durable-object-storage/with-schemas/index.d.ts';
1516
export * from '../../persisters/persister-electric-sql/with-schemas/index.d.ts';
1617
export * from '../../persisters/persister-expo-sqlite/with-schemas/index.d.ts';

src/@types/persisters/persister-durable-object-sql-storage/docs.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -216,14 +216,14 @@
216216
* mode that stores each piece of data separately to avoid Cloudflare's 2MB row
217217
* limit.
218218
*
219-
* **JSON Mode (Default)**: Stores the entire Store as JSON in a single database
220-
* row. This is efficient for smaller stores but may hit Cloudflare's 2MB row
221-
* limit for very large stores and uses fewer database writes.
219+
* - **JSON Mode (Default)**: Stores the entire Store as JSON in a single
220+
* database row. This is efficient for smaller stores but may hit Cloudflare's
221+
* 2MB row limit for very large stores and uses fewer database writes.
222222
*
223-
* **Fragmented Mode**: Stores each table, row, cell, and value as separate
224-
* database rows. Use this mode if you're concerned about hitting Cloudflare's
225-
* 2MB row limit with large stores in JSON mode. This mode creates more database
226-
* writes but avoids row size limitations.
223+
* - **Fragmented Mode**: Stores each table, row, cell, and value as separate
224+
* database rows. Use this mode if you're concerned about hitting Cloudflare's
225+
* 2MB row limit with large stores in JSON mode. This mode creates more
226+
* database writes but avoids row size limitations.
227227
*
228228
* The third argument is a DatabasePersisterConfig object that configures which
229229
* of those modes to use, and settings for each. If the third argument is simply

0 commit comments

Comments
 (0)