Document read replication and transaction behaviour#574
Open
Rochet2 wants to merge 4 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the read replication documentation to clarify how pool selection behaves when running queries inside transactions.
Changes:
- Clarifies that transactional reads/writes default to using the write pool.
- Adjusts the existing description of how
useMasterandSELECTinteract with replication pools.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
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.
It appears that there is no documentation that I could find on read replication and how useMaster is not needed for select queries in a transaction for consistency. This PR should document the default behaviour of SELECT queries in a transaction when using read replication.
In V7 there will be a new setting for transactions to allow going to read pool only.
It could also be mentioned here maybe?
I also wonder (have not tested) what happens if one explicitly sets useMaster true/false inside a transaction.
Maybe something to document as well.