Skip to content

docs: compatibility guide improvements #1638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sergiyvamz merged 3 commits into from
Dec 17, 2025
+14 −0
Merged

docs: compatibility guide improvements #1638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
20c7bc2
docs: compatibility guide improvements
sergiyvamz Dec 10, 2025
5bd381e
Update docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md
sergiyvamz Dec 17, 2025
17d72ac
.
sergiyvamz Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/using-the-jdbc-driver/CompatibilityCrossPlugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Cross plugin compatibility

This document is part of the [Compatibility Guide](./Compatibility.md) and explains compatibility between various plugins. While combining plugins in a single driver configuration is common, some plugins may not work properly together. Such incompatibilities can arise from either plugin design constraints or logical conflicts.

For example, the `failover` plugin is incompatible with `failover2`. Both plugins support database cluster failover but implement this functionality differently. Combining them in a single configuration causes interference between their operations, leading to instability.

Similarly, the `limitless` plugin and `customEndpoint` plugin are incompatible because Limitless Database does not support custom endpoints.


| Plugin codes / Plugin codes | executionTime | logQuery | dataCache | customEndpoint |
|---------------------------------------------------------------------------------------|----------------------------------------------------------|----------------------------------------------------------|----------------------------------------------------------|----------------------------------------------------------|
| executionTime | | | | |
Expand Down
5 changes: 5 additions & 0 deletions docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Database type compatibility

This document is part of the [Compatibility Guide](./Compatibility.md) and explains plugin compatibility with various database types and deployments. Some plugins require specific metadata from particular database types to function properly.

For example, the `limitless` plugin is incompatible with [Aurora Global Database](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) because it's built on different architectural principles than [Limitless Database](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/limitless-architecture.html). Aurora Global Database doesn't use transaction routers and doesn't provide the transaction routers' metadata. This lack of required metadata makes it incompatible with the `limitless` plugin.


| Plugin codes / Database types | [Aurora Global Database](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) <br>(MySQL and PG) | [Aurora Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.html) <br>(MySQL and PG) | [RDS Multi-AZ DB Cluster deployment (3 instances)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) <br>(MySQL and PG) |
|---------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| executionTime | <span style="color:yellow;font-size:15px">&check;</span> | <span style="color:yellow;font-size:15px">&check;</span> | <span style="color:yellow;font-size:15px">&check;</span> |
Expand Down
2 changes: 2 additions & 0 deletions docs/using-the-jdbc-driver/CompatibilityEndpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Database URL types compatibility

This document is part of the [Compatibility Guide](./Compatibility.md) and explains plugin compatibility with various database endpoints.

There are many different URL types (endpoints) that can be used with The AWS Advanced JDBC Wrapper, but certain URL types are not compatible with certain plugins. This page outlines the various URL types and which plugins are compatible with each type.

- [Aurora Global Database Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-connecting.html) - `<global-db-name>.global-<XYZ>.global.rds.amazonaws.com`
Expand Down