Skip to content

Commit a0c4c03

Browse files
committed
docs(driver-turso): the README lists the forced mode local beside syncUrl refusal as the fourth sync setting the constructor refuses
Claude-Session: https://claude.ai/code/session_01DEvba2nBuD4tWzfq8r8NFY Co-authored-by: Claude <noreply@anthropic.com>
1 parent cfe05ec commit a0c4c03

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

‎packages/drivers/driver-turso/README.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ no embedded replica for a remote url anyway. For a remote database, drop
223223
no local engine, so its url is not judged here: `@libsql/client` refuses a
224224
url it cannot open when the driver connects.
225225

226-
The constructor also refuses (`VALIDATION_ERROR` / 400) three sync settings
226+
The constructor also refuses (`VALIDATION_ERROR` / 400) four sync settings
227227
that nothing would honour, each with the message `@objectstack/spec`'s
228228
`TursoConfigSchema` gives at authoring:
229229

@@ -233,7 +233,11 @@ that nothing would honour, each with the message `@objectstack/spec`'s
233233
it. Set `syncUrl`, or remove `sync`;
234234
- a forced `mode: 'replica'` with no `syncUrl` (or an empty one), which would
235235
never sync and would run as a plain local database. Name the remote in
236-
`syncUrl` beside the `file:` url, or drop `mode` for a local database.
236+
`syncUrl` beside the `file:` url, or drop `mode` for a local database;
237+
- a forced `mode: 'local'` beside a non-empty `syncUrl`, which would still be
238+
synced with that remote as an embedded replica, so the declared local mode
239+
would be ignored. Drop `mode` for an embedded replica, or drop `syncUrl` (and
240+
`sync`) for a plain local database.
237241

238242
You can also force a specific mode:
239243

0 commit comments

Comments
 (0)