Skip to content

Commit 7677aa0

Browse files
authored
docs: fix links in documentation and update wording (aws#196)
- Update references to JDBC Driver/Wrapper - Fix broken links - Rename files and directories to use JDBC Driver instead of JDBC Wrapper
1 parent eb04fa6 commit 7677aa0

26 files changed

+224
-222
lines changed

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ The Amazon Web Services (AWS) Advanced JDBC Wrapper allows an application to tak
99

1010
### Added
1111
* Support for PostgreSQL
12-
* The [Failover Connection Plugin](./docs/using-the-jdbc-wrapper/using-plugins/UsingTheFailoverPlugin.md)
13-
* The [Host Monitoring Connection Plugin](./docs/using-the-jdbc-wrapper/using-plugins/UsingTheHostMonitoringPlugin.md)
14-
* The [AWS IAM Authentication Connection Plugin](./docs/using-the-jdbc-wrapper/using-plugins/UsingTheIamAuthenticationPlugin.md)
15-
* The [AWS Secrets Manager Connection Plugin](./docs/using-the-jdbc-wrapper/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
12+
* The [Failover Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md)
13+
* The [Host Monitoring Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheHostMonitoringPlugin.md)
14+
* The [AWS IAM Authentication Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)
15+
* The [AWS Secrets Manager Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
1616

1717
[1.0.0]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/1.0.0

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,34 @@
44
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
55
[![Qodana](https://github.com/awslabs/aws-advanced-jdbc-wrapper/actions/workflows/code_quality.yml/badge.svg)](https://github.com/awslabs/aws-advanced-jdbc-wrapper/actions/workflows/code_quality.yml)
66

7-
The **Amazon Web Services JDBC Driver** has been redesigned as an advanced JDBC wrapper. This wrapper is complementary to and extends the functionality of an existing JDBC driver to help an application take advantage of the features of clustered databases such as Amazon Aurora. The AWS JDBC wrapper does not implement connectivity on its own to any database, but will enable support of AWS and Aurora functionalities on top of an underlying JDBC driver of the user's choice.
7+
The **Amazon Web Services JDBC Driver** has been redesigned as an advanced JDBC wrapper. This wrapper is complementary to and extends the functionality of an existing JDBC driver to help an application take advantage of the features of clustered databases such as Amazon Aurora. The AWS JDBC Driver does not implement connectivity on its own to any database, but will enable support of AWS and Aurora functionalities on top of an underlying JDBC driver of the user's choice.
88

9-
The JDBC wrapper is meant to work with any JDBC driver. Currently, the JDBC wrapper has been validated to support the [PostgreSQL JDBC Driver](https://github.com/pgjdbc/pgjdbc). Support for the [MySQL JDBC Driver](https://github.com/mysql/mysql-connector-j) and the [MariaDB JDBC Driver](https://github.com/mariadb-corporation/mariadb-connector-j) is being evaluated.
9+
The AWS JDBC Driver is meant to work with any JDBC driver. Currently, the AWS JDBC Driver has been validated to support the [PostgreSQL JDBC Driver](https://github.com/pgjdbc/pgjdbc). Support for the [MySQL JDBC Driver](https://github.com/mysql/mysql-connector-j) and the [MariaDB JDBC Driver](https://github.com/mariadb-corporation/mariadb-connector-j) is being evaluated.
1010

11-
In conjunction with the PostgreSQL JDBC Driver, the AWS JDBC wrapper enables fast failover for Amazon Aurora with PostgreSQL compatibility. It also supports integration with [AWS Identity and Access Management (IAM)](https://aws.amazon.com/iam/) and [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/). We are investigating Read/Write splitting for a future release.
11+
In conjunction with the PostgreSQL JDBC Driver, the AWS JDBC Driver enables fast failover for Amazon Aurora with PostgreSQL compatibility. It also supports integration with [AWS Identity and Access Management (IAM)](https://aws.amazon.com/iam/) and [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/). We are investigating Read/Write splitting for a future release.
1212

1313
## About the Driver
1414

1515
### What is Failover?
1616
In an Amazon Aurora database (DB) cluster, failover is a mechanism by which Aurora automatically repairs the DB cluster status when a primary DB instance becomes unavailable. It achieves this goal by electing an Aurora Replica to become the new primary DB instance, so that the DB cluster can provide maximum availability to a primary read-write DB instance. The AWS JDBC Driver is designed to coordinate with this behavior in order to provide minimal downtime in the event of a DB instance failure.
1717

1818
### Benefits of the AWS JDBC Driver
19-
Although Aurora is able to provide maximum availability through the use of failover, existing client drivers do not currently support this functionality. This is partially due to the time required for the DNS of the new primary DB instance to be fully resolved in order to properly direct the connection. The AWS JDBC wrapper allows customers to continue using their existing community drivers in addition to having the JDBC wrapper fully exploit failover behavior by maintaining a cache of the Aurora cluster topology and each DB instance's role (Aurora Replica or primary DB instance). This topology is provided via a direct query to the Aurora DB, essentially providing a shortcut to bypass the delays caused by DNS resolution. With this knowledge, the AWS JDBC Driver can more closely monitor the Aurora DB cluster status so that a connection to the new primary DB instance can be established as fast as possible. Additionally, as noted above, the AWS JDBC Driver is designed to augment existing JDBC community drivers and be a unified connector to JDBC workflows for Aurora.
19+
Although Aurora is able to provide maximum availability through the use of failover, existing client drivers do not currently support this functionality. This is partially due to the time required for the DNS of the new primary DB instance to be fully resolved in order to properly direct the connection. The AWS JDBC Driver allows customers to continue using their existing community drivers in addition to having the AWS JDBC Driver fully exploit failover behavior by maintaining a cache of the Aurora cluster topology and each DB instance's role (Aurora Replica or primary DB instance). This topology is provided via a direct query to the Aurora DB, essentially providing a shortcut to bypass the delays caused by DNS resolution. With this knowledge, the AWS JDBC Driver can more closely monitor the Aurora DB cluster status so that a connection to the new primary DB instance can be established as fast as possible. Additionally, as noted above, the AWS JDBC Driver is designed to augment existing JDBC community drivers and be a unified connector to JDBC workflows for Aurora.
2020

2121
#### Enhanced Failure Monitoring
22-
Enhanced Failure Monitoring (EFM) is a feature available from the [Host Monitoring Connection Plugin](/docs/using-the-jdbc-wrapper/using-plugins/UsingTheHostMonitoringPlugin.md#enhanced-failure-monitoring) that periodically checks the connected database node's health and availability. If a database node is determined to be unhealthy, the connection is aborted.
22+
Enhanced Failure Monitoring (EFM) is a feature available from the [Host Monitoring Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheHostMonitoringPlugin.md#enhanced-failure-monitoring) that periodically checks the connected database node's health and availability. If a database node is determined to be unhealthy, the connection is aborted.
2323

2424
## Getting Started
25-
For more information on how to obtain the JDBC wrapper, minimum requirements to use it, and how to integrate the JDBC wrapper into your project, please visit the [Getting Started page](./docs/GettingStarted.md).
25+
For more information on how to obtain the AWS JDBC Driver, minimum requirements to use it, and how to integrate the AWS JDBC Driver into your project, please visit the [Getting Started page](./docs/GettingStarted.md).
2626

27-
## Using the Wrapper
28-
Please refer to the JDBC wrapper's [Documentation page](./docs/Documentation.md) for details about using the JDBC wrapper.
27+
## Using the AWS JDBC Driver
28+
Please refer to the AWS JDBC Driver's [Documentation page](./docs/Documentation.md) for details about using the AWS JDBC Driver.
2929

3030
## Logging
31-
To configure logging, check out the [Logging](./docs/using-the-jdbc-wrapper/UsingTheJdbcWrapper.md#logging) section.
31+
To configure logging, check out the [Logging](./docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#logging) section.
3232

3333
## Documentation
34-
Technical documentation regarding the functionality of the AWS JDBC Driver will be maintained in this GitHub repository. Since the JDBC wrapper requires an underlying JDBC driver, please refer to the individual driver's documentation for driver specific information.
34+
Technical documentation regarding the functionality of the AWS JDBC Driver will be maintained in this GitHub repository. Since the AWS JDBC Driver requires an underlying JDBC driver, please refer to the individual driver's documentation for driver specific information.
3535

3636
## Getting Help and Opening Issues
3737
If you encounter a bug with the AWS JDBC Driver, we would like to hear about it.

docs/Documentation.md

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

33
- [Getting Started](./GettingStarted.md)
4-
- [Using the AWS Advanced JDBC Wrapper](./using-the-jdbc-wrapper/UsingTheJdbcWrapper.md)
5-
- [Data Sources](./using-the-jdbc-wrapper/DataSource.md)
6-
- [Logging](./using-the-jdbc-wrapper/UsingTheJdbcWrapper.md#logging)
7-
- [JDBC Wrapper Parameters](./using-the-jdbc-wrapper/UsingTheJdbcWrapper.md#aws-advanced-jdbc-wrapper-parameters)
8-
- [Plugins](./using-the-jdbc-wrapper/UsingTheJdbcWrapper.md#plugins)
9-
- [Failover Plugin](./using-the-jdbc-wrapper/using-plugins/UsingTheFailoverPlugin.md)
10-
- [Failover Configuration Guide](using-the-jdbc-wrapper/FailoverConfigurationGuide.md)
11-
- [Host Monitoring Plugin](./using-the-jdbc-wrapper/using-plugins/UsingTheHostMonitoringPlugin.md)
12-
- [IAM Authentication Plugin](./using-the-jdbc-wrapper/using-plugins/UsingTheIamAuthenticationPlugin.md)
13-
- [AWS Secrets Manager Plugin](./using-the-jdbc-wrapper/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
4+
- [Using the AWS Advanced JDBC Wrapper](/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md)
5+
- [Data Sources](/docs/using-the-jdbc-driver/DataSource.md)
6+
- [Logging](/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#logging)
7+
- [JDBC Wrapper Parameters](/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#aws-advanced-jdbc-driver-parameters)
8+
- [Plugins](/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#plugins)
9+
- [Failover Plugin](/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md)
10+
- [Failover Configuration Guide](/docs/using-the-jdbc-driver/FailoverConfigurationGuide.md)
11+
- [Host Monitoring Plugin](/docs/using-the-jdbc-driver/using-plugins/UsingTheHostMonitoringPlugin.md)
12+
- [IAM Authentication Plugin](/docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)
13+
- [AWS Secrets Manager Plugin](/docs/using-the-jdbc-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
1414
- [Development Guide](./development-guide/DevelopmentGuide.md)
1515
- [Setup](./development-guide/DevelopmentGuide.md#setup)
16-
- [Building the AWS Advanced JDBC Wrapper](./development-guide/DevelopmentGuide.md#building-the-aws-advanced-jdbc-wrapper)
16+
- [Building the AWS Advanced JDBC Driver](./development-guide/DevelopmentGuide.md#building-the-aws-advanced-jdbc-driver)
1717
- [Running the Tests](./development-guide/DevelopmentGuide.md#running-the-tests)
1818
- [Architecture](./development-guide/Architecture.md)
1919
- [Plugin Manager](./development-guide/PluginManager.md)

docs/GettingStarted.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## Minimum Requirements
44

5-
Before using the AWS Advanced JDBC Wrapper, you must install:
5+
Before using the AWS Advanced JDBC Driver, you must install:
66

77
- Amazon Corretto 8+ or Java 8+.
8-
- The AWS Advanced JDBC Wrapper.
8+
- The AWS Advanced JDBC Driver.
99
- Your choice of underlying JDBC driver. To use the wrapper with Aurora with PostgreSQL compatibility, you need to install the [PostgreSQL JDBC Driver](https://github.com/pgjdbc/pgjdbc).
1010

11-
If you are using the 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:
11+
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 Advanced JDBC Driver and the PostgreSQL JDBC Driver as dependencies in a Gradle project, update the ```build.gradle``` file as follows:
1212

1313
```gradle
1414
dependencies {
@@ -17,27 +17,27 @@ dependencies {
1717
}
1818
```
1919

20-
## Obtaining the AWS Advanced JDBC Wrapper
20+
## Obtaining the AWS Advanced JDBC Driver
2121

2222
### Direct Download and Installation
2323

24-
You can use pre-compiled packages that can be downloaded directly from [GitHub Releases](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases) or [Maven Central](https://search.maven.org/search?q=g:software.amazon.jdbc) to install the AWS Advanced JDBC Wrapper. After downloading the wrapper, install the wrapper by including the .jar file in the application's CLASSPATH.
24+
You can use pre-compiled packages that can be downloaded directly from [GitHub Releases](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases) or [Maven Central](https://search.maven.org/search?q=g:software.amazon.jdbc) to install the AWS Advanced JDBC Driver. After downloading the AWS JDBC Driver, install it by including the .jar file in the application's CLASSPATH.
2525

2626
For example, the following command uses wget to download the wrapper:
2727

2828
```bash
2929
wget https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/download/1.0.0/aws-advanced-jdbc-wrapper-1.0.0.jar
3030
```
3131

32-
Then, the following command adds the JDBC wrapper to the CLASSPATH:
32+
Then, the following command adds the AWS JDBC Driver to the CLASSPATH:
3333

3434
```bash
3535
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-1.0.0.jar
3636
```
3737

3838
### As a Maven Dependency
3939

40-
You can use [Maven's dependency management](https://search.maven.org/search?q=g:software.amazon.jdbc) to obtain the JDBC Wrapper by adding the following configuration to the application's Project Object Model (POM) file:
40+
You can use [Maven's dependency management](https://search.maven.org/search?q=g:software.amazon.jdbc) to obtain the AWS JDBC Driver by adding the following configuration to the application's Project Object Model (POM) file:
4141

4242
```xml
4343
<dependencies>
@@ -51,7 +51,7 @@ You can use [Maven's dependency management](https://search.maven.org/search?q=g:
5151

5252
### As a Gradle Dependency
5353

54-
You can use [Gradle's dependency management](https://search.maven.org/search?q=g:software.amazon.jdbc) to obtain the JDBC Wrapper by adding the following configuration to the application's ```build.gradle``` file:
54+
You can use [Gradle's dependency management](https://search.maven.org/search?q=g:software.amazon.jdbc) to obtain the AWS JDBC Driver by adding the following configuration to the application's ```build.gradle``` file:
5555

5656
```gradle
5757
dependencies {
@@ -67,6 +67,6 @@ dependencies {
6767
}
6868
```
6969

70-
## Using the AWS Advanced JDBC Wrapper
70+
## Using the AWS Advanced JDBC Driver
7171

72-
For more detailed information about how to use and configure the JDBC Wrapper, please visit [this page](./using-the-jdbc-wrapper/UsingTheJdbcWrapper.md).
72+
For more detailed information about how to use and configure the AWS JDBC Driver, please visit [this page](using-the-jdbc-driver/UsingTheJdbcDriver.md).

docs/development-guide/Architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<div style="center"><img src="../images/plugin_manager.png" alt="diagram on how plugin manager is integrated with the user application"/></div>
44

5-
The AWS Advanced JDBC Wrapper contains 5 main components:
5+
The AWS Advanced JDBC Driver contains 5 main components:
66

77
1. The wrapper classes
88
2. The [connection plugin manager](./PluginManager.md)

0 commit comments

Comments
 (0)