Skip to content

Commit

Permalink
Update repository references. (#56)
Browse files Browse the repository at this point in the history
* Update repository references.

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

* Remove temporary file.

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

* Typo fix.

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

* Minor readme grooming.

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

* Update download information.

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
  • Loading branch information
Yury-Fridlyand authored Jan 23, 2023
1 parent f7fe290 commit 594d2f4
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 55 deletions.
9 changes: 3 additions & 6 deletions .github/workflows/sql-jdbc-test-and-build-workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,9 @@ jobs:
strategy:
matrix:
entry:
- { os: ubuntu-latest, java: 11 }
- { os: windows-latest, java: 11, os_build_args: -x compileJdbc -x jacocoTestReport}
- { os: macos-latest, java: 11, os_build_args: -x compileJdbc -x jacocoTestReport }
- { os: ubuntu-latest, java: 17 }
- { os: windows-latest, java: 17, os_build_args: -x compileJdbc -x jacocoTestReport}
- { os: macos-latest, java: 17, os_build_args: -x compileJdbc -x jacocoTestReport }
- { os: ubuntu-latest }
- { os: windows-latest, os_build_args: -x compileJdbc -x jacocoTestReport}
- { os: macos-latest, os_build_args: -x compileJdbc -x jacocoTestReport }
java:
- 11
- 17
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check [existing open](https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3AJDBC), or [recently closed](https://github.com/opensearch-project/sql/issues?q=is%3Aissue+is%3Aclosed+label%3AJDBC), issues to make sure somebody else hasn't already
When filing an issue, please check [existing open](https://github.com/opensearch-project/sql-jdbc/issues?q=is%3Aopen+is%3Aissue), or [recently closed](https://github.com/opensearch-project/sql-jdbc/issues?q=is%3Aissue+is%3Aclosed), issues to make sure somebody else hasn't already
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

* A reproducible test case or series of steps
Expand Down Expand Up @@ -84,7 +84,7 @@ GitHub provides additional document on [forking a repository](https://help.githu


## Finding contributions to work on
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/opensearch-project/sql/issues?q=is%3Aopen+label%3A%22help+wanted%22+label%3AJDBC) issues is a great place to start.
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/opensearch-project/sql-jdbc/issues?q=is%3Aopen+label%3A%22help+wanted%22) issues is a great place to start.


## Code of Conduct
Expand Down
50 changes: 23 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,20 @@ This is the driver for JDBC connectivity to a cluster running with OpenSearch SQ
| ----- | ----------------------------------------------- |
| Build | [![JDBC CI][jdbc-build-badge]][jdbc-build-link] |

[jdbc-build-badge]: https://github.com/opensearch-project/sql/actions/workflows/sql-jdbc-test-and-build-workflow.yml/badge.svg
[jdbc-build-link]: https://github.com/opensearch-project/sql/actions/workflows/sql-jdbc-test-and-build-workflow.yml
[jdbc-build-badge]: https://github.com/opensearch-project/sql-jdbc/actions/workflows/sql-jdbc-test-and-build-workflow.yml/badge.svg
[jdbc-build-link]: https://github.com/opensearch-project/sql-jdbc/actions/workflows/sql-jdbc-test-and-build-workflow.yml

## Specifications

The driver is compatible with JDBC 4.2 specification and requires a minimum of Java 8.

## BI Tool Connectors

* [Power BI Desktop](../bi-connectors/PowerBIConnector/README.md)
* [Tableau Desktop](../bi-connectors/TableauConnector/README.md)
* [Tableau Desktop](bi-connectors/TableauConnector/README.md)

## Download and Installation

The driver is available for download from [Artifacts page](https://opensearch.org/artifacts) on OpenSearch.org at the very bottom and from [automated CI workflow](https://github.com/opensearch-project/sql/actions/workflows/sql-jdbc-test-and-build-workflow.yml).
The driver is available for download from [Maven](https://repo1.maven.org/maven2/org/opensearch/driver/opensearch-sql-jdbc/), from [Artifacts page](https://opensearch.org/artifacts) on OpenSearch.org at the very bottom and from [automated CI workflow](https://github.com/opensearch-project/sql-jdbc/actions/workflows/sql-jdbc-test-and-build-workflow.yml).

## Using the driver

Expand Down Expand Up @@ -102,7 +101,7 @@ Code samples to open a connection for some typical scenarios are given below:

* Connect to localhost on port 9200 with no authentication over a plain connection

```
```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
Expand All @@ -121,7 +120,7 @@ con.close();

* Connect to a remote host on default SSL port with no authentication

```
```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
Expand All @@ -140,7 +139,7 @@ con.close();

or,

```
```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
Expand All @@ -162,7 +161,7 @@ con.close();

* Connect to a remote host with HTTP Basic authentication over an SSL/TLS connection on the default SSL/TLS port. Note - if a username and password are provided and `auth` property is not provided, basic auth is implicitly used.

```
```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
Expand All @@ -183,7 +182,7 @@ con.close();

or,

```
```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
Expand All @@ -207,7 +206,7 @@ con.close();

* Connect to a remote host with HTTP Basic authentication over an SSL/TLS connection, allowing any self-signed certificate and optionally turning off hostname verification. This may be useful for a dev/test setup.

```
```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
Expand Down Expand Up @@ -236,8 +235,7 @@ con.close();

* Connect to a remote host on default SSL port with AWS Sig V4 authentication. The driver will determine the credentials used to sign the request just like the standard aws-sdk i.e. in standard directories, environment variables etc.


```
```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
Expand All @@ -253,9 +251,10 @@ Statement st = con.createStatement();
// close connection
con.close();
```

or,

```
```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
Expand All @@ -277,7 +276,7 @@ con.close();

* Connect to a remote host on default SSL port with AWS Sig V4 authentication, explicitly specifying the AWSCredentialProvider to use

```
```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
Expand All @@ -299,7 +298,7 @@ con.close();

* Connect to a remote host on default SSL port with AWS Sig V4 authentication, explicitly specifying the region to use in the request signing.

```
```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
Expand All @@ -318,7 +317,7 @@ con.close();

or,

```
```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
Expand All @@ -345,7 +344,7 @@ The driver also provides a javax.sql.DataSource implementation via the `org.open

* Connect to localhost on port 9200 with no authentication over a plain connection

```
```java
import java.sql.Connection;
import java.sql.Statement;
import javax.sql.DataSource;
Expand All @@ -370,7 +369,7 @@ con.close();

* Connect to a remote host on default SSL port with no authentication

```
```java
import java.sql.Connection;
import java.sql.Statement;
import javax.sql.DataSource;
Expand All @@ -395,7 +394,7 @@ con.close();

* Connect to a remote host with HTTP Basic authentication over an SSL/TLS connection on the default SSL/TLS port.

```
```java
import java.sql.Connection;
import java.sql.Statement;
import javax.sql.DataSource;
Expand All @@ -420,8 +419,7 @@ con.close();

* Connect to a remote host on default SSL port with AWS Sig V4 authentication. The driver will determine the credentials used to sign the request just like the standard aws-sdk i.e. in standard directories, environment variables etc.


```
```java
import java.sql.Connection;
import java.sql.Statement;
import javax.sql.DataSource;
Expand All @@ -446,7 +444,7 @@ con.close();

* Connect to a remote host on default SSL port with AWS Sig V4 authentication, explicitly specifying the AWSCredentialProvider to use

```
```java
import java.sql.Connection;
import java.sql.Statement;
import javax.sql.DataSource;
Expand All @@ -472,7 +470,7 @@ con.close();

* Connect to a remote host on default SSL port with AWS Sig V4 authentication, explicitly specifying the region to use in the request signing.

```
```java
import java.sql.Connection;
import java.sql.Statement;
import javax.sql.DataSource;
Expand Down Expand Up @@ -519,18 +517,16 @@ The driver is built as a shadow jar so that its dependencies are bundled within

## Documentation

Please refer to the [documentation](https://docs-beta.opensearch.org/) for detailed information on installing and configuring opendistro-elasticsearch-security plugin.
Please refer to the [documentation](https://opensearch.org/docs/latest/) for detailed information on installing and configuring OpenSearch.

## Code of Conduct

This project has adopted an [Open Source Code of Conduct](CODE_OF_CONDUCT.md).


## Security issue notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.


## Licensing

See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
Expand Down
5 changes: 0 additions & 5 deletions TODOs.txt

This file was deleted.

8 changes: 4 additions & 4 deletions bi-connectors/TableauConnector/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
## Connector Download

The Tableau connector is available to download from the automated CI workflow: [link](https://github.com/opensearch-project/sql/actions/workflows/bi-connectors.yml).
The Tableau connector is available to download from the automated CI workflow: [link](https://github.com/opensearch-project/sql-jdbc/actions/workflows/bi-connectors.yml).
The release snapshot is also available [here](opensearch_sql_jdbc.taco).

## Connector Install

1. Put connector `taco` file into
* Windows: `C:\Users\%USERNAME%\Documents\My Tableau Repository\Connectors`;
* MacOS: `~/Documents/My Tableau Repository/Connectors`.
2. Put OpenSearch `JDBC` [driver](../../sql-jdbc/README.md) (`jar` file) into
1. Put OpenSearch `JDBC` [driver](../../README.md) (`jar` file) into
* Windows: `C:\Program Files\Tableau\Drivers`;
* MacOS: `~/Library/Tableau/Drivers`.
3. Run `Tableau Desktop` with command line flag `-DDisableVerifyConnectorPluginSignature=true`:
1. Run `Tableau Desktop` with command line flag `-DDisableVerifyConnectorPluginSignature=true`:
* Windows: `"C:\Program Files\Tableau\Tableau 2022.1\bin\tableau.exe" -DDisableVerifyConnectorPluginSignature=true`;
* MacOS: `open -n /Applications/Tableau\ Desktop\ 2022.1.app --args -DDisableVerifyConnectorPluginSignature=true`.
Adjust the command line accoring to the Tableau version you have. You can create a shortcut or a script to simplify this step.
Expand All @@ -29,4 +29,4 @@ Test pass rate is 669/837 (80%).
## See also

* [Connector user manual for Tableau Desktop](tableau_support.md)
* JDBC Driver user manual [describes](../../sql-jdbc/docs/tableau.md) how to use the `JDBC` driver without the connector
* JDBC Driver user manual [describes](../../docs/tableau.md) how to use the `JDBC` driver without the connector
20 changes: 10 additions & 10 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -138,12 +138,12 @@ publishing {
pom {
name = "OpenSearch SQL JDBC Driver"
packaging = "jar"
url = "https://github.com/opensearch-project/sql/sql-jdbc"
url = "https://github.com/opensearch-project/sql-jdbc"
description = "OpenSearch SQL JDBC driver"
scm {
connection = "scm:git@github.com:opensearch-project/sql.git"
developerConnection = "scm:git@github.com:opensearch-project/sql.git"
url = "git@github.com:opensearch-project/sql.git"
connection = "scm:git@github.com:opensearch-project/sql-jdbc.git"
developerConnection = "scm:git@github.com:opensearch-project/sql-jdbc.git"
url = "git@github.com:opensearch-project/sql-jdbc.git"
}
licenses {
license {
Expand All @@ -154,7 +154,7 @@ publishing {
developers {
developer {
name = 'OpenSearch'
url = 'https://github.com/opensearch-project/sql'
url = 'https://github.com/opensearch-project/sql-jdbc'
}
}
}
Expand All @@ -167,12 +167,12 @@ publishing {
pom {
name = "OpenSearch SQL JDBC Driver"
packaging = "jar"
url = "https://github.com/opensearch-project/sql/sql-jdbc"
url = "https://github.com/opensearch-project/sql-jdbc"
description = "OpenSearch SQL JDBC driver"
scm {
connection = "scm:git@github.com:opensearch-project/sql.git"
developerConnection = "scm:git@github.com:opensearch-project/sql.git"
url = "git@github.com:opensearch-project/sql.git"
connection = "scm:git@github.com:opensearch-project/sql-jdbc.git"
developerConnection = "scm:git@github.com:opensearch-project/sql-jdbc.git"
url = "git@github.com:opensearch-project/sql-jdbc.git"
}
licenses {
license {
Expand All @@ -183,7 +183,7 @@ publishing {
developers {
developer {
name = 'OpenSearch'
url = 'https://github.com/opensearch-project/sql'
url = 'https://github.com/opensearch-project/sql-jdbc'
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion docs/tableau.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

* Download and install [Tableau Desktop](https://www.tableau.com/en-ca/products/desktop/download).
* Install and configure [OpenSearch](https://docs-beta.opensearch.org/opensearch/install/index/).
* Download the [OpenSearch JDBC Driver](https://github.com/opensearch-project/sql/blob/main/sql-jdbc/README.md#download-and-installation).
* Download the [OpenSearch JDBC Driver](../README.md#download-and-installation).

## Setup

Expand Down

0 comments on commit 594d2f4

Please sign in to comment.