Skip to content

Commit

Permalink
update developer guide, readme and gradle build
Browse files Browse the repository at this point in the history
Signed-off-by: Kavitha Conjeevaram Mohan <mohakavi@amazon.com>
  • Loading branch information
kavithacm committed May 4, 2023
1 parent 165b5da commit 293d2cf
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 24 deletions.
5 changes: 1 addition & 4 deletions DEVELOPER_GUIDE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,7 @@ The plugin codebase is in standard layout of Gradle project::
├── sql
├── sql-cli
├── sql-jdbc
├── sql-odbc
└── workbench
└── sql-odbc

Here are sub-folders (Gradle modules) for plugin source code:

Expand All @@ -175,8 +174,6 @@ Note that other related project code has already merged into this single reposit
- ``sql-cli``: CLI tool for running query from command line.
- ``sql-jdbc``: JDBC driver.
- ``sql-odbc``: ODBC driver.
- ``workbench``: query workbench UI.


Code Convention
---------------
Expand Down
13 changes: 0 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ The following projects have been merged into this repository as separate folders
- [SQL CLI](https://github.com/opensearch-project/sql/tree/main/sql-cli)
- [SQL JDBC](https://github.com/opensearch-project/sql/tree/main/sql-jdbc)
- [SQL ODBC](https://github.com/opensearch-project/sql/tree/main/sql-odbc)
- [Query Workbench](https://github.com/opensearch-project/sql/tree/main/workbench)

## Code Summary

Expand Down Expand Up @@ -51,14 +50,6 @@ The following projects have been merged into this repository as separate folders
| ----- | ----------------------------------------------- |
| Build | [![JDBC CI][jdbc-build-badge]][jdbc-build-link] |

### Query WorkBench

| | |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| Test and build | [![Observability Dashboards CI][workbench-build-badge]][workbench-build-link] |
| Code coverage | [![codecov][workbench-codecov-badge]][sql-codecov-link] |
| Distribution build tests | [![cypress tests][cypress-test-badge]][cypress-test-link] [![cypress code][cypress-code-badge]][cypress-code-link] |

### Repository Checks

| | |
Expand Down Expand Up @@ -103,14 +94,10 @@ The following projects have been merged into this repository as separate folders
[untriaged-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3Auntriaged+
[nolabel-badge]: https://img.shields.io/github/issues-search/opensearch-project/sql?color=yellow&label=no%20label%20issues&query=is%3Aopen%20is%3Aissue%20no%3Alabel
[nolabel-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+no%3Alabel+
[workbench-build-badge]: https://github.com/opensearch-project/sql/actions/workflows/sql-workbench-test-and-build-workflow.yml/badge.svg
[workbench-build-link]: https://github.com/opensearch-project/sql/actions/workflows/sql-workbench-test-and-build-workflow.yml
[cypress-test-badge]: https://img.shields.io/badge/Cypress%20tests-in%20progress-yellow
[cypress-test-link]: https://github.com/opensearch-project/opensearch-build/issues/1124
[cypress-code-badge]: https://img.shields.io/badge/Cypress%20code-blue
[cypress-code-link]: https://github.com/opensearch-project/sql/tree/main/workbench/.cypress/integration
[sql-codecov-badge]: https://codecov.io/gh/opensearch-project/sql/branch/main/graphs/badge.svg?flag=sql-engine
[workbench-codecov-badge]: https://codecov.io/gh/opensearch-project/sql/branch/main/graphs/badge.svg?flag=query-workbench
[sql-codecov-link]: https://codecov.io/gh/opensearch-project/sql
[opensearch-it-badge]: https://img.shields.io/badge/SQL%20IT%20tests-in%20progress-yellow
[opensearch-it-link]: https://github.com/opensearch-project/opensearch-build/issues/1124
Expand Down
6 changes: 0 additions & 6 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,6 @@ task updateVersion {
ext.newVersion = System.getProperty('newVersion')
println "Setting version to ${newVersion}."
// String tokenization to support -SNAPSHOT
ant.replaceregexp(file:'.github/workflows/sql-workbench-test-and-build-workflow.yml', match:'OPENSEARCH_PLUGIN_VERSION: \\d+.\\d+.\\d+.\\d+', replace:'OPENSEARCH_PLUGIN_VERSION: ' + newVersion.tokenize('-')[0] + '.0', flags:'g', byline:true)
ant.replaceregexp(match: opensearch_version.tokenize('-')[0], replace: newVersion.tokenize('-')[0], flags:'g', byline:true) {
fileset(dir: projectDir) {
include(name: '.github/workflows/sql-test-and-build-workflow.yml')
Expand All @@ -163,11 +162,6 @@ task updateVersion {
}
ant.replaceregexp(file:'build.gradle', match: '"opensearch.version", "\\d.*"', replace: '"opensearch.version", "' + newVersion.tokenize('-')[0] + '-SNAPSHOT"', flags:'g', byline:true)
ant.replaceregexp(match:'"version": "\\d+.\\d+.\\d+.\\d+', replace:'"version": ' + '"' + newVersion.tokenize('-')[0] + '.0', flags:'g', byline:true) {
fileset(dir: projectDir) {
include(name: "workbench/package.json")
include(name: "workbench/opensearch_dashboards.json")
}
}
ant.replaceregexp(file:'workbench/opensearch_dashboards.json', match:'"opensearchDashboardsVersion": "\\d+.\\d+.\\d+', replace:'"opensearchDashboardsVersion": ' + '"' + newVersion.tokenize('-')[0], flags:'g', byline:true)
}
}
2 changes: 1 addition & 1 deletion docs/presentations/20201116-sql-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Topics:
---
## Introduction

Here is a great blog that covers main features of SQL, Query Workbench, SQL-CLI, JDBC/ODBC driver: https://opendistro.github.io/for-elasticsearch/blog/odfe-updates/2020/06/An-overview-of-the-SQL-Engine-in-Open-Distro-for-Elasticsearch/
Here is a great blog that covers main features of SQL, SQL-CLI, JDBC/ODBC driver: https://opendistro.github.io/for-elasticsearch/blog/odfe-updates/2020/06/An-overview-of-the-SQL-Engine-in-Open-Distro-for-Elasticsearch/

Now we can start the demo. Note that you can follow the instructions in Resources (II) Demo Cluster to set up OpenSearch and OpenSearch Dashboards cluster locally.

Expand Down

0 comments on commit 293d2cf

Please sign in to comment.