Support indexing of MISSING and EMPTY values (#3866)

sazzad16 · sazzad16 · commit 6db51a829113 · 2024-07-10T23:33:30.000+06:00
diff --git a/src/main/java/redis/clients/jedis/search/FTSearchParams.java b/src/main/java/redis/clients/jedis/search/FTSearchParams.java
@@ -142,7 +142,7 @@ public void addParams(CommandArguments args) {
     }
 
     if (params != null && !params.isEmpty()) {
-      args.add(PARAMS).add(params.size() * 2);
+      args.add(PARAMS).add(params.size() << 1);
       params.entrySet().forEach(entry -> args.add(entry.getKey()).add(entry.getValue()));
     }
 
diff --git a/src/main/java/redis/clients/jedis/search/Query.java b/src/main/java/redis/clients/jedis/search/Query.java
@@ -292,7 +292,7 @@ public void addParams(CommandArguments args) {
 
     if (_params != null && _params.size() > 0) {
       args.add(SearchKeyword.PARAMS.getRaw());
-      args.add(_params.size() * 2);
+      args.add(_params.size() << 1);
       for (Map.Entry<String, Object> entry : _params.entrySet()) {
         args.add(entry.getKey());
         args.add(entry.getValue());
diff --git a/src/main/java/redis/clients/jedis/search/Schema.java b/src/main/java/redis/clients/jedis/search/Schema.java
@@ -365,7 +365,7 @@ public VectorField(String name, VectorAlgo algorithm, Map<String, Object> attrib
     @Override
     public void addTypeArgs(CommandArguments args) {
       args.add(algorithm);
-      args.add(attributes.size() * 2);
+      args.add(attributes.size() << 1);
       for (Map.Entry<String, Object> entry : attributes.entrySet()) {
         args.add(entry.getKey());
         args.add(entry.getValue());
diff --git a/src/main/java/redis/clients/jedis/search/SearchProtocol.java b/src/main/java/redis/clients/jedis/search/SearchProtocol.java
@@ -56,7 +56,7 @@ public enum SearchKeyword implements Rawable {
     LANGUAGE_FIELD, SCORE, SCORE_FIELD, SCORER, PARAMS, AS, DIALECT, SLOP, TIMEOUT, INORDER,
     EXPANDER, MAXTEXTFIELDS, SKIPINITIALSCAN, WITHSUFFIXTRIE, NOSTEM, NOINDEX, PHONETIC, WEIGHT,
     CASESENSITIVE, LOAD, APPLY, GROUPBY, MAXIDLE, WITHCURSOR, DISTANCE, TERMS, INCLUDE, EXCLUDE,
-    SEARCH, AGGREGATE, QUERY, LIMITED, COUNT, REDUCE;
+    SEARCH, AGGREGATE, QUERY, LIMITED, COUNT, REDUCE, INDEXMISSING, INDEXEMPTY;
 
     private final byte[] raw;
 
diff --git a/src/main/java/redis/clients/jedis/search/aggr/AggregationBuilder.java b/src/main/java/redis/clients/jedis/search/aggr/AggregationBuilder.java
@@ -66,7 +66,7 @@ public AggregationBuilder limit(int count) {
 
   public AggregationBuilder sortBy(SortedField... fields) {
     aggrArgs.add(SearchKeyword.SORTBY);
-    aggrArgs.add(Integer.toString(fields.length * 2));
+    aggrArgs.add(fields.length << 1);
     for (SortedField field : fields) {
       aggrArgs.add(field.getField());
       aggrArgs.add(field.getOrder());
@@ -172,7 +172,7 @@ public AggregationBuilder timeout(long timeout) {
 
   public AggregationBuilder params(Map<String, Object> params) {
     aggrArgs.add(SearchKeyword.PARAMS);
-    aggrArgs.add(params.size() * 2);
+    aggrArgs.add(params.size() << 1);
     params.forEach((k, v) -> {
       aggrArgs.add(k);
       aggrArgs.add(v);
diff --git a/src/main/java/redis/clients/jedis/search/querybuilder/QueryNode.java b/src/main/java/redis/clients/jedis/search/querybuilder/QueryNode.java
@@ -61,11 +61,11 @@ public QueryNode add(Node... nodes) {
   protected boolean shouldParenthesize(Parenthesize mode) {
     if (mode == Parenthesize.ALWAYS) {
       return true;
-    }
-    if (mode == Parenthesize.NEVER) {
+    } else if (mode == Parenthesize.NEVER) {
       return false;
+    } else {
+      return children.size() > 1;
     }
-    return children.size() > 1;
   }
 
   @Override
diff --git a/src/main/java/redis/clients/jedis/search/schemafields/GeoField.java b/src/main/java/redis/clients/jedis/search/schemafields/GeoField.java
@@ -1,12 +1,16 @@
 package redis.clients.jedis.search.schemafields;
 
-import static redis.clients.jedis.search.SearchProtocol.SearchKeyword.GEO;
+import static redis.clients.jedis.search.SearchProtocol.SearchKeyword.*;
 
 import redis.clients.jedis.CommandArguments;
 import redis.clients.jedis.search.FieldName;
 
 public class GeoField extends SchemaField {
 
+  private boolean indexMissing;
+  private boolean sortable;
+  private boolean noIndex;
+
   public GeoField(String fieldName) {
     super(fieldName);
   }
@@ -29,9 +33,36 @@ public GeoField as(String attribute) {
     return this;
   }
 
+  public GeoField indexMissing() {
+    this.indexMissing = true;
+    return this;
+  }
+
+  public GeoField sortable() {
+    this.sortable = true;
+    return this;
+  }
+
+  public GeoField noIndex() {
+    this.noIndex = true;
+    return this;
+  }
+
   @Override
   public void addParams(CommandArguments args) {
     args.addParams(fieldName);
     args.add(GEO);
+
+    if (indexMissing) {
+      args.add(INDEXMISSING);
+    }
+
+    if (sortable) {
+      args.add(SORTABLE);
+    }
+
+    if (noIndex) {
+      args.add(NOINDEX);
+    }
   }
 }
diff --git a/src/main/java/redis/clients/jedis/search/schemafields/GeoShapeField.java b/src/main/java/redis/clients/jedis/search/schemafields/GeoShapeField.java
@@ -1,6 +1,6 @@
 package redis.clients.jedis.search.schemafields;
 
-import static redis.clients.jedis.search.SearchProtocol.SearchKeyword.GEOSHAPE;
+import static redis.clients.jedis.search.SearchProtocol.SearchKeyword.*;
 
 import redis.clients.jedis.CommandArguments;
 import redis.clients.jedis.search.FieldName;
@@ -22,6 +22,9 @@ public enum CoordinateSystem {
 
   private final CoordinateSystem system;
 
+  private boolean indexMissing;
+  private boolean noIndex;
+
   public GeoShapeField(String fieldName, CoordinateSystem system) {
     super(fieldName);
     this.system = system;
@@ -42,8 +45,26 @@ public GeoShapeField as(String attribute) {
     return this;
   }
 
+  public GeoShapeField indexMissing() {
+    this.indexMissing = true;
+    return this;
+  }
+
+  public GeoShapeField noIndex() {
+    this.noIndex = true;
+    return this;
+  }
+
   @Override
   public void addParams(CommandArguments args) {
     args.addParams(fieldName).add(GEOSHAPE).add(system);
+
+    if (indexMissing) {
+      args.add(INDEXMISSING);
+    }
+
+    if (noIndex) {
+      args.add(NOINDEX);
+    }
   }
 }
diff --git a/src/main/java/redis/clients/jedis/search/schemafields/NumericField.java b/src/main/java/redis/clients/jedis/search/schemafields/NumericField.java
@@ -1,14 +1,13 @@
 package redis.clients.jedis.search.schemafields;
 
-import static redis.clients.jedis.search.SearchProtocol.SearchKeyword.NOINDEX;
-import static redis.clients.jedis.search.SearchProtocol.SearchKeyword.NUMERIC;
-import static redis.clients.jedis.search.SearchProtocol.SearchKeyword.SORTABLE;
+import static redis.clients.jedis.search.SearchProtocol.SearchKeyword.*;
 
 import redis.clients.jedis.CommandArguments;
 import redis.clients.jedis.search.FieldName;
 
 public class NumericField extends SchemaField {
 
+  private boolean indexMissing;
   private boolean sortable;
   private boolean noIndex;
 
@@ -34,6 +33,11 @@ public NumericField as(String attribute) {
     return this;
   }
 
+  public NumericField indexMissing() {
+    this.indexMissing = true;
+    return this;
+  }
+
   /**
    * Sorts the results by the value of this field.
    */
@@ -55,6 +59,10 @@ public void addParams(CommandArguments args) {
     args.addParams(fieldName);
     args.add(NUMERIC);
 
+    if (indexMissing) {
+      args.add(INDEXMISSING);
+    }
+
     if (sortable) {
       args.add(SORTABLE);
     }
diff --git a/src/main/java/redis/clients/jedis/search/schemafields/TagField.java b/src/main/java/redis/clients/jedis/search/schemafields/TagField.java
@@ -8,12 +8,14 @@
 
 public class TagField extends SchemaField {
 
-  private boolean sortable;
-  private boolean sortableUNF;
-  private boolean noIndex;
+  private boolean indexMissing;
+  private boolean indexEmpty;
   private byte[] separator;
   private boolean caseSensitive;
   private boolean withSuffixTrie;
+  private boolean sortable;
+  private boolean sortableUNF;
+  private boolean noIndex;
 
   public TagField(String fieldName) {
     super(fieldName);
@@ -37,39 +39,19 @@ public TagField as(String attribute) {
     return this;
   }
 
-  /**
-   * Sorts the results by the value of this field.
-   */
-  public TagField sortable() {
-    this.sortable = true;
-    return this;
-  }
-
-  /**
-   * Sorts the results by the value of this field without normalization.
-   */
-  public TagField sortableUNF() {
-    this.sortableUNF = true;
+  public TagField indexMissing() {
+    this.indexMissing = true;
     return this;
   }
 
-  /**
-   * @see TextField#sortableUNF()
-   */
-  public TagField sortableUnNormalizedForm() {
-    return sortableUNF();
-  }
-
-  /**
-   * Avoid indexing.
-   */
-  public TagField noIndex() {
-    this.noIndex = true;
+  public TagField indexEmpty() {
+    this.indexEmpty = true;
     return this;
   }
 
   /**
    * Indicates how the text contained in the attribute is to be split into individual tags.
+   * @param separator
    */
   public TagField separator(char separator) {
     if (separator < 128) {
@@ -97,11 +79,51 @@ public TagField withSuffixTrie() {
     return this;
   }
 
+  /**
+   * Sorts the results by the value of this field.
+   */
+  public TagField sortable() {
+    this.sortable = true;
+    return this;
+  }
+
+  /**
+   * Sorts the results by the value of this field without normalization.
+   */
+  public TagField sortableUNF() {
+    this.sortableUNF = true;
+    return this;
+  }
+
+  /**
+   * @deprecated Use {@code TagField#sortableUNF()}.
+   * @see TagField#sortableUNF()
+   */
+  @Deprecated
+  public TagField sortableUnNormalizedForm() {
+    return sortableUNF();
+  }
+
+  /**
+   * Avoid indexing.
+   */
+  public TagField noIndex() {
+    this.noIndex = true;
+    return this;
+  }
+
   @Override
   public void addParams(CommandArguments args) {
     args.addParams(fieldName);
     args.add(TAG);
 
+    if (indexMissing) {
+      args.add(INDEXMISSING);
+    }
+    if (indexEmpty) {
+      args.add(INDEXEMPTY);
+    }
+
     if (separator != null) {
       args.add(SEPARATOR).add(separator);
     }
diff --git a/src/main/java/redis/clients/jedis/search/schemafields/TextField.java b/src/main/java/redis/clients/jedis/search/schemafields/TextField.java
diff --git a/src/main/java/redis/clients/jedis/search/schemafields/VectorField.java b/src/main/java/redis/clients/jedis/search/schemafields/VectorField.java
diff --git a/src/test/java/redis/clients/jedis/modules/search/SearchWithParamsTest.java b/src/test/java/redis/clients/jedis/modules/search/SearchWithParamsTest.java

Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ public void addParams(CommandArguments args) {`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`if (params != null && !params.isEmpty()) {`
`145`		`- args.add(PARAMS).add(params.size() * 2);`
	`145`	`+ args.add(PARAMS).add(params.size() << 1);`
`146`	`146`	`params.entrySet().forEach(entry -> args.add(entry.getKey()).add(entry.getValue()));`
`147`	`147`	`}`
`148`	`148`
Original file line number	Diff line number	Diff line change
`@@ -61,11 +61,11 @@ public QueryNode add(Node... nodes) {`
`61`	`61`	`protected boolean shouldParenthesize(Parenthesize mode) {`
`62`	`62`	`if (mode == Parenthesize.ALWAYS) {`
`63`	`63`	`return true;`
`64`		`- }`
`65`		`- if (mode == Parenthesize.NEVER) {`
	`64`	`+ } else if (mode == Parenthesize.NEVER) {`
`66`	`65`	`return false;`
	`66`	`+ } else {`
	`67`	`+ return children.size() > 1;`
`67`	`68`	`}`
`68`		`- return children.size() > 1;`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`@Override`