Skip to content

Commit c809770

Browse files
Merge pull request #3 from Bit-Quill/dev-update-repo-links
Update repository references.
2 parents 0e8de37 + 95dc20f commit c809770

File tree

8 files changed

+47
-61
lines changed

8 files changed

+47
-61
lines changed

.github/workflows/sql-jdbc-test-and-build-workflow.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,9 @@ jobs:
1414
strategy:
1515
matrix:
1616
entry:
17-
- { os: ubuntu-latest, java: 11 }
18-
- { os: windows-latest, java: 11, os_build_args: -x compileJdbc -x jacocoTestReport}
19-
- { os: macos-latest, java: 11, os_build_args: -x compileJdbc -x jacocoTestReport }
20-
- { os: ubuntu-latest, java: 17 }
21-
- { os: windows-latest, java: 17, os_build_args: -x compileJdbc -x jacocoTestReport}
22-
- { os: macos-latest, java: 17, os_build_args: -x compileJdbc -x jacocoTestReport }
17+
- { os: ubuntu-latest }
18+
- { os: windows-latest, os_build_args: -x compileJdbc -x jacocoTestReport}
19+
- { os: macos-latest, os_build_args: -x compileJdbc -x jacocoTestReport }
2320
java:
2421
- 11
2522
- 17

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
1111

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

14-
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
14+
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
1515
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
1616

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

8585

8686
## Finding contributions to work on
87-
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.
87+
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.
8888

8989

9090
## Code of Conduct

README.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,20 @@ This is the driver for JDBC connectivity to a cluster running with OpenSearch SQ
99
| ----- | ----------------------------------------------- |
1010
| Build | [![JDBC CI][jdbc-build-badge]][jdbc-build-link] |
1111

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

1515
## Specifications
1616

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

1919
## BI Tool Connectors
2020

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

2423
## Download and Installation
2524

26-
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).
25+
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).
2726

2827
## Using the driver
2928

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

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

105-
```
104+
```java
106105
import java.sql.Connection;
107106
import java.sql.DriverManager;
108107
import java.sql.Statement;
@@ -121,7 +120,7 @@ con.close();
121120

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

124-
```
123+
```java
125124
import java.sql.Connection;
126125
import java.sql.DriverManager;
127126
import java.sql.Statement;
@@ -140,7 +139,7 @@ con.close();
140139

141140
or,
142141

143-
```
142+
```java
144143
import java.sql.Connection;
145144
import java.sql.DriverManager;
146145
import java.sql.Statement;
@@ -162,7 +161,7 @@ con.close();
162161

163162
* 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.
164163

165-
```
164+
```java
166165
import java.sql.Connection;
167166
import java.sql.DriverManager;
168167
import java.sql.Statement;
@@ -183,7 +182,7 @@ con.close();
183182

184183
or,
185184

186-
```
185+
```java
187186
import java.sql.Connection;
188187
import java.sql.DriverManager;
189188
import java.sql.Statement;
@@ -207,7 +206,7 @@ con.close();
207206

208207
* 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.
209208

210-
```
209+
```java
211210
import java.sql.Connection;
212211
import java.sql.DriverManager;
213212
import java.sql.Statement;
@@ -236,8 +235,7 @@ con.close();
236235

237236
* 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.
238237

239-
240-
```
238+
```java
241239
import java.sql.Connection;
242240
import java.sql.DriverManager;
243241
import java.sql.Statement;
@@ -253,9 +251,10 @@ Statement st = con.createStatement();
253251
// close connection
254252
con.close();
255253
```
254+
256255
or,
257256

258-
```
257+
```java
259258
import java.sql.Connection;
260259
import java.sql.DriverManager;
261260
import java.sql.Statement;
@@ -277,7 +276,7 @@ con.close();
277276

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

280-
```
279+
```java
281280
import java.sql.Connection;
282281
import java.sql.DriverManager;
283282
import java.sql.Statement;
@@ -299,7 +298,7 @@ con.close();
299298

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

302-
```
301+
```java
303302
import java.sql.Connection;
304303
import java.sql.DriverManager;
305304
import java.sql.Statement;
@@ -318,7 +317,7 @@ con.close();
318317

319318
or,
320319

321-
```
320+
```java
322321
import java.sql.Connection;
323322
import java.sql.DriverManager;
324323
import java.sql.Statement;
@@ -345,7 +344,7 @@ The driver also provides a javax.sql.DataSource implementation via the `org.open
345344

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

