Skip to content

Commit 4efe7d9

Browse files
authored
GitHub IO Page and README Clarifications (awslabs#26)
### Summary This PR creates our GitHub IO landing page and also corrects some typos in the README. ### Description - Adds GitHub IO Page. - Corrects typo in JDBC connection string sample. - Minor grammatical errors.
1 parent 0ba3ab1 commit 4efe7d9

10 files changed

+2059
-5
lines changed

README

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ The Amazon Web Services (AWS) JDBC Driver for PostgreSQL is a driver that enable
88

99
applications to take full advantage of the features of clustered PostgreSQL databases.
1010

11-
It is based on and can be used as a drop-in compatible for the PostgreSQL JDBC Driver
11+
It is drop-in compatible and based on the PostgreSQL JDBC Driver
1212

13-
(https://github.com/pgjdbc/pgjdbc) and is compatible with all PostgreSQL deployments.
13+
(https://github.com/pgjdbc/pgjdbc), and is compatible with all PostgreSQL deployments.
1414

1515

1616

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Javadoc](https://javadoc.io/badge2/software.aws.rds/aws-postgresql-jdbc/javadoc.svg)](https://javadoc.io/doc/software.aws.rds/aws-postgresql-jdbc)
66
[![License](https://img.shields.io/badge/License-BSD--2--Clause-blue.svg)](https://opensource.org/licenses/BSD-2-Clause)
77

8-
**The Amazon Web Services (AWS) JDBC Driver for PostgreSQL** is a driver that enables applications to take full advantage of the features of clustered PostgreSQL databases. It is based on and can be used as a drop-in compatible for the [PostgreSQL JDBC Driver](https://github.com/pgjdbc/pgjdbc) and is compatible with all PostgreSQL deployments.
8+
**The Amazon Web Services (AWS) JDBC Driver for PostgreSQL** is a driver that enables applications to take full advantage of the features of clustered PostgreSQL databases. It is drop-in compatible and based on the [PostgreSQL JDBC Driver](https://github.com/pgjdbc/pgjdbc), and is compatible with all PostgreSQL deployments.
99

1010
The AWS JDBC Driver for PostgreSQL currently enables fast failover for Amazon Aurora with PostgreSQL compatibility. Support for additional features of clustered databases, including features of Amazon RDS for PostgreSQL and on-premises PostgreSQL deployments, is planned.
1111

@@ -21,7 +21,7 @@ Although Aurora is able to provide maximum availability through the use of failo
2121

2222
## The AWS JDBC Driver Failover Process
2323

24-
<div style="text-align:center"><img src="./docs/img/failover_diagram.png" /></div>
24+
<div style="text-align:center"><img src="./docs/files/images/failover_diagram.png" /></div>
2525

2626
The figure above provides a simplified overview of how the AWS JDBC Driver handles an Aurora failover encounter. Starting at the top of the diagram, an application with the AWS JDBC Driver on its class path uses the driver to get a logical connection to an Aurora database. In this example, the application requests a connection using the Aurora DB cluster endpoint and is returned a logical connection that is physically connected to the primary DB instance in the DB cluster, DB instance C. Due to how the application operates against the logical connection, the physical connection details about which specific DB instance it is connected to have been abstracted away. Over the course of the application's lifetime, it executes various statements against the logical connection. If DB instance C is stable and active, these statements succeed and the application continues as normal. If DB instance C later experiences a failure, Aurora will initiate failover to promote a new primary DB instance. At the same time, the AWS JDBC Driver will intercept the related communication exception and kick off its own internal failover process. In this case, in which the primary DB instance has failed, the driver will use its internal topology cache to temporarily connect to an active Aurora Replica. This Aurora Replica will be periodically queried for the DB cluster topology until the new primary DB instance is identified (DB instance A or B in this case). At this point, the driver will connect to the new primary DB instance and return control to the application by raising a SQLException with SQLState 08S02 so that they can re-configure their session state as required. Although the DNS endpoint for the DB cluster might not yet resolve to the new primary DB instance, the driver has already discovered this new DB instance during its failover process and will be directly connected to it when the application continues executing statements. In this way the driver provides a faster way to reconnect to a newly promoted DB instance, thus increasing the availability of the DB cluster.
2727

@@ -82,7 +82,7 @@ Note: The connection string follows standard URL parameters. In order to add par
8282

8383
| URL Type | Example | Required Parameters | Driver Behavior |
8484
| ------------- |-------------| :-----:| --- |
85-
| Cluster Endpoint | `jdbc:postgreql:aws://db-identifier.cluster-XYZ.us-east-2.rds.amazonaws.com:5432` | None | *Initial connection:* primary DB instance<br/>*Failover behavior:* connect to the new primary DB instance |
85+
| Cluster Endpoint | `jdbc:postgresql:aws://db-identifier.cluster-XYZ.us-east-2.rds.amazonaws.com:5432` | None | *Initial connection:* primary DB instance<br/>*Failover behavior:* connect to the new primary DB instance |
8686
| Read-Only Cluster Endpoint | `jdbc:postgresql:aws://db-identifier.cluster-ro-XYZ.us-east-2.rds.amazonaws.com:5432` | None | *Initial connection:* any Aurora Replica<br/>*Failover behavior:* prioritize connecting to any active Aurora Replica but might connect to the primary DB instance if it provides a faster connection|
8787
| Instance Endpoint | `jdbc:postgresql:aws://instance-1.XYZ.us-east-2.rds.amazonaws.com:5432` | None | *Initial connection:* the instance specified (DB instance 1)<br/>*Failover behavior:* connect to the primary DB instance|
8888
| RDS Custom Cluster | `jdbc:postgresql:aws://db-identifier.cluster-custom-XYZ.us-east-2l.rds.amazonaws.com:5432` | None | *Initial connection:* any DB instance in the custom DB cluster<br/>*Failover behavior:* connect to the primary DB instance (note that this might be outside of the custom DB cluster) |

docs/files/images/icon.png

5.27 KB
Loading

docs/files/images/texture.png

18.8 KB
Loading

docs/files/jquery.min.js

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/files/masonry.pkgd.min.js

+9
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/files/scripts.js

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
$(document).ready(function(){
2+
3+
//[Anclas con animación - Global]
4+
$('a[href*="#"]:not([href="#"]):not([href="#skip"])').click(function(){
5+
if (location.pathname.replace(/^\//,'') == this.pathname.replace(/^\//,'') && location.hostname == this.hostname) {
6+
var target = $(this.hash);
7+
target = target.length ? target : $('[name=' + this.hash.slice(1) +']');
8+
9+
if (target.length && window.innerWidth > 900) {
10+
$('html, body').animate({
11+
scrollTop: (target.offset().top - 120)
12+
}, 1000);
13+
14+
return false;
15+
} else {
16+
$('html, body').animate({
17+
scrollTop: (target.offset().top - 100)
18+
}, 1000);
19+
20+
return false;
21+
}
22+
}
23+
});
24+
25+
//[Menu]
26+
if ( window.innerWidth > 900 ) {
27+
$('.mdl-header label').click(function(){
28+
$('body').toggleClass('over-hidden');
29+
});
30+
}
31+
32+
$('.mdl-header nav a').click(function(){
33+
$('.mdl-header label').click();
34+
});
35+
36+
//[Sticky Header]
37+
$(window).on('scroll', function() {
38+
var scrollPos = $(document).scrollTop();
39+
console.log(scrollPos);
40+
41+
if (window.innerWidth > 900) {
42+
if (scrollPos > 500){
43+
$('.sticky-header').slideDown(250, 'linear');
44+
} else {
45+
$('.sticky-header').slideUp(250, 'linear');
46+
}
47+
} else if (window.innerWidth < 900) {
48+
if (scrollPos > 450) {
49+
$('.sticky-header').slideDown(250, 'linear');
50+
} else {
51+
$('.sticky-header').slideUp(250, 'linear');
52+
}
53+
}
54+
});
55+
56+
//[Scroll to Top]
57+
$('.s-logo').click(function(){
58+
$('html, body').animate({ scrollTop: 0 }, 1000);
59+
return false;
60+
});
61+
62+
});
63+
64+
$(window).load(function(){
65+
$('.sta-masonry').each(function(){
66+
$(this).masonry();
67+
});
68+
});
69+

0 commit comments

Comments
 (0)