Skip to content

Commit d55e14c

Browse files
authored
set failover2 as default plugin (#1414)
1 parent 88807e3 commit d55e14c

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ The development team is aware of these limitations and is working to improve the
130130

131131
#### Amazon Aurora Global Databases
132132

133-
This driver currently does not support `planned failover` or `switchover` of Amazon Aurora Global Databases. Failing over to a secondary cluster will result in errors and there may be additional unforeseen errors when working with global databases. Connecting to the primary cluster is fully supported. There is a limitation when connected to the secondary cluster; the [failover2 plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md) will not work on the secondary cluster, however the [failover plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md) will work. Full Support for Amazon Aurora Global Databases is in the backlog, but we cannot comment on a timeline right now.
133+
This driver currently does not support `planned failover` or `switchover` of Amazon Aurora Global Databases. Failing over to a secondary cluster will result in errors and there may be additional unforeseen errors when working with global databases. Connecting to the primary cluster is fully supported. There is a limitation when connected to the secondary cluster; the [failover2 plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md) will not work on the secondary cluster, however the [failover plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md) will work. When working with Global Databases and accepting the driver's limited support, ensure you explicitly provide a list of plugins. This is crucial because the `failover2` plugin, which is enabled by default, does not support Global Databases as previously mentioned. By specifying `failover` plugin along with your desired plugins, you can ensure (still limited) functionality with Global Databases. Full Support for Amazon Aurora Global Databases is in the backlog, but we cannot comment on a timeline right now.
134134

135135
## Examples
136136

docs/using-the-jdbc-driver/UsingTheJdbcDriver.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,11 @@ Plugins are loaded and managed through the Connection Plugin Manager and may be
9999

100100
### Connection Plugin Manager Parameters
101101

102-
| Parameter | Value | Required | Description | Default Value |
103-
|-----------------------------------|-----------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|
104-
| `wrapperPlugins` | `String` | No | Comma separated list of connection plugin codes. <br><br>Example: `failover,efm2` | `auroraConnectionTracker,failover,efm2` |
105-
| `autoSortWrapperPluginOrder` | `Boolean` | No | Allows the AWS JDBC Driver to sort connection plugins to prevent plugin misconfiguration. Allows a user to provide a custom plugin order if needed. | `true` |
106-
| `wrapperProfileName` | `String` | No | Driver configuration profile name. Instead of listing plugin codes with `wrapperPlugins`, the driver profile can be set with this parameter. <br><br> Example: See [below](#configuration-profiles). | `null` |
102+
| Parameter | Value | Required | Description | Default Value |
103+
|-----------------------------------|-----------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
104+
| `wrapperPlugins` | `String` | No | Comma separated list of connection plugin codes. <br><br>Example: `failover,efm2` | `auroraConnectionTracker,failover2,efm2` |
105+
| `autoSortWrapperPluginOrder` | `Boolean` | No | Allows the AWS JDBC Driver to sort connection plugins to prevent plugin misconfiguration. Allows a user to provide a custom plugin order if needed. | `true` |
106+
| `wrapperProfileName` | `String` | No | Driver configuration profile name. Instead of listing plugin codes with `wrapperPlugins`, the driver profile can be set with this parameter. <br><br> Example: See [below](#configuration-profiles). | `null` |
107107

108108
To use a built-in plugin, specify its relevant plugin code for the `wrapperPlugins`.
109109
The default value for `wrapperPlugins` is `auroraConnectionTracker,failover,efm2`. These 3 plugins are enabled by default. To read more about these plugins, see the [List of Available Plugins](#list-of-available-plugins) section.

wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginChainBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ public class ConnectionPluginChainBuilder {
116116
}
117117
};
118118

119-
protected static final String DEFAULT_PLUGINS = "auroraConnectionTracker,failover,efm2";
119+
protected static final String DEFAULT_PLUGINS = "auroraConnectionTracker,failover2,efm2";
120120

121121
/*
122122
Internal class used for plugin factory sorting. It holds a reference to a plugin

wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginManagerTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -615,7 +615,7 @@ public void testDefaultPlugins() throws SQLException {
615615

616616
assertEquals(4, target.plugins.size());
617617
assertEquals(AuroraConnectionTrackerPlugin.class, target.plugins.get(0).getClass());
618-
assertEquals(FailoverConnectionPlugin.class, target.plugins.get(1).getClass());
618+
assertEquals(software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin.class, target.plugins.get(1).getClass());
619619
assertEquals(HostMonitoringConnectionPlugin.class, target.plugins.get(2).getClass());
620620
assertEquals(DefaultConnectionPlugin.class, target.plugins.get(3).getClass());
621621
}

0 commit comments

Comments
 (0)