348-
```
347+
```java
349348
import java.sql.Connection;
350349
import java.sql.Statement;
351350
import javax.sql.DataSource;
@@ -370,7 +369,7 @@ con.close();
370369

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

373-
```
372+
```java
374373
import java.sql.Connection;
375374
import java.sql.Statement;
376375
import javax.sql.DataSource;
@@ -395,7 +394,7 @@ con.close();
395394

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

398-
```
397+
```java
399398
import java.sql.Connection;
400399
import java.sql.Statement;
401400
import javax.sql.DataSource;
@@ -420,8 +419,7 @@ con.close();
420419

421420
* 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.
422421

423-
424-
```
422+
```java
425423
import java.sql.Connection;
426424
import java.sql.Statement;
427425
import javax.sql.DataSource;
@@ -446,7 +444,7 @@ con.close();
446444

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

449-
```
447+
```java
450448
import java.sql.Connection;
451449
import java.sql.Statement;
452450
import javax.sql.DataSource;
@@ -472,7 +470,7 @@ con.close();
472470

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

475-
```
473+
```java
476474
import java.sql.Connection;
477475
import java.sql.Statement;
478476
import javax.sql.DataSource;
@@ -519,18 +517,16 @@ The driver is built as a shadow jar so that its dependencies are bundled within
519517

520518
## Documentation
521519

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

524522
## Code of Conduct
525523

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

528-
529526
## Security issue notifications
530527

531528
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.
532529

533-
534530
## Licensing
535531

536532
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

TODOs.txt

Lines changed: 0 additions & 5 deletions
This file was deleted.

bi-connectors/TableauConnector/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
## Connector Download
22

3-
The Tableau connector is available to download from the automated CI workflow: [link](https://github.com/opensearch-project/sql/actions/workflows/bi-connectors.yml).
3+
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).
44
The release snapshot is also available [here](opensearch_sql_jdbc.taco).
55

66
## Connector Install
77

88
1. Put connector `taco` file into
99
* Windows: `C:\Users\%USERNAME%\Documents\My Tableau Repository\Connectors`;
1010
* MacOS: `~/Documents/My Tableau Repository/Connectors`.
11-
2. Put OpenSearch `JDBC` [driver](../../sql-jdbc/README.md) (`jar` file) into
11+
1. Put OpenSearch `JDBC` [driver](../../README.md) (`jar` file) into
1212
* Windows: `C:\Program Files\Tableau\Drivers`;
1313
* MacOS: `~/Library/Tableau/Drivers`.
14-
3. Run `Tableau Desktop` with command line flag `-DDisableVerifyConnectorPluginSignature=true`:
14+
1. Run `Tableau Desktop` with command line flag `-DDisableVerifyConnectorPluginSignature=true`:
1515
* Windows: `"C:\Program Files\Tableau\Tableau 2022.1\bin\tableau.exe" -DDisableVerifyConnectorPluginSignature=true`;
1616
* MacOS: `open -n /Applications/Tableau\ Desktop\ 2022.1.app --args -DDisableVerifyConnectorPluginSignature=true`.
1717
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%).
2929
## See also
3030

3131
* [Connector user manual for Tableau Desktop](tableau_support.md)
32-
* JDBC Driver user manual [describes](../../sql-jdbc/docs/tableau.md) how to use the `JDBC` driver without the connector
32+
* JDBC Driver user manual [describes](../../docs/tableau.md) how to use the `JDBC` driver without the connector

