SOLR-18093: Add top-level 'queries' support to JsonQueryRequest in SolrJ

changelog/unreleased/SOLR-18093-add-top-level-queries-in-json-solrj.yml

@@ -0,0 +1,9 @@
+# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+title: Add top-level "queries" support to JsonQueryRequest in SolrJ
+type: added
+authors:
+  - name: Sonu Sharma
+    nick: ercsonusharma
+links:
+  - name: SOLR-18093
+    url: https://issues.apache.org/jira/browse/SOLR-18093

solr/server/solr/configsets/sample_techproducts_configs/conf/solrconfig.xml

@@ -640,7 +640,14 @@
      </lst>
   </requestHandler>
 
-  <initParams path="/update/**,/query,/select,/tvrh,/elevate,/spell,update">
+  <requestHandler name="/search" class="solr.CombinedQuerySearchHandler">
+  </requestHandler>
+
+  <searchComponent class="solr.CombinedQueryComponent" name="combined_query">
+    <int name="maxCombinerQueries">2</int>
+  </searchComponent>
+
+  <initParams path="/update/**,/query,/search,/select,/tvrh,/elevate,/spell,update">
     <lst name="defaults">
       <str name="df">text</str>
     </lst>

solr/solr-ref-guide/modules/query-guide/examples/JsonRequestApiTest.java

@@ -83,6 +83,53 @@ public void testSimpleJsonQuery() throws Exception {
     assertResponseFoundNumDocs(queryResponse, expectedResults);
   }
 
+  /**
+   * Test json query behaviour in case of multiple query to be executed using Combined Query.
+   *
+   * @throws Exception the exception
+   */
+  @Test
+  public void testSimpleJsonQueryWithQueriesParams() throws Exception {
+    SolrClient solrClient = cluster.getSolrClient();
+    final int expectedResults = 2;
+    final Map<String, Object> queriesMap = new HashMap<>();
+    queriesMap.put("query1", Map.of("lucene", Map.of("query", "apache", "df", "manu")));
+    queriesMap.put("query2", Map.of("edismax", Map.of("query", "solr", "df", "name")));
+    ModifiableSolrParams queryParams = new ModifiableSolrParams();
+    queryParams.set("qt", "/search");
+    final JsonQueryRequest query =
+        new JsonQueryRequest(queryParams)
+            .setQueries(queriesMap)
+            .withFilter("inStock:true")
+            .withParam("fl", "name")
+            .withParam("combiner", "true")
+            .withParam("combiner.query", List.of("query1", "query2"));
+    QueryResponse queryResponse = query.process(solrClient, COLLECTION_NAME);
+    assertResponseFoundNumDocs(queryResponse, expectedResults);
+  }
+
+  /**
+   * Test json query behaviour in case of multiple query to be executed using Additional Queries.
+   *
+   * @throws Exception the exception
+   */
+  @Test
+  public void testAdditionalJsonQueries() throws Exception {
+    SolrClient solrClient = cluster.getSolrClient();
+    final int expectedResults = 12;
+    // tag::solrj-json-query-with-queries[]
+    final Map<String, Object> queriesMap = new HashMap<>();
+    queriesMap.put("electronic", Map.of("field", Map.of("query", "electronics", "f", "cat")));
+    queriesMap.put(
+        "manufacturers",
+        List.of("manu: apple", Map.of("field", Map.of("query", "belkin", "f", "manu"))));
+    final JsonQueryRequest query =
+        new JsonQueryRequest().setQueries(queriesMap).setQuery(Map.of("param", "electronic"));
+    QueryResponse queryResponse = query.process(solrClient, COLLECTION_NAME);
+    // end::solrj-json-query-with-queries[]
+    assertEquals(expectedResults, queryResponse.getResults().getNumFound());
+  }
+
   @Test
   public void testJsonQueryWithJsonQueryParamOverrides() throws Exception {
     SolrClient solrClient = cluster.getSolrClient();

solr/solr-ref-guide/modules/query-guide/pages/json-combined-query-dsl.adoc

@@ -78,14 +78,21 @@ The query structure is similar to JSON Query DSL except for how multiple queries
 
 === Example
 
-Below is a sample JSON query payload:
+Below is an example with sample JSON query payload:
 
-```
+[tabs#json-query-with-queries]
+======
+curl::
++
+====
+[source,bash]
+----
+curl -X POST http://localhost:8983/solr/techproducts/query -d '
 {
     "queries": {
         "lexical1": {
             "lucene": {
-                "query": "title:sales"
+                "query": "name:apache"
             }
         },
         "vector": {
@@ -97,15 +104,37 @@ Below is a sample JSON query payload:
         }
     },
     "limit": 5,
-    "fields": ["id", "score", "title"],
+    "fields": ["id", "score", "name"],
     "params": {
         "combiner": true,
         "combiner.query": ["lexical1", "vector"],
         "combiner.algorithm": "rrf",
         "combiner.rrf.k": "15"
     }
-}
-```
+}'
+----
+====
+SolrJ::
++
+====
+[source,java,indent=0]
+----
+final Map<String, Object> queriesMap = new HashMap<>();
+queriesMap.put("lexical1", Map.of("lucene", Map.of("query", "apache", "df", "name")));
+queriesMap.put("vector", Map.of("knn", Map.of("query", [0.1,-0.34,0.89,0.02], "f", "vector", "topK", 5)));
+final JsonQueryRequest query =
+    new JsonQueryRequest()
+        .setQueries(queriesMap)
+        .withParam("id", "score", "name")
+        .setLimit(5)
+        .withParam("combiner", "true")
+        .withParam("combiner.query", List.of("lexical1", "vector"))
+        .withParam("combiner.algorithm", "rrf")
+        .withParam("combiner.rrf.k", "15");
+QueryResponse queryResponse = query.process(solrClient, COLLECTION_NAME);
+----
+====
+======
 
 == Combiner Algorithm Plugin
 

