update doc

Signed-off-by: Peng Huo <penghuo@gmail.com>
penghuo · Mar 13, 2024 · 4cc0d5e · 4cc0d5e
1 parent 05cd665
commit 4cc0d5e
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 15 deletions.
diff --git a/docs/user/interfaces/asyncqueryinterface.rst b/docs/user/interfaces/asyncqueryinterface.rst
@@ -185,7 +185,7 @@ Async Query Cancellation API
 ======================================
 If security plugin is enabled, this API can only be invoked by users with permission ``cluster:admin/opensearch/ql/jobs/delete``.
 
-Limitation: Flint index creation can not be cancelled. User could submit ALTER statement to stop auto refresh query.
+Limitation: Flint index creation statement with auto_refresh = true can not be cancelled. User could submit ALTER statement to stop auto refresh query.
 - flint index creation statement include, CREATE SKIPPING INDEX / CREATE INDEX / CREATE MATERIALIZED VIEW
 
 HTTP URI: ``_plugins/_async_query/{queryId}``

diff --git a/spark/src/main/java/org/opensearch/sql/spark/dispatcher/RefreshQueryHandler.java b/spark/src/main/java/org/opensearch/sql/spark/dispatcher/RefreshQueryHandler.java
@@ -30,11 +30,12 @@ public class RefreshQueryHandler extends BatchQueryHandler {
   private final StateStore stateStore;
   private final EMRServerlessClient emrServerlessClient;
 
-  public RefreshQueryHandler(EMRServerlessClient emrServerlessClient,
-                             JobExecutionResponseReader jobExecutionResponseReader,
-                             FlintIndexMetadataReader flintIndexMetadataReader,
-                             StateStore stateStore,
-                             LeaseManager leaseManager) {
+  public RefreshQueryHandler(
+      EMRServerlessClient emrServerlessClient,
+      JobExecutionResponseReader jobExecutionResponseReader,
+      FlintIndexMetadataReader flintIndexMetadataReader,
+      StateStore stateStore,
+      LeaseManager leaseManager) {
     super(emrServerlessClient, jobExecutionResponseReader, leaseManager);
     this.flintIndexMetadataReader = flintIndexMetadataReader;
     this.stateStore = stateStore;
@@ -57,8 +58,8 @@ public String cancelJob(AsyncQueryJobMetadata asyncQueryJobMetadata) {
   }
 
   @Override
-  public DispatchQueryResponse submit(DispatchQueryRequest dispatchQueryRequest,
-                                      DispatchQueryContext context) {
+  public DispatchQueryResponse submit(
+      DispatchQueryRequest dispatchQueryRequest, DispatchQueryContext context) {
     DispatchQueryResponse resp = super.submit(dispatchQueryRequest, context);
     String indexName =
         context.getIndexQueryDetails() == null

diff --git a/spark/src/main/java/org/opensearch/sql/spark/dispatcher/SparkQueryDispatcher.java b/spark/src/main/java/org/opensearch/sql/spark/dispatcher/SparkQueryDispatcher.java
@@ -86,12 +86,17 @@ public DispatchQueryResponse dispatch(DispatchQueryRequest dispatchQueryRequest)
       } else if (IndexQueryActionType.CREATE.equals(indexQueryDetails.getIndexQueryActionType())
           && indexQueryDetails.isAutoRefresh()) {
         asyncQueryHandler =
-            new StreamingQueryHandler(emrServerlessClient, jobExecutionResponseReader, leaseManager);
+            new StreamingQueryHandler(
+                emrServerlessClient, jobExecutionResponseReader, leaseManager);
       } else if (IndexQueryActionType.REFRESH.equals(indexQueryDetails.getIndexQueryActionType())) {
         // manual refresh should be handled by batch handler
         asyncQueryHandler =
-            new RefreshQueryHandler(emrServerlessClient, jobExecutionResponseReader,
-                flintIndexMetadataReader, stateStore, leaseManager);
+            new RefreshQueryHandler(
+                emrServerlessClient,
+                jobExecutionResponseReader,
+                flintIndexMetadataReader,
+                stateStore,
+                leaseManager);
       }
     }
     return asyncQueryHandler.submit(dispatchQueryRequest, contextBuilder.build());
@@ -120,14 +125,18 @@ public String cancelJob(AsyncQueryJobMetadata asyncQueryJobMetadata) {
       queryHandler = createIndexDMLHandler(emrServerlessClient);
     } else if (asyncQueryJobMetadata.getJobType() == JobType.BATCH) {
       queryHandler =
-          new RefreshQueryHandler(emrServerlessClient, jobExecutionResponseReader,
-              flintIndexMetadataReader, stateStore, leaseManager);
+          new RefreshQueryHandler(
+              emrServerlessClient,
+              jobExecutionResponseReader,
+              flintIndexMetadataReader,
+              stateStore,
+              leaseManager);
     } else if (asyncQueryJobMetadata.getJobType() == JobType.STREAMING) {
       queryHandler =
           new StreamingQueryHandler(emrServerlessClient, jobExecutionResponseReader, leaseManager);
     } else {
-      queryHandler = new BatchQueryHandler(emrServerlessClient, jobExecutionResponseReader,
-          leaseManager);
+      queryHandler =
+          new BatchQueryHandler(emrServerlessClient, jobExecutionResponseReader, leaseManager);
     }
     return queryHandler.cancelJob(asyncQueryJobMetadata);
   }