Skip to content
This repository has been archived by the owner on Dec 7, 2023. It is now read-only.

[AT-1171] Add documentation for driver set up with DbVisualizer #3

Closed
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ The Timestream JDBC driver is distributed as two JAR files.
### JAR With All Dependencies Shaded Except SLF4J (amazon-timestream-jdbc-\<version\>-jar-with-all-dependencies.jar)
This is the shaded JAR which bundles up all the required dependencies and can be used directly in Java projects and external applications, without explicitly adding external dependencies. This JAR does not relocate the classpath of SLF4J, allowing logging to be enabled in external applications.

- Instructions for using fully shaded JAR file with [DbVisualizer](markdown/setup/dbvisualizer-driver-setup.md)
RoyZhang2022 marked this conversation as resolved.
Show resolved Hide resolved

### JAR With No Dependencies (amazon-timestream-jdbc-\<version\>.jar)
This is the lightweight JAR which does not include any dependencies. This JAR could be used if the application developer does not want duplicate dependencies and want full control over their dependency tree.

Expand All @@ -31,7 +33,7 @@ To create a connection, construct a connection URL by appending optional connect
The default URL for Timestream is `jdbc:timestream`.

RoyZhang2022 marked this conversation as resolved.
Show resolved Hide resolved
### Constructing the Connection URL
Timestream supports optional connection properties that could be specified through the JDBC URL. To specify these optional properties use the following URL format: `jdbc:timestream://PropertyName1=value1;PropertyName2=value2...`.
Timestream supports optional connection properties that could be specified through the JDBC URL. To specify these optional properties use the following URL format: `jdbc:timestream://PropertyName1=value1;PropertyName2=value2...`. Note the property name is **case sensitive**.

An example of the JDBC URL with properties: `jdbc:timestream://AccessKeyId=myAccessKeyId;SecretAccessKey=mySecretAccessKey;SessionToken=mySessionToken;Region=myRegion`

Expand Down
Binary file added markdown/images/dbvisualizer/DbVisualizer1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added markdown/images/dbvisualizer/DbVisualizer2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added markdown/images/dbvisualizer/DbVisualizer3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added markdown/images/dbvisualizer/DbVisualizer4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added markdown/images/dbvisualizer/DbVisualizer5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions markdown/setup/dbvisualizer-driver-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
### DbVisualizer
[Link to product webpage](https://www.dbvis.com/download/).

#### Adding the Amazon Timestream JDBC Driver
1. [Download](https://github.com/awslabs/amazon-timestream-driver-jdbc/releases/latest) the Timestream JDBC driver shaded JAR file (e.g., `amazon-timestream-jdbc-2.0.0-shaded.jar`)
2. Start the DbVisualizer application and navigate to the menu path: **Tools > Driver Manager...**. In the popped up window, click the "Custom" link on the right side. Or find the **Custom** row on the left side and click it.

![Example](../images/dbvisualizer/DbVisualizer1.png)
RoyZhang2022 marked this conversation as resolved.
Show resolved Hide resolved

![Example](../images/dbvisualizer/DbVisualizer4.png)

3. In the new popped up window, find **Driver Settings** tab and fill the following info.

a. For the **Name:** field, enter **Timestream**

b. For the **URL Format:** field, enter ```jdbc:timestream://PropertyName1=value1;PropertyName2=value2...```. For a list of connection properties, see [README](../../README.md#optional-connection-properties).

c. Click the **+** on the right side to select the Timestream JDBC JAR file.

d. Ensure the ```software.amazon.timestream.jdbc.TimestreamDriver``` is selected in the **Driver Class:** field. Your Driver Manager settings for **Timestream** should look like the following image.

![Example](../images/dbvisualizer/DbVisualizer2.png)

e. Close the dialog. Now the Timestream JDBC driver is added and ready to use.

4. Connecting to Amazon Timestream Using DbVisualizer

a. Navigate the menu path **Database > Create Database Connection**

b. For the **Name** field, enter a descriptive name for the connection, for example ```TimestreamConnection```

c. For the **Driver Type** field, ensure the **Timesteam** is selected.

d. For the **Database URL** field, enter your [JDBC connection string](../../README.md#optional-connection-properties). For example, ```jdbc:timestream://Region=us-east-1;```
RoyZhang2022 marked this conversation as resolved.
Show resolved Hide resolved

e. For the **Database Userid** field, enter your Amazon Timestream user ID.

f. For the **Database Password** field, enter the corresponding password for the user ID.

g. Your **Database Connection** dialog should look like the following.

![Example](../images/dbvisualizer/DbVisualizer3.png)

h. Click **Connect** button to connect to Timestream. Then you could connect to the Timestream database. You should be able to see all databases on the left side under the connection name as the example below.

![Example](../images/dbvisualizer/DbVisualizer5.png)
RoyZhang2022 marked this conversation as resolved.
Show resolved Hide resolved