Add support for scan queries.

Author: kskalski

src/main/java/com/simplaex/clients/druid/DruidClientImpl.java

@@ -25,6 +25,9 @@
 import io.druid.query.metadata.SegmentMetadataQueryConfig;
 import io.druid.query.metadata.SegmentMetadataQueryQueryToolChest;
 import io.druid.query.metadata.metadata.SegmentMetadataQuery;
+import io.druid.query.scan.ScanQuery;
+import io.druid.query.scan.ScanQueryConfig;
+import io.druid.query.scan.ScanQueryQueryToolChest;
 import io.druid.query.search.SearchQueryQueryToolChest;
 import io.druid.query.search.SearchQuery;
 import io.druid.query.search.SearchQueryConfig;
@@ -273,6 +276,19 @@ public String getFormatString() {
     chestMap.put(TopNQuery.class, topNQueryQueryToolChest);
 
 
+    // scan queries
+
+    final ScanQueryConfig scanQueryConfig = new ScanQueryConfig();
+
+    final ScanQueryQueryToolChest scanToolChest =
+      new ScanQueryQueryToolChest(
+        scanQueryConfig,
+        genericQueryMetricsFactory
+      );
+
+    chestMap.put(ScanQuery.class, scanToolChest);
+
+
     return new MapQueryToolChestWarehouse(chestMap);
   }
 

src/test/java/com/simplaex/clients/druid/DruidClientTest.java

@@ -1,11 +1,13 @@
 package com.simplaex.clients.druid;
 
-
 import io.druid.query.Druids;
 import io.druid.query.Result;
+import io.druid.query.filter.DimFilters;
 import io.druid.query.metadata.metadata.AllColumnIncluderator;
 import io.druid.query.metadata.metadata.SegmentAnalysis;
 import io.druid.query.metadata.metadata.SegmentMetadataQuery;
+import io.druid.query.scan.ScanQuery;
+import io.druid.query.scan.ScanResultValue;
 import io.druid.query.select.EventHolder;
 import io.druid.query.select.PagingSpec;
 import io.druid.query.select.SelectQuery;
@@ -15,6 +17,9 @@
 import org.joda.time.Interval;
 import org.junit.*;
 import org.mockserver.integration.ClientAndServer;
+import org.mockserver.matchers.JsonStringMatcher;
+import org.mockserver.matchers.MatchType;
+import org.mockserver.matchers.Matcher;
 import org.mockserver.model.HttpRequest;
 import org.mockserver.model.HttpResponse;
 
@@ -138,7 +143,8 @@ public void shouldExecuteASelectQuery() throws IOException {
     final SelectQuery query = new Druids.SelectQueryBuilder()
         .dataSource("player_explorer_s3")
         .dimensions(Collections.singletonList("deviceType"))
-        .intervals(new MultipleIntervalSegmentSpec(Collections.singletonList(new Interval(from, to))))
+        .intervals(new MultipleIntervalSegmentSpec(
+                Collections.singletonList(new Interval(from, to))))
         .pagingSpec(new PagingSpec(Collections.emptyMap(), 100))
         .build();
 
@@ -169,4 +175,52 @@ public void shouldExecuteASelectQuery() throws IOException {
     );
   }
 
+  @Test
+  public void shouldExecuteAScanQuery() throws IOException {
+
+    setResponse(load("scan_query_response.json"));
+
+    final DruidClient client =
+        DruidClient.create("localhost", mockServer.getPort());
+
+    final long from = Instant.parse("2017-06-30T00:00:00Z").toEpochMilli();
+    final long to = Instant.parse("2020-10-02T00:00:00Z").toEpochMilli();
+
+    final ScanQuery query = new ScanQuery.ScanQueryBuilder()
+        .dataSource("player_explorer_s3")
+        .filters(DimFilters.dimEquals("version", "All"))
+        .resultFormat("compactList")
+        .columns(Arrays.asList("__time", "sessionCount", "deviceType"))
+        .intervals(new MultipleIntervalSegmentSpec(
+                Collections.singletonList(new Interval(from, to))))
+        .build();
+
+    final DruidResult<ScanResultValue> result = client.run(query);
+
+    // The http request body isn't marked as json, so can't use automatic json body matcher.
+    HttpRequest[] requests = mockServer.retrieveRecordedRequests(HttpRequest.request());
+    Assert.assertEquals("Single request should be recorded", 1, requests.length);
+    Matcher<String> jsonMatcher = new JsonStringMatcher(load("scan_query.json"), MatchType.ONLY_MATCHING_FIELDS);
+    String requestedJson = (String)requests[0].getBody().getValue();
+    Assert.assertTrue(
+            String.format("expected request json should match %s, but was %s", jsonMatcher, requestedJson),
+            jsonMatcher.matches(requestedJson));
+
+    final List<ScanResultValue> resultList = result.toList();
+
+    Assert.assertEquals("Number of results should be 11", 11, resultList.size());
+    ScanResultValue scanResult = resultList.get(10);
+
+    Assert.assertEquals("should have 3 columns", 3, scanResult.getColumns().size());
+    Assert.assertEquals(
+            "second columns should be sessionCount",
+            "sessionCount",
+            scanResult.getColumns().get(1));
+
+    final List<List<Object>> events = (List<List<Object>>) scanResult.getEvents();
+    Assert.assertEquals("should have 2 events", 2, events.size());
+
+    final List<Object> values = events.get(1);
+    Assert.assertEquals("the last event should have a sessionCount of 25", 25, values.get(1));
+  }
 }

