Refactor rename method queryBindHash() to queryBindKey()

2026-11-12 22:41:35 +00:00 · 2021-08-11 13:25:04 +12:00
1 parent ec7c7048db
commit 144a3b54bb
@@ -54,9 +54,9 @@ public interface SpiExpression extends Expression {
  void queryPlanHash(StringBuilder builder);

  /**
-   * Return the hash value for the values that will be bound.
+   * Build the key for bind values of the query.
   */
-  void queryBindHash(BindValuesKey key);
+  void queryBindKey(BindValuesKey key);

  /**
   * Return true if the expression is the same with respect to bind values.
@@ -629,13 +629,11 @@ public interface SpiQuery<T> extends Query<T>, SpiQueryFetch, TxnProfileEventCod
  CQueryPlanKey prepare(SpiOrmQueryRequest<T> request);

  /**
-   * Calculate a hash based on the bind values used in the query.
+   * Build the key for the bind values used in the query (for l2 query cache).
   * <p>
-   * Combined with queryPlanHash() to return getQueryHash (a unique hash for a
-   * query).
-   * </p>
+   * Combined with queryPlanHash() to return queryHash (a unique key for a query).
   */
-  void queryBindHash(BindValuesKey key);
+  void queryBindKey(BindValuesKey key);

  /**
   * Identifies queries that are exactly the same including bind variables.
@@ -38,7 +38,7 @@ public abstract class AbstractTextExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    // do nothing, only execute against document store
  };

@@ -123,7 +123,7 @@ class AllEqualsExpression extends NonPrepareExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(propMap.size());
    for (Object value : propMap.values()) {
      key.add(value);
@@ -50,7 +50,7 @@ public class ArrayContainsExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(values.length);
    for (Object value : values) {
      key.add(value);
@@ -34,7 +34,7 @@ public class ArrayIsEmptyExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(empty);
  }

@@ -50,7 +50,7 @@ class BetweenExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(low()).add(high());
  }

@@ -96,7 +96,7 @@ class BetweenPropertyExpression extends NonPrepareExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(val());
  }

@@ -40,7 +40,7 @@ class BitwiseExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(flags).add(match);
  }

@@ -70,7 +70,7 @@ class CaseInsensitiveEqualExpression extends AbstractValueExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(val());
  }

@@ -238,14 +238,11 @@ public class DefaultExampleExpression implements SpiExpression, ExampleExpressio
    builder.append("]");
  }

-  /**
-   * Return a hash for the actual bind values used.
-   */
  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(list.size());
    for (SpiExpression expr : list) {
-      expr.queryBindHash(key);
+      expr.queryBindKey(key);
    }
  }

@@ -675,14 +675,11 @@ public class DefaultExpressionList<T> implements SpiExpressionList<T> {
    builder.append("]");
  }

-  /**
-   * Calculate a hash based on the expressions.
-   */
  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(list.size());
    for (SpiExpression expr : list) {
-      expr.queryBindHash(key);
+      expr.queryBindKey(key);
    }
  }

@@ -92,8 +92,8 @@ class ExistsQueryExpression implements SpiExpression, UnsupportedDocStoreExpress
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
-    subQuery.queryBindHash(key);
+  public void queryBindKey(BindValuesKey key) {
+    subQuery.queryBindKey(key);
  }

  @Override
@@ -78,7 +78,7 @@ class IdExpression extends NonPrepareExpression implements SpiExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(value);
  }

@@ -134,7 +134,7 @@ public class IdInExpression extends NonPrepareExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(idCollection.size());
    for (Object elem : idCollection) {
      key.add(elem);
@@ -177,7 +177,7 @@ class InExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(bindValues.size());
    for (Object bindValue : bindValues) {
      key.add(bindValue);
@@ -125,7 +125,7 @@ class InPairsExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(entries.size());
    for (Pairs.Entry entry : entries) {
      key.add(entry.getA()).add(entry.getB());
@@ -73,8 +73,8 @@ class InQueryExpression extends AbstractExpression implements UnsupportedDocStor
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
-    subQuery.queryBindHash(key);
+  public void queryBindKey(BindValuesKey key) {
+    subQuery.queryBindKey(key);
  }

  @Override
@@ -48,7 +48,7 @@ class InRangeExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(low()).add(high());
  }

@@ -104,7 +104,7 @@ class IsEmptyExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    // no bind values
  }

@@ -84,7 +84,7 @@ class JsonPathExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(value).add(upperValue);
  }