solr/solr-ref-guide/modules/query-guide/pages/json-query-dsl.adoc

@@ -388,6 +388,11 @@ Beware of arity for these references.
 Depending on the context, a reference might be resolved into the first element in the array ignoring the later elements, e.g., if one changes the reference below from `{"param":"electronic"}` to `{"param":"manufacturers"}`, it's equivalent to querying for `manu:apple`, ignoring the later query.
 These queries don't impact the query result until explicit referencing.
 
+[tabs#json-additional-queries]
+======
+curl::
++
+====
 [source,bash]
 ----
 curl -X POST http://localhost:8983/solr/techproducts/query -d '
@@ -402,6 +407,16 @@ curl -X POST http://localhost:8983/solr/techproducts/query -d '
     "query":{"param":"electronic"}
 }'
 ----
+====
+SolrJ::
++
+====
+[source,java,indent=0]
+----
+include::example$JsonRequestApiTest.java[tag=solrj-json-query-with-queries]
+----
+====
+======
 
 Overall this example doesn't make much sense, but just demonstrates the syntax.
 This feature is useful in xref:json-faceting-domain-changes.adoc#adding-domain-filters[filtering domain] in JSON Facet API xref:json-facet-api.adoc#changing-the-domain[domain changes].

solr/solrj/src/java/org/apache/solr/client/solrj/request/json/JsonQueryRequest.java

@@ -101,6 +101,30 @@ public JsonQueryRequest setQuery(Map<String, Object> queryJson) {
     return this;
   }
 
