Datastore: Add skippedResults in QueryResults (#4093)

ajaaym · chingor13 · commit a5b830f3dd07 · 2018-11-27T10:54:19.000-08:00
* Fix #3279 google-cloud-datastore Java library exposes too little of the information in query results * fix typo in comment
diff --git a/google-cloud-datastore/src/main/java/com/google/cloud/datastore/QueryResults.java b/google-cloud-datastore/src/main/java/com/google/cloud/datastore/QueryResults.java
@@ -55,4 +55,19 @@ public interface QueryResults<V> extends Iterator<V> {
    * }</pre>
    */
   Cursor getCursorAfter();
+
+  /**
+   * Returns the number of results skipped, typically because of an offset.
+   *
+   * <p>A simple use case to count entities:
+   *
+   * <pre>{@code
+   * Query<Key> query = Query.newKeyQueryBuilder().setOffset(Integer.MAX_VALUE).build();
+   * QueryResults<Key> result = datasore.datastore.run(query);
+   * if (!result.hasNext()) {
+   *  int numberOfEntities = result.getSkippedResults();
+   * }
+   * }</pre>
+   */
+  int getSkippedResults();
 }
diff --git a/google-cloud-datastore/src/main/java/com/google/cloud/datastore/QueryResultsImpl.java b/google-cloud-datastore/src/main/java/com/google/cloud/datastore/QueryResultsImpl.java
@@ -114,4 +114,9 @@ public Class<?> getResultClass() {
   public Cursor getCursorAfter() {
     return new Cursor(cursor);
   }
+
+  @Override
+  public int getSkippedResults() {
+    return runQueryResponsePb.getBatch().getSkippedResults();
+  }
 }
diff --git a/google-cloud-datastore/src/test/java/com/google/cloud/datastore/DatastoreTest.java b/google-cloud-datastore/src/test/java/com/google/cloud/datastore/DatastoreTest.java
@@ -633,6 +633,13 @@ public void testQueryPaginationWithLimit() throws DatastoreException {
     EasyMock.verify(rpcFactoryMock, rpcMock);
   }
 
+  @Test
+  public void testRunKeyQueryWithOffset() {
+    Query<Key> query = Query.newKeyQueryBuilder().setOffset(Integer.MAX_VALUE).build();
+    int numberOfEntities = datastore.run(query).getSkippedResults();
+    assertEquals(2, numberOfEntities);
+  }
+
   private List<RunQueryResponse> buildResponsesForQueryPaginationWithLimit() {
     Entity entity4 = Entity.newBuilder(KEY4).set("value", StringValue.of("value")).build();
     Entity entity5 = Entity.newBuilder(KEY5).set("value", "value").build();
diff --git a/google-cloud-datastore/src/test/java/com/google/cloud/datastore/it/ITDatastoreTest.java b/google-cloud-datastore/src/test/java/com/google/cloud/datastore/it/ITDatastoreTest.java
@@ -851,4 +851,11 @@ public Integer run(DatastoreReaderWriter transaction) {
       assertEquals(3, ((DatastoreException) expected.getCause()).getCode());
     }
   }
+
+  @Test
+  public void testSkippedResults() {
+    Query<Key> query = Query.newKeyQueryBuilder().setOffset(Integer.MAX_VALUE).build();
+    int numberOfEntities = DATASTORE.run(query).getSkippedResults();
+    assertEquals(2, numberOfEntities);
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -114,4 +114,9 @@ public Class<?> getResultClass() {`
`114`	`114`	`public Cursor getCursorAfter() {`
`115`	`115`	`return new Cursor(cursor);`
`116`	`116`	`}`
	`117`	`+`
	`118`	`+ @Override`
	`119`	`+ public int getSkippedResults() {`
	`120`	`+ return runQueryResponsePb.getBatch().getSkippedResults();`
	`121`	`+ }`
`117`	`122`	`}`
Original file line number	Diff line number	Diff line change
`@@ -851,4 +851,11 @@ public Integer run(DatastoreReaderWriter transaction) {`
`851`	`851`	`assertEquals(3, ((DatastoreException) expected.getCause()).getCode());`
`852`	`852`	`}`
`853`	`853`	`}`
	`854`	`+`
	`855`	`+ @Test`
	`856`	`+ public void testSkippedResults() {`
	`857`	`+ Query<Key> query = Query.newKeyQueryBuilder().setOffset(Integer.MAX_VALUE).build();`
	`858`	`+ int numberOfEntities = DATASTORE.run(query).getSkippedResults();`
	`859`	`+ assertEquals(2, numberOfEntities);`
	`860`	`+ }`
`854`	`861`	`}`