Merge pull request #129 from aws/lyndon/update-changelog-and-release-…

…version

Add CHANGELOG for release and update DBeaver markdown

CHANGELOG.md

@@ -1,3 +1,85 @@
-# Changelog
+# Amazon Neptune JDBC Driver Change Log
 
-Initial commit - TODO: Update when release
+## v1.2.0 Change Log
+
+`v1.2.0` of the **Amazon Neptune JDBC Driver** will build on `v1.1.0` but has not been started yet.
+
+## v1.1.0 Change Log
+
+`v1.1.0` of the **Amazon Neptune JDBC Driver** builds on `v1.0.0`. 
+
+This release provides bug fixes and a new features, details are listed below:
+
+### Bug Fixes
+* Fixed issue with `LIMIT 1` queries in DBVisualizer
+* Fixed results for `GROUP BY` and `WHERE` in aggregates
+* Fixed bugs in SSH tunnel
+* Fixed bug with `JOIN` on vertices of different labels
+* Fixed metadata caching to be on database url basis
+* Fixed Log4j security issue (CVE-2021-44228 and CVE-2021-45046)
+* Fixed issue with edge mismatch in `JOIN` returning results
+* Fixed `ORDER BY` column on column that has `null` values
+* Fixed issue with aggregate filtering on `null` valued columns
+* Fixed 'false positive' exception log produced on statement shutdown
+
+### New Features and Improvements
+* Removed Janino jar for revision control and update Calcite
+* Metadata overhaul
+  * Driver version
+  * getUrl
+  * getTypeInfo
+  * Removed incorrect catalog support
+  * Fixed incorrect values reported in metadata
+* Added Maven central hookup for Gradle publishing
+* Moved sql-gremlin errors to resources
+* Updated taco file to support SSH tunnel
+* Improved error messages in sql-gremlin
+* Added comparator support in SELECT clause
+* Updated dialect file for taco to remove `NULLS FIRST`/`LAST` in `ORDER BY`
+
+### Documentation Enhancements
+* Added documentation for DBeaver
+* Added documentation around schema collection
+* Enhanced documentation for JOIN queries
+* Added more connection string and ssh tunnel examples in documentation
+
+
+## v1.0.0 Change Log
+
+`v1.0.0` is the first official GA release of the **Amazon Neptune JDBC Driver**.
+
+This release includes a bunch of improvements and new features that are listed below:
+
+* Bug fixes and enhanced support for SQL to Gremlin conversion
+    * `HAVING` support
+    * `ORDER BY` using label
+    * `COUNT(*)` support
+    * Edge column retrieval
+    * Various other minor improvements
+* Tableau extract mode enabled
+* Tableau data preview enabled
+* `SERVICE_REGION` now supported as a connection property
+* Cut down the output size of the shadow jar
+* Fixes to enhance JDBC metadata
+* Enhanced documentation
+* Tableau connector updates to support SERVICE_REGION
+
+## v1.0.0-beta
+
+The Amazon Neptune JDBC Driver is a JDBC 4.2 compliant driver (Java 8), which provides read-only JDBC connectivity for the Amazon Neptune service using graph query languages Gremlin, openCypher and SPARQL, as well as SQL.
+
+When using SQL, the graph is represented in a table/columnar format and SQL queries can be executed. The driver supports a subset of SQL-92 along with some common extensions and supports SELECT statements of the general form:
+
+```
+SELECT [ DISTINCT ] { * | <projectItem> [, <projectItem> ]* }
+   FROM <tableExpression>
+   [ WHERE <booleanExpression> ]
+   [ GROUP BY { <column> [, <column> ]* } ]
+   [ ORDER BY { <column> [ DESC ] [, <column> [ DESC ] ]* } ]
+   [ LIMIT limitNumber ]
+
+projectItem:
+    [ agg ]* [ <table>. ]* <column> [ [ AS ] columnAlias ]
+```
+
+The driver can be used to integrate with BI tools that support JDBC Drivers. For Tableau Desktop users a connector is available to use.

gradle.properties

@@ -1,5 +1,5 @@
 MAJOR_VERSION=1
-MINOR_VERSION=0
+MINOR_VERSION=1
 PATCH_VERSION=0
 # Comment out if not creating a beta version
 # BETA_VERSION=1

markdown/bi-tools/DBeaver.md

@@ -10,7 +10,7 @@ Download the latest version of [DBeaver](https://dbeaver.io/) to use the Driver
 
 2. Launch the DBeaver application.
 
-3. Navigate to **Database > Driver Manager** and click **New** to add a new Driver. 
+3. Navigate to **Database > Driver Manager** and click **New** to add a new Driver.
 
 4. Under the `Libraries` tab, click **Add File** and add the `JAR` file. This should also automatically populate the `Driver class` in the dropdown menu.
 
@@ -48,9 +48,10 @@ DBeaver has the ability to configure the SSH tunnel within the application.
 2. Select the Neptune driver that was added in the previous steps.
 
 3. Navigate to the **SSH** tab and fill out the fields. Fill out the **HOST/IP**, **User Name**, and select **Public Key** as the **Authentication Method**. A **Private key** is required. The [configuration instructions](../setup/configuration.md) mentioned above can provide more context for why this is required.
+   Under **Advanced settings** the **Local host** and **Local port** if following the above instructions should be your localhost and the port used for Neptune. The **Remote host** and **Remote port** should be the Neptune URL and port.
 
    <p align="center">
    <img alt="driver" src="../images/dbeaver_ssh_tunnel.png" width="65%"/>
    </p>
 
-   4. Click `Test tunnel configuration` to validate the SSH tunnel, and then `Finish` to complete setup.
+   4. Click `Test tunnel configuration` to validate the SSH tunnel, and then `Finish` to complete setup.