Skip to content

Commit

Permalink
Add changelog, improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kaklakariada committed Oct 22, 2021
1 parent ac3afbe commit 45de930
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 1 deletion.
1 change: 1 addition & 0 deletions doc/changes/changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Changes

* [0.2.0](changes_0.2.0.md)
* [0.1.0](changes_0.1.0.md)
13 changes: 13 additions & 0 deletions doc/changes/changes_0.2.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Exasol Tableau Connector 0.2.0, released 2021-10-??

Code name: JDBC Connector

## Summary

Version 0.2.0 of the Tableau Connector adds a JDBC connector that offers an option for certificate validation and allows entering a certificate fingerprint.

The new release also fixes an issue with the ODBC connector that caused all strings being trimmed by removing capabilities `CAP_ODBC_TRIM_NO_EMPTY_STRING` and `CAP_ODBC_TRIM_VARCHAR_PADDING`. We also fixed some failing TDVT tests for the ODBC connector and improved the documentation for developers.

## Features

* #22: Add JDBC connector
26 changes: 25 additions & 1 deletion doc/developer_guide/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This developer guide describes how to

## Manually Testing Connectors

To manually test the connectors in Tableau Desktop add the following arguments when starting `tableau.exe`:
To manually test the connectors in Tableau Desktop without packaging, add the following arguments when starting `tableau.exe`:

* `-DConnectPluginsPath=path\to\tableau-connector\src`: Path to the `src` directory of this cloned repository.
* `-DLogLevel=Debug`: enable log output of `logging.Log()` in JavaScript files.
Expand All @@ -23,6 +23,28 @@ In the left bar under "To a Server" click `More...`, then click `Exasol JDBC by

Restart Tableau after modifying any connector file to reload changes.

## Packaging the Connectors

This requires `python3-venv` to be installed.

To package the JDBC and ODBC connectors, execute

```sh
cd tableau-server-GUI-tests
./set_up_scripts/package_connector.sh
```

This validates the connectors and creates the connectors at

```
tableau-server-GUI-tests/target/exasol_jdbc.taco
tableau-server-GUI-tests/target/exasol_odbc.taco
```

To use the connectors, copy them to `C:\Program Files\Tableau\Connectors`.

As the connectors are not signed, you need to start Tableau Desktop with argument `-DDisableVerifyConnectorPluginSignature`.

## Running TDVT Tests

You can run TDVT tests under Windows and macOS. This guide describes the setup for Windows. The setup for macOS is similar.
Expand Down Expand Up @@ -126,6 +148,8 @@ You can either run the tests completely on the remote machine or start them on y
#### Start tests on remote machine
This assumes you are using an AWS instance running Amazon Linux 2.
1. Setup the instance with a UI as described [here](https://aws.amazon.com/premiumsupport/knowledge-center/ec2-linux-2-install-gui/).
2. Install a Chrome browser as this will be used for running the UI tests.
3. Install Java 11 (`yum install java-11-amazon-corretto`) and the latest Maven version.
Expand Down
2 changes: 2 additions & 0 deletions doc/user_guide/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ If you want to use the currently developed version of connector, you can follow
* Mac: `~/Library/Tableau/Drivers`
* Linux: `/opt/tableau/tableau_driver/jdbc`

**Important note for Windows:** Make sure to download and install file `EXASOL_JDBC-<version>.msi`. The JDBC driver will be installed to `C:\Program Files\Exasol\EXASolution-7.1\JDBC\exajdbc.jar`. Only the JDBC driver for Windows supports Kerberos under Windows.

### With Tableau Desktop

* Clone the Tableau-Connector repository. You can execute the following command from [Git Bash](https://gitforwindows.org/) terminal:
Expand Down

0 comments on commit 45de930

Please sign in to comment.