Skip to content

Commit b929f79

Browse files
authored
chore: update changelog and bump version to v2.6.2 (#1496)
1 parent 9e5da8a commit b929f79

File tree

13 files changed

+35
-19
lines changed

13 files changed

+35
-19
lines changed

CHANGELOG.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,22 @@ All notable changes to this project will be documented in this file.
33

44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/#semantic-versioning-200).
55

6+
## [2.6.2] - 2025-07-31
7+
8+
### :crab: Changed
9+
- Reverted the breaking change to suggested `clusterId` functionality ([PR #1476](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1493)), which made `clusterId` a required parameter in applications using multiple database clusters. This change will be reintroduced later as a major version update.
10+
611
## [2.6.1] - 2025-07-21
12+
> [!WARNING]\
13+
> This patch removes the suggested ClusterId functionality.
14+
> #### Suggested ClusterId Functionality
15+
> Prior to this change, the wrapper would generate a unique cluster ID based on the connection string and the cluster topology; however, in some cases (such as custom endpoints, IP addresses, and CNAME aliases, etc), the wrapper would generate an incorrect identifier. This change was needed to prevent applications with several clusters from accidentally relying on incorrect topology during failover which could result in the wrapper failing to complete failover successfully.
16+
> #### Migration
17+
> | Number of Database Clusters in Use | Requires Changes | Action Items |
18+
> |------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
19+
> | Single database cluster | No | No changes required |
20+
> | Multiple database clusters | Yes | Review all connection strings and add mandatory `clusterId` parameter ([PR #1476](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1476)). See [documentation](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md#failover-plugin-v2-configuration-parameters) for `clusterId` parameter configuration |
21+
722
### :magic_wand: Added
823
- Add a Blue/Green Support Behaviour and Version Compatibility section to the Blue Green Plugin documentation ([PR #1475](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1475)).
924

@@ -15,7 +30,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
1530
- Performance optimization ([PR #1444](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1444)).
1631
- Blue/Green Plugin [documentation](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheBlueGreenPlugin.md) to include default and suggested parameter values.
1732
- Updated Hibernate tests to Hibernate version 7.0.2.
18-
- Remove suggested ClusterId functionality. For applications that use a single cluster database **no changes are required**. For application that access multiple database clusters, all connection string **should be** reviewed and a mandatory `clusterId` parameter **should be added** ([PR #1476](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1476)). See the [documentation](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md#failover-plugin-v2-configuration-parameters) to learn about the `clusterId` parameter.
1933

2034
## [2.6.0] - 2025-06-10
2135
### :magic_wand: Added
@@ -470,6 +484,7 @@ The Amazon Web Services (AWS) Advanced JDBC Driver allows an application to take
470484
- The [AWS IAM Authentication Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)
471485
- The [AWS Secrets Manager Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
472486

487+
[2.6.2]: https://github.com/aws/aws-advanced-jdbc-wrapper/compare/2.6.1...2.6.2
473488
[2.6.1]: https://github.com/aws/aws-advanced-jdbc-wrapper/compare/2.6.0...2.6.1
474489
[2.6.0]: https://github.com/aws/aws-advanced-jdbc-wrapper/compare/2.5.6...2.6.0
475490
[2.5.6]: https://github.com/aws/aws-advanced-jdbc-wrapper/compare/2.5.5...2.5.6

Maintenance.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
| April 9, 2025 | [Release 2.5.6](https://github.com/aws/aws-advanced-jdbc-wrapper/releases/tag/2.5.6) |
3535
| June 10, 2025 | [Release 2.6.0](https://github.com/aws/aws-advanced-jdbc-wrapper/releases/tag/2.6.0) |
3636
| July 21, 2025 | [Release 2.6.1](https://github.com/aws/aws-advanced-jdbc-wrapper/releases/tag/2.6.1) |
37+
| July 31, 2025 | [Release 2.6.2](https://github.com/aws/aws-advanced-jdbc-wrapper/releases/tag/2.6.2) |
3738

3839
`aws-advanced-jdbc-wrapper` [follows semver](https://semver.org/#semantic-versioning-200) which means we will only
3940
release breaking changes in major versions. Generally speaking patches will be released to fix existing problems without
@@ -87,4 +88,4 @@ from the updated source after the PRs are merged.
8788
| Major Version | Latest Minor Version | Status | Initial Release | Maintenance Window Start | Maintenance Window End |
8889
|---------------|----------------------|-------------|-----------------|--------------------------|------------------------|
8990
| 1 | 1.0.2 | Maintenance | Oct 5, 2022 | Apr 28, 2023 | Apr 28, 2024 |
90-
| 2 | 2.6.1 | Current | Apr 28, 2023 | N/A | N/A |
91+
| 2 | 2.6.2 | Current | Apr 28, 2023 | N/A | N/A |

benchmarks/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ The benchmarks do not measure the performance of target JDBC drivers nor the per
77
## Usage
88
1. Build the benchmarks with the following command `../gradlew jmhJar`.
99
1. the JAR file will be outputted to `build/libs`
10-
2. Run the benchmarks with the following command `java -jar build/libs/benchmarks-2.6.1-jmh.jar`.
10+
2. Run the benchmarks with the following command `java -jar build/libs/benchmarks-2.6.2-jmh.jar`.
1111
1. you may have to update the command based on the exact version of the produced JAR file

docs/GettingStarted.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ If you are using the AWS JDBC Driver as part of a Gradle project, include the wr
1616
1717
```gradle
1818
dependencies {
19-
implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.6.1'
19+
implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.6.2'
2020
implementation group: 'org.postgresql', name: 'postgresql', version: '42.5.0'
2121
}
2222
```
@@ -30,16 +30,16 @@ You can use pre-compiled packages that can be downloaded directly from [GitHub R
3030
For example, the following command uses wget to download the wrapper:
3131

3232
```bash
33-
wget https://github.com/aws/aws-advanced-jdbc-wrapper/releases/download/2.6.1/aws-advanced-jdbc-wrapper-2.6.1.jar
33+
wget https://github.com/aws/aws-advanced-jdbc-wrapper/releases/download/2.6.2/aws-advanced-jdbc-wrapper-2.6.2.jar
3434
```
3535

3636
Then, the following command adds the AWS JDBC Driver to the CLASSPATH:
3737

3838
```bash
39-
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.6.1.jar
39+
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.6.2.jar
4040
```
4141

42-
> **Note**: There is also a JAR suffixed with `-bundle-federated-auth`. It is an Uber JAR that contains the AWS JDBC Driver as well as all the dependencies needed to run the Federated Authentication Plugin. **Our general recommendation is to use the `aws-advanced-jdbc-wrapper-2.6.1.jar` for use cases unrelated to complex Federated Authentication environments**. To learn more, please check out the [Federated Authentication Plugin](./using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md#bundled-uber-jar).
42+
> **Note**: There is also a JAR suffixed with `-bundle-federated-auth`. It is an Uber JAR that contains the AWS JDBC Driver as well as all the dependencies needed to run the Federated Authentication Plugin. **Our general recommendation is to use the `aws-advanced-jdbc-wrapper-2.6.2.jar` for use cases unrelated to complex Federated Authentication environments**. To learn more, please check out the [Federated Authentication Plugin](./using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md#bundled-uber-jar).
4343
4444
### As a Maven Dependency
4545

@@ -50,7 +50,7 @@ You can use [Maven's dependency management](https://search.maven.org/search?q=g:
5050
<dependency>
5151
<groupId>software.amazon.jdbc</groupId>
5252
<artifactId>aws-advanced-jdbc-wrapper</artifactId>
53-
<version>2.6.1</version>
53+
<version>2.6.2</version>
5454
</dependency>
5555
</dependencies>
5656
```
@@ -61,15 +61,15 @@ You can use [Gradle's dependency management](https://search.maven.org/search?q=g
6161

6262
```gradle
6363
dependencies {
64-
implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.6.1'
64+
implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.6.2'
6565
}
6666
```
6767

6868
To add a Gradle dependency in a Kotlin syntax, use the following configuration:
6969

7070
```kotlin
7171
dependencies {
72-
implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.6.1")
72+
implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.6.2")
7373
}
7474
```
7575

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ To use a snapshot build in your project, check the following examples. More info
229229
<dependency>
230230
<groupId>software.amazon.jdbc</groupId>
231231
<artifactId>aws-advanced-jdbc-wrapper</artifactId>
232-
<version>2.6.1-SNAPSHOT</version>
232+
<version>2.6.2-SNAPSHOT</version>
233233
</dependency>
234234
</dependencies>
235235

docs/using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ This JAR is a drop-in ready solution and is **recommended for customers who do n
3232
As this plugin has a number of transitive dependencies, the goal of this JAR is to eliminate the need to manually source all the dependencies and avoid potential issues with managing them.
3333
In that spirit, the dependencies in this JAR are shaded with the prefix `shaded` to avoid potential package conflicts with pre-existing packages in your environment.
3434

35-
It is important to note that the Uber JAR is bundled with the AWS Java RDS SDK and is larger (**15 MB**) than our `aws-advanced-jdbc-wrapper-2.6.1.jar`. So please take that into account when deciding if this solution is for you.
35+
It is important to note that the Uber JAR is bundled with the AWS Java RDS SDK and is larger (**15 MB**) than our `aws-advanced-jdbc-wrapper-2.6.2.jar`. So please take that into account when deciding if this solution is for you.
3636

3737
If you would like to download and install the bundled Uber JAR, follow these [instructions](../../GettingStarted.md#direct-download-and-installation).
3838

examples/SpringBootHikariExample/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ In this tutorial, you will set up a Spring Boot application using Hikari and the
44

55
> Note: this tutorial was written using the following technologies:
66
> - Spring Boot 2.7.0
7-
> - AWS JDBC Driver 2.6.1
7+
> - AWS JDBC Driver 2.6.2
88
> - Postgresql 42.5.4
99
> - Java 8
1010

examples/SpringHibernateExample/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ In this tutorial, you will set up a Spring Boot and Hibernate application with t
55
> Note: this tutorial was written using the following technologies:
66
> - Spring Boot 2.7.1
77
> - Hibernate
8-
> - AWS JDBC Driver 2.6.1
8+
> - AWS JDBC Driver 2.6.2
99
> - Postgresql 42.5.4
1010
> - Gradle 7
1111
> - Java 11

examples/SpringTxFailoverExample/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ In this tutorial, you will set up a Spring Boot application using the AWS JDBC D
44

55
> Note: this tutorial was written using the following technologies:
66
> - Spring Boot 2.7.0
7-
> - AWS JDBC Driver 2.6.1
7+
> - AWS JDBC Driver 2.6.2
88
> - Postgresql 42.5.4
99
> - Java 8
1010

examples/SpringWildflyExample/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ In this tutorial, you will set up a Wildfly and Spring Boot application with the
55
> Note: this tutorial was written using the following technologies:
66
> - Spring Boot 2.7.1
77
> - Wildfly 26.1.1 Final
8-
> - AWS JDBC Driver 2.6.1
8+
> - AWS JDBC Driver 2.6.2
99
> - Postgresql 42.5.4
1010
> - Gradle 7
1111
> - Java 11

0 commit comments

Comments
 (0)