@@ -216,9 +216,9 @@ class JunctionExpression<T> implements SpiJunction<T>, SpiExpression, Expression
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    for (SpiExpression expr : exprList.internalList()) {
-      expr.queryBindHash(key);
+      expr.queryBindKey(key);
    }
  }

@@ -71,7 +71,7 @@ class LikeExpression extends AbstractValueExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(strValue());
  }

@@ -169,7 +169,7 @@ abstract class LogicExpression implements SpiExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(expOne).add(expTwo);
  }

@@ -55,7 +55,7 @@ class NativeILikeExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(val);
  }

@@ -80,8 +80,8 @@ class NestedPathWrapperExpression implements SpiExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
-    delegate.queryBindHash(key);
+  public void queryBindKey(BindValuesKey key) {
+    delegate.queryBindKey(key);
  }

  @Override
@@ -75,7 +75,7 @@ class NoopExpression implements SpiExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    // no bind values
  }

@@ -100,8 +100,8 @@ final class NotExpression implements SpiExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
-    exp.queryBindHash(key);
+  public void queryBindKey(BindValuesKey key) {
+    exp.queryBindKey(key);
  }

  @Override
@@ -95,7 +95,7 @@ class NullExpression extends AbstractExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(notNull);
  }
 }
@@ -74,7 +74,7 @@ class RawExpression extends NonPrepareExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(values.length);
    for (Object value : values) {
      key.add(value);
@@ -122,7 +122,7 @@ public class SimpleExpression extends AbstractValueExpression {
  }

  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(value());
  }

@@ -1218,17 +1218,11 @@ public class DefaultOrmQuery<T> extends AbstractQuery implements SpiQuery<T> {
    }
  }

-  /**
-   * Calculate a hash based on the bind values used in the query.
-   * <p>
-   * Used with queryPlanHash() to get a unique hash for a query.
-   * </p>
-   */
  @Override
-  public void queryBindHash(BindValuesKey key) {
+  public void queryBindKey(BindValuesKey key) {
    key.add(id);
-    if (whereExpressions != null) whereExpressions.queryBindHash(key);
-    if (havingExpressions != null) havingExpressions.queryBindHash(key);
+    if (whereExpressions != null) whereExpressions.queryBindKey(key);
+    if (havingExpressions != null) havingExpressions.queryBindKey(key);
    if (bindParams != null) bindParams.queryBindHash(key);
    key.add(asOf).add(versionsStart).add(versionsEnd);
  }
@@ -1245,7 +1239,7 @@ public class DefaultOrmQuery<T> extends AbstractQuery implements SpiQuery<T> {
    // calculateQueryPlanHash is called just after potential AutoTune tuning
    // so queryPlanHash is calculated well before this method is called
    BindValuesKey bindKey = new BindValuesKey();
-    queryBindHash(bindKey);
+    queryBindKey(bindKey);
    return new HashQuery(queryPlanKey, bindKey);
  }

@@ -71,7 +71,7 @@ public class RawExpressionTest extends BaseExpressionTest {

  private BindValuesKey bindKey(RawExpression query) {
    BindValuesKey bindValuesKey = new BindValuesKey();
-    query.queryBindHash(bindValuesKey);
+    query.queryBindKey(bindValuesKey);
    return bindValuesKey;
  }
 }
@@ -114,7 +114,7 @@ public class DefaultOrmQueryTest extends BaseTestCase {

  private BindValuesKey bindKey(DefaultOrmQuery<Order> query) {
    BindValuesKey key = new BindValuesKey();
-    query.queryBindHash(key);
+    query.queryBindKey(key);
    return key;
  }
 }