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

[Posted] INTERNAL PR - BI tools documentation (excluding MicroStrategy) #8

Closed
wants to merge 14 commits into from

Conversation

alinaliBQ
Copy link

@alinaliBQ alinaliBQ commented Dec 15, 2022

Add documentation for driver set up with BI tools

Description

  • add documentation for driver set up with Aqua Data Studio, DBeaver, DbVisualizer, SQuirreL, and Tableau
    • the documentation is based on the driver with changes from PR#22
  • updated README to link the set up documentation
  • note that documentation for driver set up with MicroStrategy will be in a separate PR.

Additional Reviewers
@affonsoBQ
@alexey-temnikov
@alinaliBQ
@andiem-bq
@birschick-bq
@mitchell-elholm
@RoyZhang2022

@alinaliBQ alinaliBQ changed the title [AT-1024] documentation PR [AT-1024] INTERNAL PR - BI tools documentation (excluding MicroStrategy) Dec 15, 2022
alinaliBQ and others added 3 commits December 15, 2022 12:29
* [AT-1174] Aqua Data studio set up documentation

* Update aqua-data-studio-sign-in.png

* Apply suggestions from code review

Co-authored-by: andiem-bq <[email protected]>

* add image for server browser and refactor documentation

* Update aqua-data-studio-setup.md

* Update aqua-data-studio-setup.md

Co-authored-by: andiem-bq <[email protected]>
* [AT-1177] Add documentation for driver set up with Tableau

* [AT-1177] fix typo in file name for README

* [AT-1177] remove steps to add jdbc-timestream.tdc

reason: `jdbc-timestream.tdc` is not needed for JDBC driver to function

* [AT-1177] update readme for Tableau documentation

* Update markdown/setup/tableau-desktop-driver-setup.md


* [AT-1177] add instructions for adding connection properties

* Update README.md

Co-authored-by: Alexey Temnikov <[email protected]>

* add known limitations

Co-authored-by: Alexey Temnikov <[email protected]>
@@ -0,0 +1,52 @@
### DBeaver
Copy link
Author

@alinaliBQ alinaliBQ Dec 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that for DBeaver, there was no limitations found during the manual test

@@ -15,6 +15,15 @@ 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.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To fellow code reviewers: for this PR, the files to focus on are the markdown files (README and set up files), please check if they load images properly and the links work. This is optional since they are already checked in separate PRs. Thank you!

alinaliBQ and others added 2 commits December 15, 2022 14:14
* Add documentation for driver set up with DbVisualizer

* format adjust

* document refine

* rework based on comments

* file name change

* modify README

* rework based on comments

* syntax change

* Update dbvisualizer-driver-setup.md

Co-authored-by: RoyZhang2022 <[email protected]>
* Add documentation for driver set up with SQuirreL

* adjust pictures position

* pictures position adjustment

* rework based on comments

* rework

* rework based on comments

Co-authored-by: RoyZhang2022 <[email protected]>
@alinaliBQ alinaliBQ marked this pull request as ready for review December 15, 2022 22:16
@alinaliBQ alinaliBQ changed the title [AT-1024] INTERNAL PR - BI tools documentation (excluding MicroStrategy) [AT-1204] INTERNAL PR - BI tools documentation (excluding MicroStrategy) Dec 15, 2022
@alinaliBQ alinaliBQ changed the title [AT-1204] INTERNAL PR - BI tools documentation (excluding MicroStrategy) [Posted] INTERNAL PR - BI tools documentation (excluding MicroStrategy) Dec 16, 2022
@alinaliBQ
Copy link
Author

closing this PR as relating AWS PRs are posted and merged.

@alinaliBQ alinaliBQ closed this Jan 26, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants