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

Add sessionId parameters for create async query API #2312

Merged
merged 17 commits into from
Oct 18, 2023

Conversation

penghuo
Copy link
Collaborator

@penghuo penghuo commented Oct 17, 2023

Description

  1. API doc. https://github.com/opensearch-project/sql/blob/2b1ad6a912a91f64056446aa24601ee1f1ab469c/docs/user/interfaces/asyncqueryinterface.rst
  2. feature disable by default.

Todo

  1. create .query_execution_request index if not exist.
  2. change REPL job Spark parameters.
  3. add IT in following PR.
  4. enable the feature by default.

Test Queries

  • enable feature.
PUT {{baseUrl}}/_plugins/_query/settings
Content-Type: application/x-ndjson

{"transient":{"plugins.query.executionengine.spark.session.enabled":"true"}}

{
  "acknowledged": true,
  "persistent": {},
  "transient": {
    "plugins": {
      "query": {
        "executionengine": {
          "spark": {
            "session": {
              "enabled": "true"
            }
          }
        }
      }
    }
  }
}
  • submit query without sessionId, new sessionId will be allocated.
POST {{baseUrl}}/_plugins/_async_query
Content-Type: application/x-ndjson

{
  "datasource": "mys3",
  "lang": "sql",
  "query": "select * from mys3.default.http_logs limit 1"
}

{
  "queryId": "HlbM61kX6MDkAktO",
  "sessionId": "1Giy65ZnzNlmsPAm"
}
  • fetch query result
GET {{baseUrl}}/_plugins/_async_query/HlbM61kX6MDkAktO

{
  "status": "waiting"
}
  • submit new query in same session
POST {{baseUrl}}/_plugins/_async_query
Content-Type: application/x-ndjson

{
  "datasource": "mys3",
  "lang": "sql",
  "query": "select * from mys3.default.http_logs limit 1",
  "sessionId" : "1Giy65ZnzNlmsPAm"
}

{
  "queryId": "7GC4mHhftiTejvxN",
  "sessionId": "1Giy65ZnzNlmsPAm"
}

Issues Resolved

[List any issues this PR will resolve]

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.

@codecov
Copy link

codecov bot commented Oct 17, 2023

Codecov Report

Merging #2312 (2b1ad6a) into main (297e26f) will increase coverage by 0.11%.
The diff coverage is 96.73%.

@@             Coverage Diff              @@
##               main    #2312      +/-   ##
============================================
+ Coverage     96.58%   96.69%   +0.11%     
- Complexity     4823     4839      +16     
============================================
  Files           454      454              
  Lines         13134    13203      +69     
  Branches        887      896       +9     
============================================
+ Hits          12685    12767      +82     
+ Misses          436      422      -14     
- Partials         13       14       +1     
Flag Coverage Δ
sql-engine 96.69% <96.73%> (+0.11%) ⬆️

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

Files Coverage Δ
...rch/sql/opensearch/setting/OpenSearchSettings.java 100.00% <100.00%> (ø)
...park/asyncquery/AsyncQueryExecutorServiceImpl.java 100.00% <100.00%> (ø)
...earch/sql/spark/data/constants/SparkConstants.java 0.00% <ø> (ø)
...rch/sql/spark/dispatcher/SparkQueryDispatcher.java 100.00% <100.00%> (ø)
...nsearch/sql/spark/execution/session/SessionId.java 100.00% <100.00%> (ø)
...ch/sql/spark/execution/session/SessionManager.java 100.00% <100.00%> (ø)
...rch/sql/spark/execution/statement/StatementId.java 100.00% <100.00%> (ø)
.../sql/spark/rest/model/CreateAsyncQueryRequest.java 93.54% <90.00%> (+70.82%) ⬆️
.../spark/asyncquery/model/AsyncQueryJobMetadata.java 82.60% <66.66%> (-2.76%) ⬇️

@@ -13,7 +13,7 @@ public class StatementId {
private final String id;

public static StatementId newStatementId() {
return new StatementId(RandomStringUtils.random(10, true, true));
return new StatementId(RandomStringUtils.random(16, true, true));
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

change length from 10 to 16, making it similar to EMR-S job id.

Copy link
Member

@vmmusings vmmusings Oct 18, 2023

Choose a reason for hiding this comment

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

Nit:: randomAlphaNumeric? random Id is looking bad with "=" and other characters.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done.

Signed-off-by: Peng Huo <[email protected]>
vmmusings
vmmusings previously approved these changes Oct 18, 2023
Signed-off-by: Peng Huo <[email protected]>
Signed-off-by: Peng Huo <[email protected]>
@penghuo penghuo merged commit 8f5e01d into opensearch-project:main Oct 18, 2023
20 of 21 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 18, 2023
* add InteractiveSession and SessionManager

Signed-off-by: Peng Huo <[email protected]>

* add statement

Signed-off-by: Peng Huo <[email protected]>

* add statement

Signed-off-by: Peng Huo <[email protected]>

* fix format

Signed-off-by: Peng Huo <[email protected]>

* snapshot

Signed-off-by: Peng Huo <[email protected]>

* address comments

Signed-off-by: Peng Huo <[email protected]>

* update

Signed-off-by: Peng Huo <[email protected]>

* Update REST and Transport interface

Signed-off-by: Peng Huo <[email protected]>

* Revert on transport layer

Signed-off-by: Peng Huo <[email protected]>

* format code

Signed-off-by: Peng Huo <[email protected]>

* add API doc

Signed-off-by: Peng Huo <[email protected]>

* modify api

Signed-off-by: Peng Huo <[email protected]>

* address comments

Signed-off-by: Peng Huo <[email protected]>

* update doc

Signed-off-by: Peng Huo <[email protected]>

---------

Signed-off-by: Peng Huo <[email protected]>
(cherry picked from commit 8f5e01d)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 18, 2023
* add InteractiveSession and SessionManager

Signed-off-by: Peng Huo <[email protected]>

* add statement

Signed-off-by: Peng Huo <[email protected]>

* add statement

Signed-off-by: Peng Huo <[email protected]>

* fix format

Signed-off-by: Peng Huo <[email protected]>

* snapshot

Signed-off-by: Peng Huo <[email protected]>

* address comments

Signed-off-by: Peng Huo <[email protected]>

* update

Signed-off-by: Peng Huo <[email protected]>

* Update REST and Transport interface

Signed-off-by: Peng Huo <[email protected]>

* Revert on transport layer

Signed-off-by: Peng Huo <[email protected]>

* format code

Signed-off-by: Peng Huo <[email protected]>

* add API doc

Signed-off-by: Peng Huo <[email protected]>

* modify api

Signed-off-by: Peng Huo <[email protected]>

* address comments

Signed-off-by: Peng Huo <[email protected]>

* update doc

Signed-off-by: Peng Huo <[email protected]>

---------

Signed-off-by: Peng Huo <[email protected]>
(cherry picked from commit 8f5e01d)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
penghuo pushed a commit that referenced this pull request Oct 18, 2023
* add InteractiveSession and SessionManager

---------


(cherry picked from commit 8f5e01d)

Signed-off-by: Peng Huo <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
penghuo pushed a commit that referenced this pull request Oct 18, 2023
* add InteractiveSession and SessionManager

---------


(cherry picked from commit 8f5e01d)

Signed-off-by: Peng Huo <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
mengweieric added a commit to mengweieric/sql that referenced this pull request Nov 8, 2023
mengweieric added a commit to mengweieric/sql that referenced this pull request Nov 8, 2023
vmmusings added a commit to mengweieric/sql that referenced this pull request Nov 13, 2023
vmmusings added a commit that referenced this pull request Nov 13, 2023
* Revert "Add more metrics and handle emr exception message (#2422) (#2426)"

This reverts commit b57f7cc.

* Revert "Block settings in sql query settings API and add more unit tests (#2407) (#2412)"

This reverts commit 3024737.

* Revert "Added session, statement, emrjob metrics to sql stats api (#2398) (#2400)"

This reverts commit 6e17ae6.

* Revert "Redefine Drop Index as logical delete (#2386) (#2397)"

This reverts commit e939bb6.

* Revert "add concurrent limit on datasource and sessions (#2390) (#2395)"

This reverts commit deb3ccf.

* Revert "Add Flint Index Purging Logic (#2372) (#2389)"

This reverts commit dd48b9b.

* Revert "Refactoring for tags usage in test files and also added explicit denly list setting. (#2383) (#2385)"

This reverts commit 37e010f.

* Revert "Enable session by default (#2373) (#2375)"

This reverts commit 7d95e4c.

* Revert "Create new session if client provided session is invalid (#2368) (#2371)"

This reverts commit 5ab7858.

* Revert "Add where clause support in create statement (#2366) (#2370)"

This reverts commit b620a56.

* Revert "create new session if current session not ready (#2363) (#2365)"

This reverts commit 5d07281.

* Revert "Handle Describe,Refresh and Show Queries Properly (#2357) (#2362)"

This reverts commit 16e2f30.

* Revert "Add Session limitation (#2354) (#2359)"

This reverts commit 0f334f8.

* Revert "Bug Fix, support cancel query in running state (#2351) (#2353)"

This reverts commit 9a40591.

* Revert "Fix bug, using basic instead of basicauth (#2342) (#2355)"

This reverts commit e4827a5.

* Revert "Add missing tags and MV support (#2336) (#2346)"

This reverts commit 8791bb0.

* Revert "[Backport 2.x] deprecated job-metadata-index (#2340) (#2343)"

This reverts commit bea432c.

* Revert "Integration with REPL Spark job (#2327) (#2338)"

This reverts commit 58a5ae5.

* Revert "Implement patch API for datasources (#2273) (#2329)"

This reverts commit 4c151fe.

* Revert "Add sessionId parameters for create async query API (#2312) (#2324)"

This reverts commit 3d1a376.

* Revert "Add Statement (#2294) (#2318) (#2319)"

This reverts commit b3c2e94.

* Revert "Upgrade json (#2307) (#2314)"

This reverts commit 6c65bb4.

* Revert "Minor Refactoring (#2308) (#2317)"

This reverts commit 051cc4f.

* Revert "add InteractiveSession and SessionManager (#2290) (#2293) (#2315)"

This reverts commit 6ac197b.

---------

Co-authored-by: Vamsi Manohar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants