docs: switch config examples to use direct writes mode. #1358
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
msfstef
approved these changes
Jun 13, 2024
There was a problem hiding this comment.
Looks good! There's a few more mentions that might be worth changing:
- In
architecture.mdunder Streaming into Electric the logical replication is mentioned as the way this happens, we probably want to switch that or at least mention direct writes as the primary method - In
running.mdunderdocs/examples/noteswe describe the logical publisher host as the method for connecting electric to postgres
docs/usage/installation/service.md
Outdated
| @@ -14,12 +14,12 @@ You can run the [pre-packaged Docker images](#images) published on Docker Hub, o | |||
| The Electric sync service is configured using environment variables. The three required variables are: | |||
|
|
|||
| - `DATABASE_URL` in the format of a Postgres [Connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS) | |||
| - `LOGICAL_PUBLISHER_HOST` that the sync service is running on (must be accessible from the Postgres instance to establish an inbound replication subscription) | |||
| - either `LOGICAL_PUBLISHER_HOST` that the sync service is running on (must be accessible from the Postgres instance to establish an inbound replication subscription) or set `ELECTRIC_WRITE_TO_PG_MODE=direct_writes` | |||
There was a problem hiding this comment.
nit: maybe reverse order if we want to emphasize direct writes
|
FYI we're planning to remove the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Recommending setting a
LOGICAL_PUBLISHER_HOSTcomplicates the examples compared with just settingELECTRIC_WRITE_TO_PG_MODE=direct_writesbecause this way you don't need to worry about having your docker electric addressable from Postgres.