+  /**
+   * Specify the queries parameter sent as a part of JSON request.
+   *
+   * <p>This method would be helpful in setting the queries parameter specially for Combined Query
+   * Component {@code CombinedQueryComponent} use case.
+   *
+   * <p><b>Example:</b> You wish to send the JSON request:
+   *
+   * <pre>{@code {'limit': 5, 'queries': {'query1': {'lucene':
+   * {'df':'genre_s', 'query': 'scifi'}}}, 'query2': {'knn': {'f': 'vector', 'query': [0.1, 0.43]}}}}
+   * </pre>
+   *
+   * @param queriesJson a Map of values representing the query subtree of the JSON request you wish
+   *     to send.
+   * @throws IllegalArgumentException if {@code queriesJson} is null.
+   */
+  public JsonQueryRequest setQueries(Map<String, Object> queriesJson) {
+    if (queriesJson == null) {
+      throw new IllegalArgumentException("'queriesJson' parameter must be non-null");
+    }
+    jsonRequestMap.put("queries", queriesJson);
+    return this;
+  }
+
   /**
    * Specify the query sent as a part of this JSON request.
    *

solr/solrj/src/test/org/apache/solr/client/solrj/request/json/JsonQueryRequestIntegrationTest.java

@@ -20,6 +20,7 @@
 import java.io.IOException;
 import java.util.Collection;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import org.apache.solr.client.solrj.request.AbstractUpdateRequest;
 import org.apache.solr.client.solrj.request.CollectionAdminRequest;
@@ -45,6 +46,7 @@ public class JsonQueryRequestIntegrationTest extends SolrCloudTestCase {
   private static final int NUM_SCIFI_BOOKS = 2;
   private static final int NUM_IN_STOCK = 8;
   private static final int NUM_IN_STOCK_AND_FIRST_IN_SERIES = 5;
+  private static final int NUM_MARTIN_BOOKS = 3;
 
   @BeforeClass
   public static void setupCluster() throws Exception {
@@ -88,6 +90,30 @@ public void testQueriesCanUseLocalParamsSyntax() throws Exception {
     assertEquals(NUM_SCIFI_BOOKS, queryResponse.getResults().getNumFound());
   }
 
+  /**
+   * Test multiple queries can use local params syntax with Combined Query Component.
+   *
+   * @throws Exception the exception
+   */
+  @Test
+  public void testMultipleQueriesCanUseLocalParamsSyntax() throws Exception {
+    final Map<String, Object> queriesMap = new HashMap<>();
+    queriesMap.put("query1", "{!lucene df=genre_s v='scifi'}");
+    queriesMap.put("query2", "{!edismax df=author_t v='martin'}");
+    ModifiableSolrParams queryParams = new ModifiableSolrParams();
+    queryParams.set("qt", "/search");
+    final JsonQueryRequest query =
+        new JsonQueryRequest(queryParams)
+            .setQueries(queriesMap)
+            .withFilter("inStock:true")
+            .withParam("fl", "name")
+            .withParam("combiner", "true")
+            .withParam("combiner.query", List.of("query1", "query2"));
+    QueryResponse queryResponse = query.process(cluster.getSolrClient(), COLLECTION_NAME);
+    assertEquals(0, queryResponse.getStatus());
+    assertEquals(NUM_SCIFI_BOOKS + NUM_MARTIN_BOOKS, queryResponse.getResults().size());
+  }
+
   @Test
   public void testQueriesCanUseExpandedSyntax() throws Exception {
     // Construct a tree representing the JSON: {lucene: {df:'genre_s', 'query': 'scifi'}}

solr/solrj/src/test/org/apache/solr/client/solrj/request/json/JsonQueryRequestUnitTest.java

@@ -88,6 +88,17 @@ public void testWritesProvidedQueryMapToJsonCorrectly() {
         requestBody, containsString("\"query\":{\"lucene\":{\"q\":\"*:*\",\"df\":\"text\"}}"));
   }
 
+  @Test
+  public void testWritesProvidedQueriesMapToJsonCorrectly() {
+    final Map<String, Object> queriesMap = new HashMap<>();
+    queriesMap.put("query1", Map.of("lucene", Map.of("query", "*:*", "df", "text")));
+    queriesMap.put("query2", Map.of("edismax", Map.of("query", "solr", "df", "text")));
+    final JsonQueryRequest request = new JsonQueryRequest().setQueries(queriesMap);
+    final String requestBody = writeRequestToJson(request);
+    assertThat(requestBody, containsString("\"query1\":{\"lucene\":"));
+    assertThat(requestBody, containsString("\"query2\":{\"edismax\":"));
+  }
+
   @Test
   public void testWritesProvidedQueryMapWriterToJsonCorrectly() {
     final MapWriter queryWriter =