You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -239,7 +239,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
239
239
240
240
### :bug: Fixed
241
241
- Connection identification and tracking in the host list provider (PR #943)[https://github.com/aws/aws-advanced-jdbc-wrapper/pull/943].
242
-
- Green node endpoint replacement, allowing the AWS JDBC Driver to detect and connect to green nodes after Blue/Green switchover (PR# 948)(https://github.com/aws/aws-advanced-jdbc-wrapper/pull/948). Addresses [issue #678](https://github.com/aws/aws-advanced-jdbc-wrapper/issues/678).
242
+
- Green node endpoint replacement, allowing the AWS Advanced JDBC Wrapper to detect and connect to green nodes after Blue/Green switchover (PR# 948)(https://github.com/aws/aws-advanced-jdbc-wrapper/pull/948). Addresses [issue #678](https://github.com/aws/aws-advanced-jdbc-wrapper/issues/678).
243
243
- MariaDB Pool Datasource support. Addresses [issue #957](https://github.com/aws/aws-advanced-jdbc-wrapper/issues/957).
244
244
245
245
### :crab: Changed
@@ -249,7 +249,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
249
249
## [2.3.5] - 2024-03-14
250
250
251
251
### :magic_wand: Added
252
-
- Sample code configuring the AWS JDBC Driver with DBCP ([PR #930](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/930)).
252
+
- Sample code configuring the AWS Advanced JDBC Wrapper with DBCP ([PR #930](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/930)).
253
253
254
254
### :crab: Changed
255
255
- Fix issue with deadlock while using prepared transactions and PostgreSQL Explicit Locking ([PR #918](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/918)).
@@ -376,7 +376,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
376
376
- Close underlying connections in the Read Write Splitting Plugin after switching to read-write or read-only depending on whether internal connection pooling is used ([PR #583](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/583)).
377
377
- Sort plugins by default to prevent plugin misconfiguration. This can be disabled by setting the property `autoSortWrapperPluginOrder` to false ([PR #542](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/542)).
378
378
- Documentation:
379
-
- Clarified AWS JDBC Driver limitations with Blue/Green deployments. See [Known Limitations](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/KnownLimitations.md#amazon-rds-bluegreen-deployments).
379
+
- Clarified AWS Advanced JDBC Wrapper limitations with Blue/Green deployments. See [Known Limitations](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/KnownLimitations.md#amazon-rds-bluegreen-deployments).
380
380
- Updated and reworded main [README.md](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/README.md) page.
381
381
382
382
## [2.2.3] - 2023-07-28
@@ -391,10 +391,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
391
391
392
392
## [2.2.2] - 2023-07-05
393
393
### :magic_wand: Added
394
-
- Official support for Amazon Aurora with MySQL compatibility. The AWS JDBC Driver has been validated to support [MySQL JDBC Driver](https://github.com/mysql/mysql-connector-j) and [MariaDB JDBC Driver](https://github.com/mariadb-corporation/mariadb-connector-j).
394
+
- Official support for Amazon Aurora with MySQL compatibility. The AWS Advanced JDBC Wrapper has been validated to support [MySQL JDBC Driver](https://github.com/mysql/mysql-connector-j) and [MariaDB JDBC Driver](https://github.com/mariadb-corporation/mariadb-connector-j).
395
395
- Documentation:
396
396
- Maintenance and release policy ([PR #442](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/442) and [PR #507](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/507)).
397
-
- Migration guide for moving from the AWS JDBC Driver for MySQL to the AWS JDBC Driver ([PR #510](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/510)).
397
+
- Migration guide for moving from the AWS Advanced JDBC Wrapper for MySQL to the AWS Advanced JDBC Wrapper ([PR #510](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/510)).
398
398
399
399
### :crab: Changed
400
400
- Improved integration test suite performance by creating required test database clusters in advance ([PR #411](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/411)).
Copy file name to clipboardExpand all lines: docs/GettingStarted.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,9 @@ Before using the AWS Advanced JDBC Driver, you must install:
10
10
- To use the wrapper with Aurora with PostgreSQL compatibility, install the [PostgreSQL JDBC Driver](https://github.com/pgjdbc/pgjdbc).
11
11
- To use the wrapper with Aurora with MySQL compatibility, install the [MySQL JDBC Driver](https://github.com/mysql/mysql-connector-j) or [MariaDB JDBC Driver](https://github.com/mariadb-corporation/mariadb-connector-j).
12
12
13
-
If you are using the AWS JDBC Driver as part of a Gradle project, include the wrapper and underlying driver as dependencies. For example, to include the AWS JDBC Driver and the PostgreSQL JDBC Driver as dependencies in a Gradle project, update the ```build.gradle``` file as follows:
13
+
If you are using the AWS Advanced JDBC Wrapper as part of a Gradle project, include the wrapper and underlying driver as dependencies. For example, to include the AWS Advanced JDBC Wrapper and the PostgreSQL JDBC Driver as dependencies in a Gradle project, update the ```build.gradle``` file as follows:
14
14
15
-
> **Note:** Depending on which features of the AWS JDBC Driver you use, you may have additional package requirements. Please refer to this [table](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#list-of-available-plugins) for more information.
15
+
> **Note:** Depending on which features of the AWS Advanced JDBC Wrapper you use, you may have additional package requirements. Please refer to this [table](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#list-of-available-plugins) for more information.
16
16
17
17
```gradle
18
18
dependencies {
@@ -21,29 +21,29 @@ dependencies {
21
21
}
22
22
```
23
23
24
-
## Obtaining the AWS JDBC Driver
24
+
## Obtaining the AWS Advanced JDBC Wrapper
25
25
26
26
### Direct Download and Installation
27
27
28
-
You can use pre-compiled packages that can be downloaded directly from [GitHub Releases](https://github.com/aws/aws-advanced-jdbc-wrapper/releases) or [Maven Central](https://central.sonatype.com/artifact/software.amazon.jdbc/aws-advanced-jdbc-wrapper) to install the AWS JDBC Driver. After downloading the AWS JDBC Driver, install it by including the .jar file in the application's CLASSPATH.
28
+
You can use pre-compiled packages that can be downloaded directly from [GitHub Releases](https://github.com/aws/aws-advanced-jdbc-wrapper/releases) or [Maven Central](https://central.sonatype.com/artifact/software.amazon.jdbc/aws-advanced-jdbc-wrapper) to install the AWS Advanced JDBC Wrapper. After downloading the AWS Advanced JDBC Wrapper, install it by including the .jar file in the application's CLASSPATH.
29
29
30
30
For example, the following command uses wget to download the wrapper:
> **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.5.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 Advanced JDBC Wrapper 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.5.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).
43
43
44
44
### As a Maven Dependency
45
45
46
-
You can use [Maven's dependency management](https://central.sonatype.com/artifact/software.amazon.jdbc/aws-advanced-jdbc-wrapper) to obtain the AWS JDBC Driver by adding the following configuration to the application's Project Object Model (POM) file:
46
+
You can use [Maven's dependency management](https://central.sonatype.com/artifact/software.amazon.jdbc/aws-advanced-jdbc-wrapper) to obtain the AWS Advanced JDBC Wrapper by adding the following configuration to the application's Project Object Model (POM) file:
47
47
48
48
```xml
49
49
<dependencies>
@@ -57,7 +57,7 @@ You can use [Maven's dependency management](https://central.sonatype.com/artifac
57
57
58
58
### As a Gradle Dependency
59
59
60
-
You can use [Gradle's dependency management](https://central.sonatype.com/artifact/software.amazon.jdbc/aws-advanced-jdbc-wrapper) to obtain the AWS JDBC Driver by adding the following configuration to the application's ```build.gradle``` file:
60
+
You can use [Gradle's dependency management](https://central.sonatype.com/artifact/software.amazon.jdbc/aws-advanced-jdbc-wrapper) to obtain the AWS Advanced JDBC Wrapper by adding the following configuration to the application's ```build.gradle``` file:
61
61
62
62
```gradle
63
63
dependencies {
@@ -73,6 +73,6 @@ dependencies {
73
73
}
74
74
```
75
75
76
-
## Using the AWS JDBC Driver
76
+
## Using the AWS Advanced JDBC Wrapper
77
77
78
-
For more detailed information about how to use and configure the AWS JDBC Driver, please visit [this page](using-the-jdbc-driver/UsingTheJdbcDriver.md).
78
+
For more detailed information about how to use and configure the AWS Advanced JDBC Wrapper, please visit [this page](using-the-jdbc-driver/UsingTheJdbcDriver.md).
| Unit tests | Tests for AWS JDBC Driver correctness. |
47
+
| Unit tests | Tests for AWS Advanced JDBC Wrapper correctness. |
48
48
| Failover integration tests | Driver-specific tests for different reader and writer failover workflows using the Failover Connection Plugin. |
49
49
| Enhanced failure monitoring integration tests | Driver-specific tests for the enhanced failure monitoring functionality using the Host Monitoring Connection Plugin. |
50
50
| AWS authentication integration tests | Driver-specific tests for AWS authentication methods with the AWS Secrets Manager Plugin or the AWS IAM Authentication Plugin. |
51
51
| Connection plugin manager benchmarks | The [benchmarks](../../benchmarks/README.md) subproject measures the overhead from executing JDBC method calls with multiple connection plugins enabled. |
52
52
53
53
### Extra Integration Tests
54
54
55
-
The AWS JDBC Driver repository also contains additional integration tests for external tools such as HikariCP, the Spring framework or Hibernate ORM.
55
+
The AWS Advanced JDBC Wrapper repository also contains additional integration tests for external tools such as HikariCP, the Spring framework or Hibernate ORM.
56
56
57
-
The AWS JDBC Driver has been manually verified to work with database tools such as DBeaver.
57
+
The AWS Advanced JDBC Wrapper has been manually verified to work with database tools such as DBeaver.
58
58
59
59
### Performance Tests
60
60
61
61
The JDBC Wrapper has 2 types of performance tests:
62
-
- benchmarks measuring the AWS JDBC Driver's overhead when executing simple JDBC methods using the JMH microbenchmark framework
62
+
- benchmarks measuring the AWS Advanced JDBC Wrapper's overhead when executing simple JDBC methods using the JMH microbenchmark framework
63
63
- manually-triggered performance tests measuring the failover and enhanced failure monitoring plugins' performance under different configurations
64
64
65
-
#### AWS JDBC Driver Benchmarks
66
-
This diagram shows the benchmarks from running UPDATE queries using the AWS JDBC Driver with pgJDBC as the target driver.
65
+
#### AWS Advanced JDBC Wrapper Benchmarks
66
+
This diagram shows the benchmarks from running UPDATE queries using the AWS Advanced JDBC Wrapper with pgJDBC as the target driver.
67
67
The baseline number represents running the same UPDATE queries with pgJDBC.
See [here](PluginPipelinePerformanceResults.md#benchmarks) for a more detailed performance breakdown.
82
82
83
83
#### Failover-specific Performance Tests
84
-
The diagrams in this section show the AWS JDBC Driver's failure detection performance with or without the Failover Connection Plugin under different settings.
84
+
The diagrams in this section show the AWS Advanced JDBC Wrapper's failure detection performance with or without the Failover Connection Plugin under different settings.
85
85
The performance tests share the following workflow:
86
86
87
-
1. The AWS JDBC Driver executes an SQL query with a long execution time.
87
+
1. The AWS Advanced JDBC Wrapper executes an SQL query with a long execution time.
88
88
2. After a network outage delay in milliseconds, the test triggers a network outage.
89
89
Varying values for the network outage delay are tested, represented on the X axis of the diagrams below.
90
90
3. Measures elapsed time between when the network outage and
91
-
- when the AWS JDBC Driver detects the network failure if the Host Monitoring Connection Plugin is used, or
92
-
- when the AWS JDBC Driver finishes the failover process if the Failover Connection Plugin is used.
91
+
- when the AWS Advanced JDBC Wrapper detects the network failure if the Host Monitoring Connection Plugin is used, or
92
+
- when the AWS Advanced JDBC Wrapper finishes the failover process if the Failover Connection Plugin is used.
93
93
94
94
This diagram shows the failover time with a 30-seconds socket timeout and different network outage delays.
See [here](PluginPipelinePerformanceResults.md#failover-performance-with-30-seconds-socket-timeout-configuration) for a more detailed performance breakdown.
97
97
98
-
The following diagrams show how the AWS JDBC Driver performs under a more common failure detection setting versus a more aggressive setting.
98
+
The following diagrams show how the AWS Advanced JDBC Wrapper performs under a more common failure detection setting versus a more aggressive setting.
99
99
100
100
Common Failure Detection Setting
101
101
@@ -127,7 +127,7 @@ See [here](PluginPipelinePerformanceResults.md#enhanced-failure-monitoring-perfo
127
127
128
128
#### Read-Write Splitting and Internal Connection Pooling Performance Tests
129
129
130
-
The diagram in this section shows the AWS JDBC Driver's performance when using the read-write splitting plugin, with or without connection pooling enabled. This test sets up a large number of connections in parallel; the initial connection is to the writer but will be changed to a random reader instance. The test executes a long query many times to simulate heavy queries.
130
+
The diagram in this section shows the AWS Advanced JDBC Wrapper's performance when using the read-write splitting plugin, with or without connection pooling enabled. This test sets up a large number of connections in parallel; the initial connection is to the writer but will be changed to a random reader instance. The test executes a long query many times to simulate heavy queries.
131
131
132
132
The average overhead time is measured as the average time difference between running the entire test with the read-write plugin and running the entire test without any plugins. The baseline overhead time is 0 because there are no plugins in this scenario and thus there is no plugin overhead.
133
133
@@ -138,7 +138,7 @@ See [here](ReadWriteSplittingPluginPerformanceResults.md#read-write-splitting-pl
138
138
139
139
### Running the Tests
140
140
141
-
After building the AWS JDBC Driver you can now run the unit tests.
141
+
After building the AWS Advanced JDBC Wrapper you can now run the unit tests.
142
142
This will also validate your environment is set up correctly.
0 commit comments