docs: document MariaDB driver Aurora pipelining caveat#1984
Merged
Conversation
karenc-bq
approved these changes
Jun 22, 2026
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
2 participants
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.
Summary
The MariaDB driver uses pipelining, which is not compatible with Aurora. This PR documents that caveat and the properties (
usePipelineAuth,useBatchMultiSend) that should be disabled when using the MariaDB driver against Aurora.This is the docs-only portion of #1627, which targets the
2.6.xline. The version downgrade (MariaDB 3.x → 2.x) and related code changes from that PR are intentionally not included here, sincemaincontinues to support MariaDB 3.x.Changes
README.md: added a#### MariaDBsubsection under Known Limitations with the pipelining caveat and properties to disable; added a caveat link in the intro.docs/GettingStarted.mdanddocs/using-the-jdbc-driver/UsingTheJdbcDriver.md: added links pointing to the new README MariaDB section.Testing
Docs-only change; no code or tests affected.
Relates to #1627