Add support for BYPASS CACHE to QueryBuilder

Add support for adding BYPASS CACHE clause to SELECT queries.

Fixes #155

Co-authored-by: Jeff Shaw <[email protected]>

Author: avelanarius

query-builder/src/main/java/com/datastax/oss/driver/api/querybuilder/select/Select.java

@@ -225,4 +225,12 @@ default Select orderBy(@NonNull String columnName, @NonNull ClusteringOrder orde
    */
   @NonNull
   Select usingTimeout(@NonNull BindMarker timeout);
+
+  /**
+   * Adds an BYPASS CACHE clause to this query.
+   *
+   * <p>This method is idempotent, calling it multiple times will only add a single clause.
+   */
+  @NonNull
+  Select bypassCache();
 }

query-builder/src/main/java/com/datastax/oss/driver/internal/querybuilder/select/DefaultSelect.java

@@ -57,6 +57,7 @@ public class DefaultSelect implements SelectFrom, Select {
   private final Object limit;
   private final Object perPartitionLimit;
   private final boolean allowsFiltering;
+  private final boolean bypassCache;
   private final Object timeout;
 
   public DefaultSelect(@Nullable CqlIdentifier keyspace, @NonNull CqlIdentifier table) {
@@ -72,6 +73,7 @@ public DefaultSelect(@Nullable CqlIdentifier keyspace, @NonNull CqlIdentifier ta
         null,
         null,
         false,
+        false,
         null);
   }
 
@@ -94,6 +96,7 @@ public DefaultSelect(
       @Nullable Object limit,
       @Nullable Object perPartitionLimit,
       boolean allowsFiltering,
+      boolean bypassCache,
       @Nullable Object timeout) {
     this.groupByClauses = groupByClauses;
     this.orderings = orderings;
@@ -111,6 +114,7 @@ public DefaultSelect(
     this.limit = limit;
     this.perPartitionLimit = perPartitionLimit;
     this.allowsFiltering = allowsFiltering;
+    this.bypassCache = bypassCache;
     Preconditions.checkArgument(
         timeout == null || timeout instanceof CqlDuration || timeout instanceof BindMarker,
         "TIMEOUT value must be a BindMarker or a CqlDuration");
@@ -132,6 +136,7 @@ public SelectFrom json() {
         limit,
         perPartitionLimit,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -150,6 +155,7 @@ public SelectFrom distinct() {
         limit,
         perPartitionLimit,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -210,6 +216,7 @@ public Select withSelectors(@NonNull ImmutableList<Selector> newSelectors) {
         limit,
         perPartitionLimit,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -239,6 +246,7 @@ public Select withRelations(@NonNull ImmutableList<Relation> newRelations) {
         limit,
         perPartitionLimit,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -268,6 +276,7 @@ public Select withGroupByClauses(@NonNull ImmutableList<Selector> newGroupByClau
         limit,
         perPartitionLimit,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -297,6 +306,7 @@ public Select withOrderings(@NonNull ImmutableMap<CqlIdentifier, ClusteringOrder
         limit,
         perPartitionLimit,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -316,6 +326,7 @@ public Select limit(int limit) {
         limit,
         perPartitionLimit,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -334,6 +345,7 @@ public Select limit(@Nullable BindMarker bindMarker) {
         bindMarker,
         perPartitionLimit,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -354,6 +366,7 @@ public Select perPartitionLimit(int perPartitionLimit) {
         limit,
         perPartitionLimit,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -372,6 +385,7 @@ public Select perPartitionLimit(@Nullable BindMarker bindMarker) {
         limit,
         bindMarker,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -390,8 +404,29 @@ public Select allowFiltering() {
         limit,
         perPartitionLimit,
         true,
+        bypassCache,
+        timeout);
+  }
+
+  @NonNull
+  @Override
+  public Select bypassCache() {
+    return new DefaultSelect(
+        keyspace,
+        table,
+        isJson,
+        isDistinct,
+        selectors,
+        relations,
+        groupByClauses,
+        orderings,
+        limit,
+        perPartitionLimit,
+        allowsFiltering,
+        true,
         timeout);
   }
+
   @NonNull
   @Override
   public Select usingTimeout(@NonNull final CqlDuration timeout) {
@@ -407,6 +442,7 @@ public Select usingTimeout(@NonNull final CqlDuration timeout) {
         limit,
         perPartitionLimit,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -425,6 +461,7 @@ public Select usingTimeout(@NonNull BindMarker timeout) {
         limit,
         perPartitionLimit,
         allowsFiltering,
+        bypassCache,
         timeout);
   }
 
@@ -482,6 +519,10 @@ public String asCql() {
       builder.append(" ALLOW FILTERING");
     }
 
+    if (bypassCache) {
+      builder.append(" BYPASS CACHE");
+    }
+
     if (timeout != null) {
       builder.append(" USING TIMEOUT ");
       if (timeout instanceof BindMarker) {
@@ -575,6 +616,10 @@ public boolean allowsFiltering() {
     return allowsFiltering;
   }
 
+  public boolean bypassesCache() {
+    return bypassCache;
+  }
+
   @Nullable
   public Object getTimeout() {
     return timeout;

query-builder/src/test/java/com/datastax/oss/driver/api/querybuilder/select/SelectBypassCacheTest.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2022 ScyllaDB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.datastax.oss.driver.api.querybuilder.select;
+
+import static com.datastax.oss.driver.api.querybuilder.Assertions.assertThat;
+import static com.datastax.oss.driver.api.querybuilder.QueryBuilder.selectFrom;
+
+import org.junit.Test;
+
+public class SelectBypassCacheTest {
+  @Test
+  public void should_generate_bypass_cache() {
+    assertThat(selectFrom("foo").all().bypassCache()).hasCql("SELECT * FROM foo BYPASS CACHE");
+  }
+
+  @Test
+  public void should_use_single_bypass_cache_if_called_multiple_times() {
+    assertThat(selectFrom("foo").all().bypassCache().bypassCache())
+        .hasCql("SELECT * FROM foo BYPASS CACHE");
+  }
+}