build.gradle

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -138,12 +138,12 @@ publishing {
138138
pom {
139139
name = "OpenSearch SQL JDBC Driver"
140140
packaging = "jar"
141-
url = "https://github.com/opensearch-project/sql/sql-jdbc"
141+
url = "https://github.com/opensearch-project/sql-jdbc"
142142
description = "OpenSearch SQL JDBC driver"
143143
scm {
144-
connection = "scm:[email protected]:opensearch-project/sql.git"
145-
developerConnection = "scm:[email protected]:opensearch-project/sql.git"
146-
url = "[email protected]:opensearch-project/sql.git"
144+
connection = "scm:[email protected]:opensearch-project/sql-jdbc.git"
145+
developerConnection = "scm:[email protected]:opensearch-project/sql-jdbc.git"
146+
url = "[email protected]:opensearch-project/sql-jdbc.git"
147147
}
148148
licenses {
149149
license {
@@ -154,7 +154,7 @@ publishing {
154154
developers {
155155
developer {
156156
name = 'OpenSearch'
157-
url = 'https://github.com/opensearch-project/sql'
157+
url = 'https://github.com/opensearch-project/sql-jdbc'
158158
}
159159
}
160160
}
@@ -165,12 +165,12 @@ publishing {
165165
pom {
166166
name = "OpenSearch SQL JDBC Driver"
167167
packaging = "jar"
168-
url = "https://github.com/opensearch-project/sql/sql-jdbc"
168+
url = "https://github.com/opensearch-project/sql-jdbc"
169169
description = "OpenSearch SQL JDBC driver"
170170
scm {
171-
connection = "scm:[email protected]:opensearch-project/sql.git"
172-
developerConnection = "scm:[email protected]:opensearch-project/sql.git"
173-
url = "[email protected]:opensearch-project/sql.git"
171+
connection = "scm:[email protected]:opensearch-project/sql-jdbc.git"
172+
developerConnection = "scm:[email protected]:opensearch-project/sql-jdbc.git"
173+
url = "[email protected]:opensearch-project/sql-jdbc.git"
174174
}
175175
licenses {
176176
license {
@@ -181,7 +181,7 @@ publishing {
181181
developers {
182182
developer {
183183
name = 'OpenSearch'
184-
url = 'https://github.com/opensearch-project/sql'
184+
url = 'https://github.com/opensearch-project/sql-jdbc'
185185
}
186186
}
187187
}

docs/tableau.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

99
## Setup
1010

jenkins/jdbc-stage-maven-release.jenkinsfile

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ pipeline {
3131
[key: 'VERSION', value: '$.ref', regexpFilter: 'refs/tags/v' ],
3232
],
3333
tokenCredentialId: 'jenkins-sql-jdbc-generic-webhook-token',
34-
causeString: 'A tag was cut on opensearch-project/sql repository causing this workflow to run',
34+
causeString: 'A tag was cut on opensearch-project/sql-jdbc repository causing this workflow to run',
3535
printContributedVariables: false,
3636
printPostContent: false,
3737
regexpFilterText: '$ref',
@@ -46,14 +46,12 @@ pipeline {
4646
steps {
4747
// checkout the commit
4848
checkout([
49-
$class: 'GitSCM', userRemoteConfigs: [[url: 'https://github.com/opensearch-project/sql.git']],
49+
$class: 'GitSCM', userRemoteConfigs: [[url: 'https://github.com/opensearch-project/sql-jdbc.git']],
5050
branches: [[name: "$ref"]]
5151
])
5252

53-
dir('sql-jdbc') {
54-
// publish maven artifacts
55-
sh('./gradlew --no-daemon publishPublishMavenPublicationToLocalRepoRepository')
56-
}
53+
// publish maven artifacts
54+
sh('./gradlew --no-daemon publishPublishMavenPublicationToLocalRepoRepository')
5755
}
5856
}
5957
stage('Sign') {

0 commit comments

Comments
 (0)