src/test/resources/com/simplaex/clients/druid/scan_query.json

@@ -0,0 +1,7 @@
+{
+"queryType": "scan",
+"filter": {"type": "selector", "dimension": "version", "value": "All"},
+"resultFormat": "compactList",
+"intervals":{"type":"intervals","intervals":["2017-06-30T00:00:00.000Z/2020-10-02T00:00:00.000Z"]},
+"columns": ["__time", "sessionCount", "deviceType"]
+}

src/test/resources/com/simplaex/clients/druid/scan_query_response.json

@@ -0,0 +1,45 @@
+[ {
+  "segmentId" : "player_explorer_s3_2017-07-01T00:00:00.000Z_2017-07-02T00:00:00.000Z_2018-02-08T08:34:25.479Z_401",
+  "columns" : [ "__time", "sessionCount", "deviceType" ],
+  "events" : [ [ 1498867200000, 15, "Smartphone" ], [ 1498867200000, 25, "Smart-TV" ] ]
+}, {
+  "segmentId" : "player_explorer_s3_2017-07-02T00:00:00.000Z_2017-07-03T00:00:00.000Z_2018-02-09T21:09:39.596Z_333",
+  "columns" : [ "__time", "sessionCount", "deviceType" ],
+  "events" : [ [ 1498953600000, 145, "Smartphone" ] ]
+}, {
+  "segmentId" : "player_explorer_s3_2017-07-03T00:00:00.000Z_2017-07-04T00:00:00.000Z_2018-02-10T00:21:46.504Z_301",
+  "columns" : [ "__time", "sessionCount", "deviceType" ],
+  "events" : [ [ 1499040000000, 25, "Smartphone" ] ]
+}, {
+  "segmentId" : "player_explorer_s3_2017-07-04T00:00:00.000Z_2017-07-05T00:00:00.000Z_2018-02-10T03:30:51.706Z_306",
+  "columns" : [ "__time", "sessionCount", "deviceType" ],
+  "events" : [ [ 1499126400000, 17, "Smartphone" ] ]
+}, {
+  "segmentId" : "player_explorer_s3_2017-07-05T00:00:00.000Z_2017-07-06T00:00:00.000Z_2018-02-10T06:41:58.681Z_305",
+  "columns" : [ "__time", "sessionCount", "deviceType" ],
+  "events" : [ [ 1499212800000, 34, "Smartphone" ] ]
+}, {
+  "segmentId" : "player_explorer_s3_2017-07-06T00:00:00.000Z_2017-07-07T00:00:00.000Z_2018-02-10T09:51:58.586Z_261",
+  "columns" : [ "__time", "sessionCount", "deviceType" ],
+  "events" : [ [ 1499299200000, 45, "Smartphone" ] ]
+}, {
+  "segmentId" : "player_explorer_s3_2017-07-07T00:00:00.000Z_2017-07-08T00:00:00.000Z_2018-02-10T13:08:29.227Z_293",
+  "columns" : [ "__time", "sessionCount", "deviceType" ],
+  "events" : [ [ 1499385600000, 6, "Smartphone" ] ]
+}, {
+  "segmentId" : "player_explorer_s3_2017-07-08T00:00:00.000Z_2017-07-09T00:00:00.000Z_2018-02-10T16:16:55.837Z_293",
+  "columns" : [ "__time", "sessionCount", "deviceType" ],
+  "events" : [ [ 1499472000000, 233, "Smartphone" ], [ 1499472000000, 25, "Smart-TV" ] ]
+}, {
+  "segmentId" : "player_explorer_s3_2017-07-09T00:00:00.000Z_2017-07-10T00:00:00.000Z_2018-02-10T19:25:43.987Z_417",
+  "columns" : [ "__time", "sessionCount", "deviceType" ],
+  "events" : [ [ 1499558400000, 22, "Smartphone" ] ]
+}, {
+  "segmentId" : "player_explorer_s3_2017-07-10T00:00:00.000Z_2017-07-11T00:00:00.000Z_2018-02-09T05:04:25.460Z_248",
+  "columns" : [ "__time", "sessionCount", "deviceType" ],
+  "events" : [ [ 1499644800000, 355, "Smartphone" ] ]
+}, {
+  "segmentId" : "player_explorer_s3_2017-07-11T00:00:00.000Z_2017-07-12T00:00:00.000Z_2018-02-09T08:20:10.493Z_320",
+  "columns" : [ "__time", "sessionCount", "deviceType" ],
+  "events" : [ [ 1499731200000, 24, "Smartphone" ], [ 1499731200000, 25, "Smart-TV" ] ]
+} ]