Skip to content

Commit 89e1ba3

Browse files
committed
chore: bump driver version and update changelog
1 parent d8526be commit 89e1ba3

File tree

5 files changed

+40
-31
lines changed

5 files changed

+40
-31
lines changed

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,26 @@ 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+
## [1.3.0] - 2025-07-28
7+
### :magic_wand: Added
8+
* [Blue/Green Plugin](https://github.com/aws/aws-advanced-python-wrapper/blob/main/docs/using-the-python-driver/using-plugins/UsingTheBlueGreenPlugin.md), which adds support for blue/green deployments ([PR #911](https://github.com/aws/aws-advanced-python-wrapper/pull/911)).
9+
* Limitless Plugin, which adds support for limitless deployments ([PR #912](https://github.com/aws/aws-advanced-python-wrapper/pull/912)).
10+
* Add weighted random host selection strategy ([PR #907](https://github.com/aws/aws-advanced-python-wrapper/pull/907)).
11+
* Add expiration time for secrets cache in the Secrets Manager Plugin ([PR #906](https://github.com/aws/aws-advanced-python-wrapper/pull/906)).
12+
* Allow custom secret keys for database credentials retrieval ([PR #843](https://github.com/aws/aws-advanced-python-wrapper/pull/843)).
13+
14+
### :bug: Fixed
15+
* Separate plugin chain cache based on whether a plugin needs to be skipped or not ([PR #916](https://github.com/aws/aws-advanced-python-wrapper/pull/916)).
16+
* Check the cached token and exception type before retrying connection in the auth plugins ([PR #902](https://github.com/aws/aws-advanced-python-wrapper/pull/902)).
17+
* Set the default SSL Secure setting to True ([PR #848](https://github.com/aws/aws-advanced-python-wrapper/pull/848)).
18+
19+
### :crab: Changed
20+
* Use poetry version compatible with Python 3.8 ([PR #913](https://github.com/aws/aws-advanced-python-wrapper/pull/913)).
21+
* Port over PluginService API changes from JDBC ([PR #901](https://github.com/aws/aws-advanced-python-wrapper/pull/901)).
22+
* Verify links in markdown documentation ([PR #909](https://github.com/aws/aws-advanced-python-wrapper/pull/909)).
23+
* Replace poetry installation with bash for GitHub actions ([PR #903](https://github.com/aws/aws-advanced-python-wrapper/pull/903)).
24+
* Update python requirement and environment variable information in documentation([PR #900](https://github.com/aws/aws-advanced-python-wrapper/pull/900)).
25+
626
## [1.2.0] - 2024-12-12
727
### :magic_wand: Added
828
* [Custom endpoint plugin](https://github.com/aws/aws-advanced-python-wrapper/blob/main/docs/using-the-python-driver/using-plugins/UsingTheCustomEndpointPlugin.md), which adds support for RDS custom endpoints.
@@ -26,6 +46,7 @@ The Amazon Web Services (AWS) Advanced Python Wrapper allows an application to t
2646
* Support for PostgreSQL
2747
* Support for MySQL
2848

49+
[1.3.0]: https://github.com/aws/aws-advanced-python-wrapper/compare/1.2.0...1.3.0
2950
[1.2.0]: https://github.com/aws/aws-advanced-python-wrapper/compare/1.1.1...1.2.0
3051
[1.1.1]: https://github.com/aws/aws-advanced-python-wrapper/compare/1.1.0...1.1.1
3152
[1.1.0]: https://github.com/aws/aws-advanced-python-wrapper/compare/1.0.0...1.1.0

Maintenance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ to releases, so you should be able to upgrade to the latest minor version of tha
3333
software without encountering incompatible changes (e.g., 1.1.0 → 1.3.x).
3434

3535
Sometimes an incompatible change is unavoidable. When this happens, the software’s maintainers will increment
36-
the major version number (e.g., increment from `aws-advanced-python-wrapper` 1.2.0 to `aws-advanced-python-wrapper` 2.0.0).
36+
the major version number (e.g., increment from `aws-advanced-python-wrapper` 1.3.0 to `aws-advanced-python-wrapper` 2.0.0).
3737
The last minor version of the previous major version of the software will then enter a maintenance window
3838
(e.g., 1.3.x). During the maintenance window, the software will continue to receive bug fixes and security patches,
3939
but no new features.
@@ -57,4 +57,4 @@ from the updated source after the PRs are merged.
5757

5858
| Major Version | Latest Minor Version | Status | Initial Release | Maintenance Window Start | Maintenance Window End |
5959
|---------------|----------------------|---------|-----------------|--------------------------|------------------------|
60-
| 1 | 1.2.0 | Current | May 16, 2024 | May 16, 2024 | N/A |
60+
| 1 | 1.3.0 | Current | May 16, 2024 | May 16, 2024 | N/A |

README.md

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -146,35 +146,23 @@ To find all the documentation and concrete examples on how to use the AWS Advanc
146146

147147
#### Amazon RDS Blue/Green Deployments
148148

149-
Although the AWS Advanced Python Wrapper is not compatible with [AWS Blue/Green Deployments](https://docs.aws.amazon.com/whitepapers/latest/overview-deployment-options/bluegreen-deployments.html) and does not officially support them, the combination of the AWS Advanced Python Wrapper and the Failover Plugin has been validated for use with clusters that employ Blue/Green Deployments. While general basic connectivity to both Blue and Green clusters is always in place, some failover cases are not fully supported.
150-
The current limitations are:
151-
- After a Blue/Green switchover, the wrapper may not be able to properly detect the new topology and handle failover, as there are discrepancies between the metadata and the available endpoints.
152-
- The specific database version requirements for different database deployments may vary, as the internal systems used by the wrapper can differ.
149+
The AWS Advanced Python Wrapper **versions 1.3.0 and above** now include enhanced full support for Blue/Green Deployments. This support requires a minimum database version that includes a specific metadata table. This constraint **does not** apply to RDS MySQL.
153150

154-
The development team is aware of these limitations and is working to improve the wrapper's awareness and handling of Blue/Green switchovers.
151+
**No action is required** if your database does not include the new metadata table -- the driver will continue to operate as before with no special blue/green functionality. If you have questions or encounter issues, please open an issue in this repository.
155152

156-
> [!WARNING]\
157-
> The AWS Advanced Python Wrapper now includes support for Blue/Green Deployments according to the description below:
158-
>
159-
> Currently Supported Database Deployments:
160-
> - Aurora MySQL and PostgreSQL clusters
161-
> - RDS MySQL and PostgreSQL instances
162-
>
163-
> Unsupported Database Deployments and Configurations:
164-
> - RDS MySQL and PostgreSQL Multi-AZ clusters
165-
> - Aurora Global Database for MySQL and PostgreSQL
166-
>
167-
> Supported RDS PostgreSQL Versions: `rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21)`.<br>
168-
> Supported Aurora PostgreSQL Versions: Engine Release `17.5, 16.9, 15.13, 14.18, 13.21`.<br>
169-
> Supported Aurora MySQL Versions: Engine Release `3.07` and above.
170-
>
171-
> For RDS Postgres, you will also need to manually install the `rds_tools` extension using the following DDL so that the metadata required by the driver is available:
172-
>
173-
> ```sql
174-
> CREATE EXTENSION rds_tools;
175-
> ```
176-
>
177-
> If your database version does **not** match the supported versions listed above, the driver will automatically fallback to its previous behaviour. In this fallback mode, Blue/Green handling is subject to the same limitations listed above. If you have questions or encounter issues, please open an issue in this repository.
153+
Supported RDS PostgreSQL Versions: `rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21)` and above.<br>
154+
Supported Aurora PostgreSQL Versions: Engine Release `17.5, 16.9, 15.13, 14.18, 13.21` and above.<br>
155+
Supported Aurora MySQL Versions: Engine Release `3.07` and above.
156+
157+
If your database version does **not** support this table, the driver will automatically detect its absence and fallback to its previous behaviour in wrapper versions <1.3.0. In this fallback mode, Blue/Green handling is subject to the same limitations listed below.
158+
159+
AWS Advanced Python Wrapper **versions earlier than 1.3.0** are not compatible with [AWS Blue/Green Deployments](https://docs.aws.amazon.com/whitepapers/latest/overview-deployment-options/bluegreen-deployments.html) and do not officially support them. However, the combination of the AWS Advanced Python Wrapper and the Failover Plugin has been validated for use with clusters that employ Blue/Green Deployments for these versions. While general basic connectivity to both Blue and Green clusters is always in place, some failover cases are not fully supported.
160+
161+
The limitations for versions earlier than 1.3.0 are:
162+
- After a Blue/Green switchover, the wrapper may not be able to properly detect the new topology and handle failover, as there are discrepancies between the metadata and the available endpoints.
163+
- The specific version requirements for Aurora MySQL versus Aurora PostgreSQL may vary, as the internal systems used by the wrapper can differ[^1].
164+
165+
[^1]: Aurora MySQL requires v3.07 or later.
178166

179167
#### MySQL Connector/Python C Extension
180168

aws_advanced_python_wrapper/driver_info.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515

1616
class DriverInfo:
1717
DRIVER_NAME = "aws_advanced_python_wrapper"
18-
DRIVER_VERSION = "1.2.0"
18+
DRIVER_VERSION = "1.3.0"

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "aws_advanced_python_wrapper"
3-
version = "1.2.0"
3+
version = "1.3.0"
44
description = "Amazon Web Services (AWS) Advanced Python Wrapper"
55
authors = ["Amazon Web Services"]
66
readme = "README.md"

0 commit comments

Comments
 (0)