Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update BI connectors and drivers readme files #665

Merged
merged 11 commits into from
Jul 19, 2022

Conversation

Yury-Fridlyand
Copy link
Collaborator

Description

Signed-off-by: Yury Fridlyand yuryf@bitquilltech.com

  • Update readmes
  • Add connectors' binaries
  • Add connectors' download links
  • Add and update connectors' installation and usage instructions
  • Update screenshots to remove ODFE references
  • Add drivers' download links
  • Reorganize connectors' file tree
  • Update GHA workflow

Issues Resolved

Fixes:
#605
#607
#629
#439
#340
#246
#257

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Yury-Fridlyand and others added 8 commits June 23, 2022 17:04
… links. Add BI connectors binaries.

Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
Update BI connectors and drivers readme files
@Yury-Fridlyand Yury-Fridlyand requested a review from a team as a code owner June 28, 2022 21:08
@codecov-commenter
Copy link

codecov-commenter commented Jun 28, 2022

Codecov Report

Merging #665 (2bcc1d4) into main (e180d56) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main     #665   +/-   ##
=========================================
  Coverage     94.70%   94.70%           
  Complexity     2825     2825           
=========================================
  Files           282      282           
  Lines          7609     7609           
  Branches        558      558           
=========================================
  Hits           7206     7206           
  Misses          349      349           
  Partials         54       54           
Flag Coverage Δ
query-workbench 62.76% <ø> (ø)
sql-engine 97.72% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e180d56...2bcc1d4. Read the comment docs.

Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
joshuali925
joshuali925 previously approved these changes Jul 11, 2022
Copy link
Member

@joshuali925 joshuali925 left a comment

Choose a reason for hiding this comment

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

thanks


<img src="img/tableau_select_connector.png" width=600>

* Enter **Server** & **Port** value.
* Select required authentication option. For **AWS_SIGV4** authentication, select **Integrated Authentication** and enter value for **Region**. To setup aws access key id and secret key, create ~/.aws/credentials with [AWS CLI](https://aws.amazon.com/cli/) and use `opensearchodbc` as the profile name.
* Select required authentication option. For **AWS_SIGV4** authentication, select **AWS_SIGv4** and enter value for **Region**. You need to create `~/.aws/credentials` and add `default` profile with aws access key id and secret key.
Copy link
Member

Choose a reason for hiding this comment

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

question: would ODBC drivers use default or still opensearchodbc profile? if still opensearchodbc i think it's better to keep it documented somewhere

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good catch! ODBC driver still require opensearchodbc profile due to the bug, but Tableau uses JDBC driver which works with default profile. So there is no mistake.

Copy link
Member

Choose a reason for hiding this comment

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

right. after removing that information here, users won't be able to know that ODBC driver still require opensearchodbc because no other place mentions it

I'm saying should the information be documented somewhere else? maybe in https://github.com/opensearch-project/sql/blob/main/sql-odbc/docs/user/configuration_options.md

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

See 7694813.

Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants