Skip to content

Commit 0e816cc

Browse files
committed
docs: replace references to AWS JDBC Driver to AWS Advanced JDBC Wrapper for consistency
1 parent 56b4476 commit 0e816cc

39 files changed

+194
-194
lines changed

CHANGELOG.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
239239

240240
### :bug: Fixed
241241
- 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).
243243
- MariaDB Pool Datasource support. Addresses [issue #957](https://github.com/aws/aws-advanced-jdbc-wrapper/issues/957).
244244

245245
### :crab: Changed
@@ -249,7 +249,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
249249
## [2.3.5] - 2024-03-14
250250

251251
### :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)).
253253

254254
### :crab: Changed
255255
- 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/),
376376
- 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)).
377377
- 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)).
378378
- 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).
380380
- Updated and reworded main [README.md](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/README.md) page.
381381

382382
## [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/),
391391

392392
## [2.2.2] - 2023-07-05
393393
### :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).
395395
- Documentation:
396396
- 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)).
398398

399399
### :crab: Changed
400400
- 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)).

README.md

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

docs/Documentation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Documentation
22

33
- [Getting Started](./GettingStarted.md)
4-
- [Using the AWS JDBC Driver](./using-the-jdbc-driver/UsingTheJdbcDriver.md)
4+
- [Using the AWS Advanced JDBC Wrapper](./using-the-jdbc-driver/UsingTheJdbcDriver.md)
55
- [Data Sources](./using-the-jdbc-driver/DataSource.md)
66
- [Logging](./using-the-jdbc-driver/UsingTheJdbcDriver.md#logging)
77
- [Telemetry](./using-the-jdbc-driver/Telemetry.md)
@@ -24,7 +24,7 @@
2424
- [Host Availability Strategy](./using-the-jdbc-driver/HostAvailabilityStrategy.md)
2525
- [Development Guide](./development-guide/DevelopmentGuide.md)
2626
- [Setup](./development-guide/DevelopmentGuide.md#setup)
27-
- [Building the AWS JDBC Driver](./development-guide/DevelopmentGuide.md#building-the-aws-advanced-jdbc-driver)
27+
- [Building the AWS Advanced JDBC Wrapper](./development-guide/DevelopmentGuide.md#building-the-aws-advanced-jdbc-driver)
2828
- [Testing Overview](./development-guide/DevelopmentGuide.md#testing-overview)
2929
- [Performance Tests](./development-guide/DevelopmentGuide.md#performance-tests)
3030
- [Running the Tests](./development-guide/DevelopmentGuide.md#running-the-tests)

docs/GettingStarted.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Before using the AWS Advanced JDBC Driver, you must install:
1010
- To use the wrapper with Aurora with PostgreSQL compatibility, install the [PostgreSQL JDBC Driver](https://github.com/pgjdbc/pgjdbc).
1111
- 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).
1212

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:
1414

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.
1616
1717
```gradle
1818
dependencies {
@@ -21,29 +21,29 @@ dependencies {
2121
}
2222
```
2323

24-
## Obtaining the AWS JDBC Driver
24+
## Obtaining the AWS Advanced JDBC Wrapper
2525

2626
### Direct Download and Installation
2727

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.
2929

3030
For example, the following command uses wget to download the wrapper:
3131

3232
```bash
3333
wget https://github.com/aws/aws-advanced-jdbc-wrapper/releases/download/2.6.5/aws-advanced-jdbc-wrapper-2.6.5.jar
3434
```
3535

36-
Then, the following command adds the AWS JDBC Driver to the CLASSPATH:
36+
Then, the following command adds the AWS Advanced JDBC Wrapper to the CLASSPATH:
3737

3838
```bash
3939
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.6.5.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.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).
4343
4444
### As a Maven Dependency
4545

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:
4747

4848
```xml
4949
<dependencies>
@@ -57,7 +57,7 @@ You can use [Maven's dependency management](https://central.sonatype.com/artifac
5757

5858
### As a Gradle Dependency
5959

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:
6161

6262
```gradle
6363
dependencies {
@@ -73,6 +73,6 @@ dependencies {
7373
}
7474
```
7575

76-
## Using the AWS JDBC Driver
76+
## Using the AWS Advanced JDBC Wrapper
7777

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).

docs/development-guide/DevelopmentGuide.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
### Setup
44
Make sure you have Amazon Corretto 8+ or Java 8+ installed.
55

6-
Clone the AWS JDBC Driver repository:
6+
Clone the AWS Advanced JDBC Wrapper repository:
77

88
```bash
99
git clone https://github.com/aws/aws-advanced-jdbc-wrapper.git
@@ -40,62 +40,62 @@ gradlew build
4040

4141
## Testing Overview
4242

43-
The AWS JDBC Driver uses the following tests to verify its correctness and performance on both JVM and GraalVM:
43+
The AWS Advanced JDBC Wrapper uses the following tests to verify its correctness and performance on both JVM and GraalVM:
4444

4545
| Tests | Description |
4646
|-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
47-
| Unit tests | Tests for AWS JDBC Driver correctness. |
47+
| Unit tests | Tests for AWS Advanced JDBC Wrapper correctness. |
4848
| Failover integration tests | Driver-specific tests for different reader and writer failover workflows using the Failover Connection Plugin. |
4949
| Enhanced failure monitoring integration tests | Driver-specific tests for the enhanced failure monitoring functionality using the Host Monitoring Connection Plugin. |
5050
| AWS authentication integration tests | Driver-specific tests for AWS authentication methods with the AWS Secrets Manager Plugin or the AWS IAM Authentication Plugin. |
5151
| Connection plugin manager benchmarks | The [benchmarks](../../benchmarks/README.md) subproject measures the overhead from executing JDBC method calls with multiple connection plugins enabled. |
5252

5353
### Extra Integration Tests
5454

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.
5656

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.
5858

5959
### Performance Tests
6060

6161
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
6363
- manually-triggered performance tests measuring the failover and enhanced failure monitoring plugins' performance under different configurations
6464

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.
6767
The baseline number represents running the same UPDATE queries with pgJDBC.
6868
![](../images/jdbc_wrapper_postgresql_benchmarks.png)
6969

70-
This diagram shows the benchmarks from running UPDATE queries using the AWS JDBC Driver with MySQL Connector/J as the target driver.
70+
This diagram shows the benchmarks from running UPDATE queries using the AWS Advanced JDBC Wrapper with MySQL Connector/J as the target driver.
7171
The baseline number represents running the same UPDATE queries with MySQL Connector/J.
7272
![](../images/jdbc_wrapper_mysql_benchmarks.png)
7373

74-
There are also specific benchmarks measuring the AWS JDBC Driver's [pipelines](Pipelines.md).
74+
There are also specific benchmarks measuring the AWS Advanced JDBC Wrapper's [pipelines](Pipelines.md).
7575
These benchmarks do not make actual connections to the databases and use simple test plugins.
76-
The goal of these benchmarks is to measure the overhead of using the AWS JDBC Driver with multiple plugins enabled.
76+
The goal of these benchmarks is to measure the overhead of using the AWS Advanced JDBC Wrapper with multiple plugins enabled.
7777
![](../images/jdbc_wrapper_connect_execute_pipelines_benchmarks.png)
7878
![](../images/jdbc_wrapper_pipelines_benchmarks.png)
7979
![](../images/jdbc_wrapper_init_release_pipelines_benchmarks.png)
8080

8181
See [here](PluginPipelinePerformanceResults.md#benchmarks) for a more detailed performance breakdown.
8282

8383
#### 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.
8585
The performance tests share the following workflow:
8686

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.
8888
2. After a network outage delay in milliseconds, the test triggers a network outage.
8989
Varying values for the network outage delay are tested, represented on the X axis of the diagrams below.
9090
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.
9393

9494
This diagram shows the failover time with a 30-seconds socket timeout and different network outage delays.
9595
![](../images/jdbc_wrapper_postgresql_failover_with_30s_socket_timeout.png)
9696
See [here](PluginPipelinePerformanceResults.md#failover-performance-with-30-seconds-socket-timeout-configuration) for a more detailed performance breakdown.
9797

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.
9999

100100
Common Failure Detection Setting
101101

@@ -127,7 +127,7 @@ See [here](PluginPipelinePerformanceResults.md#enhanced-failure-monitoring-perfo
127127

128128
#### Read-Write Splitting and Internal Connection Pooling Performance Tests
129129

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.
131131

132132
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.
133133

@@ -138,7 +138,7 @@ See [here](ReadWriteSplittingPluginPerformanceResults.md#read-write-splitting-pl
138138

139139
### Running the Tests
140140

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.
142142
This will also validate your environment is set up correctly.
143143

144144
Mac:

0 commit comments

Comments
 (0)