SQL: better management of allowPartialSearchResults defaults for CPS

server/src/main/resources/transport/definitions/referable/sql_optional_allow_partial_search_results.csv

@@ -0,0 +1 @@
+9313000

server/src/main/resources/transport/upper_bounds/9.4.csv

@@ -1 +1 @@
-transform_indices_options,9312000
+sql_optional_allow_partial_search_results,9313000

x-pack/plugin/sql/sql-action/build.gradle

@@ -2,6 +2,7 @@
  * This project contains transport-level requests and responses that are shared between x-pack plugin and qa tests
  */
 apply plugin: 'elasticsearch.build'
+apply plugin: 'elasticsearch.transport-version-references'
 
 description = 'Request and response objects shared by the Elasticsearch plugin and qa tests'
 

x-pack/plugin/sql/sql-action/src/main/java/org/elasticsearch/xpack/sql/action/SqlQueryRequest.java

@@ -6,6 +6,7 @@
  */
 package org.elasticsearch.xpack.sql.action;
 
+import org.elasticsearch.TransportVersion;
 import org.elasticsearch.action.ActionRequestValidationException;
 import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.io.stream.StreamInput;
@@ -47,6 +48,10 @@
  * Request to perform an sql query
  */
 public class SqlQueryRequest extends AbstractSqlQueryRequest {
+    public static final TransportVersion OPTIONAL_ALLOW_PARTIAL_SEARCH_RESULTS = TransportVersion.fromName(
+        "sql_optional_allow_partial_search_results"
+    );
+
     private static final ObjectParser<SqlQueryRequest, Void> PARSER = objectParser(SqlQueryRequest::new);
     static final ParseField COLUMNAR = new ParseField(COLUMNAR_NAME);
     static final ParseField FIELD_MULTI_VALUE_LENIENCY = new ParseField(FIELD_MULTI_VALUE_LENIENCY_NAME);
@@ -106,7 +111,7 @@ public class SqlQueryRequest extends AbstractSqlQueryRequest {
     private boolean keepOnCompletion = DEFAULT_KEEP_ON_COMPLETION;
     private TimeValue keepAlive = DEFAULT_KEEP_ALIVE;
 
-    private boolean allowPartialSearchResults = Protocol.ALLOW_PARTIAL_SEARCH_RESULTS;
+    private Boolean allowPartialSearchResults;
 
     public SqlQueryRequest() {
         super();
@@ -130,7 +135,7 @@ public SqlQueryRequest(
         TimeValue waitForCompletionTimeout,
         boolean keepOnCompletion,
         TimeValue keepAlive,
-        boolean allowPartialSearchResults
+        Boolean allowPartialSearchResults
     ) {
         super(query, params, filter, runtimeMappings, zoneId, catalog, fetchSize, requestTimeout, pageTimeout, requestInfo);
         this.cursor = cursor;
@@ -162,7 +167,11 @@ public SqlQueryRequest(StreamInput in) throws IOException {
         this.waitForCompletionTimeout = in.readOptionalTimeValue();
         this.keepOnCompletion = in.readBoolean();
         this.keepAlive = in.readOptionalTimeValue();
-        allowPartialSearchResults = in.readBoolean();
+        if (in.getTransportVersion().supports(OPTIONAL_ALLOW_PARTIAL_SEARCH_RESULTS)) {
+            allowPartialSearchResults = in.readOptionalBoolean();
+        } else {
+            allowPartialSearchResults = in.readBoolean();
+        }
     }
 
     /**
@@ -256,12 +265,12 @@ public TimeValue keepAlive() {
         return keepAlive;
     }
 
-    public SqlQueryRequest allowPartialSearchResults(boolean allowPartialSearchResults) {
+    public SqlQueryRequest allowPartialSearchResults(Boolean allowPartialSearchResults) {
         this.allowPartialSearchResults = allowPartialSearchResults;
         return this;
     }
 
-    public boolean allowPartialSearchResults() {
+    public Boolean allowPartialSearchResults() {
         return allowPartialSearchResults;
     }
 
@@ -294,7 +303,11 @@ public void writeTo(StreamOutput out) throws IOException {
         out.writeOptionalTimeValue(waitForCompletionTimeout);
         out.writeBoolean(keepOnCompletion);
         out.writeOptionalTimeValue(keepAlive);
-        out.writeBoolean(allowPartialSearchResults);
+        if (out.getTransportVersion().supports(OPTIONAL_ALLOW_PARTIAL_SEARCH_RESULTS)) {
+            out.writeOptionalBoolean(allowPartialSearchResults);
+        } else {
+            out.writeBoolean(allowPartialSearchResults != null && allowPartialSearchResults);
+        }
     }
 
     @Override
@@ -320,7 +333,7 @@ public boolean equals(Object obj) {
             && indexIncludeFrozen == ((SqlQueryRequest) obj).indexIncludeFrozen
             && Objects.equals(binaryCommunication, ((SqlQueryRequest) obj).binaryCommunication)
             && keepOnCompletion == ((SqlQueryRequest) obj).keepOnCompletion
-            && allowPartialSearchResults == ((SqlQueryRequest) obj).allowPartialSearchResults
+            && Objects.equals(allowPartialSearchResults, ((SqlQueryRequest) obj).allowPartialSearchResults)
             && Objects.equals(cursor, ((SqlQueryRequest) obj).cursor)
             && Objects.equals(columnar, ((SqlQueryRequest) obj).columnar)
             && Objects.equals(waitForCompletionTimeout, ((SqlQueryRequest) obj).waitForCompletionTimeout)

x-pack/plugin/sql/sql-action/src/test/java/org/elasticsearch/xpack/sql/action/SqlQueryRequestTests.java

@@ -80,7 +80,7 @@ protected TestSqlQueryRequest createTestInstance() {
             randomTimeValue(),
             randomBoolean(),
             randomTVGreaterThan(MIN_KEEP_ALIVE),
-            randomBoolean()
+            randomBoolean() ? true : null
         );
     }
 
@@ -119,7 +119,7 @@ protected TestSqlQueryRequest mutateInstance(TestSqlQueryRequest instance) {
             request -> request.keepOnCompletion(randomValueOtherThan(request.keepOnCompletion(), ESTestCase::randomBoolean)),
             request -> request.keepAlive(randomValueOtherThan(request.keepAlive(), () -> randomTVGreaterThan(MIN_KEEP_ALIVE))),
             request -> request.allowPartialSearchResults(
-                randomValueOtherThan(request.allowPartialSearchResults(), ESTestCase::randomBoolean)
+                randomValueOtherThan(request.allowPartialSearchResults(), () -> randomBoolean() ? true : null)
             )
         );
         TestSqlQueryRequest newRequest = new TestSqlQueryRequest(

x-pack/plugin/sql/sql-action/src/test/java/org/elasticsearch/xpack/sql/action/TestSqlQueryRequest.java

@@ -40,7 +40,7 @@ public TestSqlQueryRequest(
         TimeValue waitForCompletionTimeout,
         boolean keepOnCompletion,
         TimeValue keepAlive,
-        boolean allowPartialSearchResults
+        Boolean allowPartialSearchResults
     ) {
         super(
             query,
@@ -87,7 +87,7 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
             ProtoShim.toProto(this.waitForCompletionTimeout()),
             this.keepOnCompletion(),
             ProtoShim.toProto(this.keepAlive()),
-            this.allowPartialSearchResults(),
+            this.allowPartialSearchResults() != null && this.allowPartialSearchResults(),
             null
         );
         return SqlTestUtils.toXContentBuilder(builder, this, protoInstance);

x-pack/plugin/sql/src/main/java/org/elasticsearch/xpack/sql/execution/search/Querier.java

@@ -158,7 +158,8 @@ private void searchWithPointInTime(SearchRequest search, SqlConfiguration cfg, A
             options = IndicesOptions.builder(options).crossProjectModeOptions(new IndicesOptions.CrossProjectModeOptions(true)).build();
         }
         final OpenPointInTimeRequest openPitRequest = new OpenPointInTimeRequest(search.indices()).indicesOptions(options)
-            .keepAlive(cfg.pageTimeout());
+            .keepAlive(cfg.pageTimeout())
+            .allowPartialSearchResults(cfg.allowPartialSearchResults());
         if (cfg.crossProject() && cfg.projectRouting() != null) {
             openPitRequest.projectRouting(cfg.projectRouting());
         }

x-pack/plugin/sql/src/main/java/org/elasticsearch/xpack/sql/plugin/TransportSqlQueryAction.java

@@ -155,6 +155,10 @@ public static void operation(
     ) {
         // The configuration is always created however when dealing with the next page, only the timeouts are relevant
         // the rest having default values (since the query is already created)
+        boolean crossProjectEnabled = new CrossProjectModeDecider(clusterService.getSettings()).crossProjectEnabled();
+        boolean allowPartialSearchResults = request.allowPartialSearchResults() != null
+            ? request.allowPartialSearchResults()
+            : crossProjectEnabled;
         SqlConfiguration cfg = new SqlConfiguration(
             request.zoneId(),
             request.catalog(),
@@ -172,8 +176,8 @@ public static void operation(
             request.indexIncludeFrozen(),
             new TaskId(clusterService.localNode().getId(), task.getId()),
             task,
-            request.allowPartialSearchResults(),
-            new CrossProjectModeDecider(clusterService.getSettings()).crossProjectEnabled(),
+            allowPartialSearchResults,
+            crossProjectEnabled,
             request.projectRouting()
         );