Add docs for enabled reads on main #1271
Open
Conversation
This file contains hidden or 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
as51340
added
status: ready
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
antejavor
approved these changes
May 19, 2025
Comment on lines
+78
to
+82
| from which instance can the data be read, to which instance data can be written to and which instances behave as routers. In the Memgraph HA cluster, the MAIN | ||
| data instance is the only writeable instance, REPLICAs are readable instances, and COORDINATORs behave as routers. However, the cluster can be configured in such a way so | ||
| that MAIN can also be used for reading. Check this [paragraph](#setting-config-for-highly-available-cluster) for more info. | ||
| Bolt+routing is the client-side routing protocol which means that the resolution of network endpoints happens inside drivers. | ||
| For more details about the Bolt messages involved in the communication, check [the following link](https://neo4j.com/docs/bolt/current/bolt/message/#messages-route). |
There was a problem hiding this comment.
Suggested change
| from which instance can the data be read, to which instance data can be written to and which instances behave as routers. In the Memgraph HA cluster, the MAIN | |
| data instance is the only writeable instance, REPLICAs are readable instances, and COORDINATORs behave as routers. However, the cluster can be configured in such a way so | |
| that MAIN can also be used for reading. Check this [paragraph](#setting-config-for-highly-available-cluster) for more info. | |
| Bolt+routing is the client-side routing protocol which means that the resolution of network endpoints happens inside drivers. | |
| For more details about the Bolt messages involved in the communication, check [the following link](https://neo4j.com/docs/bolt/current/bolt/message/#messages-route). | |
| from which instance can the data be read, to which instance data can be written to and which instances behave as routers. In the Memgraph HA cluster, the MAIN | |
| data instance is the only writeable instance, REPLICAs are readable instances, and COORDINATORs behave as routers. However, the cluster can be configured in such a way | |
| that MAIN can also be used for reading. Check this [paragraph](#setting-config-for-highly-available-cluster) for more info. | |
| Bolt+routing is the client-side routing protocol, meaning network endpoint resolution happens inside drivers. | |
| For more details about the Bolt messages involved in the communication, check [the following link](https://neo4j.com/docs/bolt/current/bolt/message/#messages-route). |
| ``` | ||
|
|
||
| This operation will result in writing to the Raft log. | ||
|
|
||
| In case the MAIN instance already exists in the cluster, a replica instance will also be registered on MAIN. | ||
| In case the MAIN instance already exists in the cluster, a replica instance will be automatically connected to the MAIN. You can specify whether the replica should behave | ||
| synchronously or asynchronously by using `AS ASYNC` construct after instanceName. |
There was a problem hiding this comment.
Suggested change
| synchronously or asynchronously by using `AS ASYNC` construct after instanceName. | |
| synchronously or asynchronously by using `AS ASYNC` construct after `instanceName`. |
There was a problem hiding this comment.
Or just write: instance name.
Comment on lines
+389
to
+401
| There is also a configuration option for specifying whether reads from the main are enabled. The configuration value is by default false but can be changed in run-time | ||
| using the following query: | ||
|
|
||
| ``` | ||
| SET COORDINATOR SETTING 'enabled_reads_on_main' TO 'true'/'false' ; | ||
| ``` | ||
|
|
||
| All run-time configuration options can be retrieved using: | ||
|
|
||
| ``` | ||
| SHOW COORDINATOR SETTINGS ; | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I would consider introducting a subsection for run-time flags here.
I would name the parent paragraph from Setting config for highly-available cluster to -> Configuring highly-available cluster
Then that section would have a runtime subsection and a startup configuration.
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.
Release note
Added docs describing how to enable reads on main.
Related product PRs
PRs from product repo this doc page is related to:
memgraph/memgraph#2907
Checklist:
bugfixorfeaturelabel, based on the product PR type you're documenting