diff --git a/.github/workflows/sql-jdbc-test-and-build-workflow.yml b/.github/workflows/sql-jdbc-test-and-build-workflow.yml index 8117f82..1423950 100644 --- a/.github/workflows/sql-jdbc-test-and-build-workflow.yml +++ b/.github/workflows/sql-jdbc-test-and-build-workflow.yml @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 808779a..71d3c9c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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 diff --git a/README.md b/README.md index cffa4ed..8ec2ce9 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,8 @@ 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 @@ -18,12 +18,11 @@ The driver is compatible with JDBC 4.2 specification and requires a minimum of J ## 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 [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 @@ -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; @@ -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; @@ -140,7 +139,7 @@ con.close(); or, -``` +```java import java.sql.Connection; import java.sql.DriverManager; import java.sql.Statement; @@ -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; @@ -183,7 +182,7 @@ con.close(); or, -``` +```java import java.sql.Connection; import java.sql.DriverManager; import java.sql.Statement; @@ -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; @@ -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; @@ -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; @@ -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; @@ -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; @@ -318,7 +317,7 @@ con.close(); or, -``` +```java import java.sql.Connection; import java.sql.DriverManager; import java.sql.Statement; @@ -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; @@ -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; @@ -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; @@ -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; @@ -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; @@ -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; @@ -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. diff --git a/TODOs.txt b/TODOs.txt deleted file mode 100644 index 9087bc7..0000000 --- a/TODOs.txt +++ /dev/null @@ -1,5 +0,0 @@ -add maven jdbc publish workflow: - https://github.com/opensearch-project/sql/pull/957 - https://github.com/opensearch-project/opensearch-build/issues/2505 - https://github.com/opensearch-project/opensearch-build/issues/2692 - diff --git a/bi-connectors/TableauConnector/README.md b/bi-connectors/TableauConnector/README.md index 71c3d20..5fee0dd 100644 --- a/bi-connectors/TableauConnector/README.md +++ b/bi-connectors/TableauConnector/README.md @@ -1,6 +1,6 @@ ## 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 @@ -8,10 +8,10 @@ The release snapshot is also available [here](opensearch_sql_jdbc.taco). 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. @@ -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 \ No newline at end of file +* JDBC Driver user manual [describes](../../docs/tableau.md) how to use the `JDBC` driver without the connector diff --git a/build.gradle b/build.gradle index dba2ea8..9509cbc 100644 --- a/build.gradle +++ b/build.gradle @@ -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 { @@ -154,7 +154,7 @@ publishing { developers { developer { name = 'OpenSearch' - url = 'https://github.com/opensearch-project/sql' + url = 'https://github.com/opensearch-project/sql-jdbc' } } } @@ -165,12 +165,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 { @@ -181,7 +181,7 @@ publishing { developers { developer { name = 'OpenSearch' - url = 'https://github.com/opensearch-project/sql' + url = 'https://github.com/opensearch-project/sql-jdbc' } } } diff --git a/docs/tableau.md b/docs/tableau.md index 0bf2de8..baa53ec 100644 --- a/docs/tableau.md +++ b/docs/tableau.md @@ -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 diff --git a/jenkins/jdbc-stage-maven-release.jenkinsfile b/jenkins/jdbc-stage-maven-release.jenkinsfile index 2b0d6c0..5da32e9 100644 --- a/jenkins/jdbc-stage-maven-release.jenkinsfile +++ b/jenkins/jdbc-stage-maven-release.jenkinsfile @@ -31,7 +31,7 @@ pipeline { [key: 'VERSION', value: '$.ref', regexpFilter: 'refs/tags/v' ], ], tokenCredentialId: 'jenkins-sql-jdbc-generic-webhook-token', - causeString: 'A tag was cut on opensearch-project/sql repository causing this workflow to run', + causeString: 'A tag was cut on opensearch-project/sql-jdbc repository causing this workflow to run', printContributedVariables: false, printPostContent: false, regexpFilterText: '$ref', @@ -46,14 +46,12 @@ pipeline { steps { // checkout the commit checkout([ - $class: 'GitSCM', userRemoteConfigs: [[url: 'https://github.com/opensearch-project/sql.git']], + $class: 'GitSCM', userRemoteConfigs: [[url: 'https://github.com/opensearch-project/sql-jdbc.git']], branches: [[name: "$ref"]] ]) - dir('sql-jdbc') { - // publish maven artifacts - sh('./gradlew --no-daemon publishPublishMavenPublicationToLocalRepoRepository') - } + // publish maven artifacts + sh('./gradlew --no-daemon publishPublishMavenPublicationToLocalRepoRepository') } } stage('Sign') {