Skip to content

Commit

Permalink
chore (docs): document disableForeignKeysDownstream flag (#1330)
Browse files Browse the repository at this point in the history
This PR documents the new `disableForeignKeysDownstream` flag from
f4f020d.
  • Loading branch information
kevin-dp authored Jun 10, 2024
1 parent f322afc commit 2d92874
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/api/clients/typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,11 @@ const config: ElectricConfig = {
Configuration of the backoff strategy used when trying to reconnect to the Electric sync service after a failed
connection attempt.

- `disableForeignKeysDownstream?: boolean`

Can be set to true to disable FK checks when applying downstream (i.e. incoming) transactions to the local SQLite database.
When using a Postgres driver foreign keys are always disabled and this behavior can't be changed.

### Configuring example apps

In our example apps and in apps created with `npx create-electric-app`, the `url` and `debug` options are looked up as
Expand Down

0 comments on commit 2d92874

Please sign in to comment.