Skip to content

Commit 623498c

Browse files
committed
docs: replace references to AWS Advanced JDBC Driver to AWS Advanced JDBC Wrapper for consistency
1 parent 5d1e733 commit 623498c

File tree

22 files changed

+103
-103
lines changed

22 files changed

+103
-103
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ body:
6969
- type: input
7070
id: driver-version
7171
attributes:
72-
label: The AWS Advanced JDBC Driver version used
72+
label: The AWS Advanced JDBC Wrapper version used
7373
validations:
7474
required: true
7575
- type: input

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ body:
4848
- type: input
4949
id: driver-version
5050
attributes:
51-
label: The AWS Advanced JDBC Driver version used
51+
label: The AWS Advanced JDBC Wrapper version used
5252
validations:
5353
required: true
5454

.github/workflows/release_draft.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ jobs:
5858
uses: ncipollo/release-action@v1
5959
with:
6060
draft: true
61-
name: "AWS Advanced JDBC Driver - v${{ env.RELEASE_VERSION }}"
61+
name: "AWS Advanced JDBC Wrapper - v${{ env.RELEASE_VERSION }}"
6262
bodyFile: RELEASE_DETAILS.md
6363
artifacts: ./wrapper/build/libs/*
6464
token: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
293293
### :magic_wand: Added
294294
- Documentation:
295295
- [Read Write Splitting Plugin Limitations with Spring Boot/Framework](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md#limitations-when-using-spring-bootframework).
296-
- AWS Profile configuration parameter. See [README](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/README.md#properties), [UsingTheJDBCDriver](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#aws-advanced-jdbc-driver-parameters), and [AwsCredentialsConfiguration](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/custom-configuration/AwsCredentialsConfiguration.md).
296+
- AWS Profile configuration parameter. See [README](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/README.md#properties), [UsingTheJDBCDriver](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#aws-advanced-jdbc-wrapper-parameters), and [AwsCredentialsConfiguration](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/custom-configuration/AwsCredentialsConfiguration.md).
297297
- Example code for ReadWriteSplitting Plugin ([PR #765](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/765)).
298298
- Enabling AWS Profile for IAM and AWS Secrets Manager authentication plugins ([PR #786](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/786)).
299299

@@ -426,7 +426,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
426426
- [Target driver dialects](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/TargetDriverDialects.md) ([PR #452](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/452)).
427427
- Elastic Load Balancer URL support ([PR #476](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/476)).
428428
- Documentation:
429-
- Using the Driver with plain RDS Databases. See [Using the Driver](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#using-the-aws-jdbc-driver-with-plain-rds-databases).
429+
- Using the Driver with plain RDS Databases. See [Using the Driver](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#using-the-aws-advanced-jdbc-wrapper-with-plain-rds-databases).
430430
- Internal connection pool behaviour only verifying password on initial connection. See [Using the Read Write Splitting Plugin Internal Connection Pooling document](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md#internal-connection-pooling) and [code example](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/examples/AWSDriverExample/src/main/java/software/amazon/InternalConnectionPoolPasswordWarning.java).
431431
- Link performance test in table of contents. See [Documentation Table of Contents](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/Documentation.md).
432432
- Cluster URLs are not internally pooled. See [Using Read Write Splitting Plugin Internal Connection Pooling](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md#internal-connection-pooling).

README.md

Lines changed: 47 additions & 47 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
@@ -5,7 +5,7 @@
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)
8-
- [JDBC Wrapper Parameters](./using-the-jdbc-driver/UsingTheJdbcDriver.md#aws-advanced-jdbc-driver-parameters)
8+
- [JDBC Wrapper Parameters](./using-the-jdbc-driver/UsingTheJdbcDriver.md#aws-advanced-jdbc-wrapper-parameters)
99
- [Database Dialects](./using-the-jdbc-driver/DatabaseDialects.md)
1010
- [Target Driver Dialects](./using-the-jdbc-driver/TargetDriverDialects.md)
1111
- [Plugins](./using-the-jdbc-driver/UsingTheJdbcDriver.md#plugins)
@@ -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 Advanced JDBC Wrapper](./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-wrapper)
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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
## Minimum Requirements
44

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

77
- Amazon Corretto 8+ or Java 8+.
8-
- The AWS Advanced JDBC Driver.
8+
- The AWS Advanced JDBC Wrapper.
99
- Your choice of underlying JDBC driver.
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).

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 Driver contains 5 main components:
5+
The AWS Advanced JDBC Wrapper contains 5 main components:
66

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

docs/development-guide/DevelopmentGuide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ git clone https://github.com/aws/aws-advanced-jdbc-wrapper.git
1111

1212
You can now make changes in the repository.
1313

14-
### Building the AWS Advanced JDBC Driver
14+
### Building the AWS Advanced JDBC Wrapper
1515
Navigate to project root:
1616
```bash
1717
cd aws-advanced-jdbc-wrapper
1818
```
19-
To build the AWS Advanced JDBC Driver without running the tests:
19+
To build the AWS Advanced JDBC Wrapper without running the tests:
2020
Mac:
2121

2222
```bash
@@ -158,4 +158,4 @@ For more information on how to run the integration tests, please visit [Integrat
158158
[Connection Test Sample Code](./../../examples/AWSDriverExample/src/main/java/software/amazon/PgConnectionSample.java)
159159

160160
## Architecture
161-
For more information on how the AWS Advanced JDBC Driver functions and how it is structured, please visit [Architecture](./Architecture.md).
161+
For more information on how the AWS Advanced JDBC Wrapper functions and how it is structured, please visit [Architecture](./Architecture.md).

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Database Dialects
22

33
## What are database dialects?
4-
The AWS Advanced JDBC Driver is a wrapper that requires an underlying driver, and it is meant to be compatible with any JDBC driver. Database dialects help the AWS Advanced JDBC Wrapper determine what kind of underlying database is being used. To function correctly, the AWS Advanced JDBC Wrapper requires details unique to specific databases such as the default port number or the method to get the current host from the database. These details can be defined and provided to the AWS Advanced JDBC Wrapper by using database dialects.
4+
The AWS Advanced JDBC Wrapper is a wrapper that requires an underlying driver, and it is meant to be compatible with any JDBC driver. Database dialects help the AWS Advanced JDBC Wrapper determine what kind of underlying database is being used. To function correctly, the AWS Advanced JDBC Wrapper requires details unique to specific databases such as the default port number or the method to get the current host from the database. These details can be defined and provided to the AWS Advanced JDBC Wrapper by using database dialects.
55

66
## Configuration Parameters
77
| Name | Required | Description | Example |

0 commit comments

Comments
 (0)