Add support for RediSearch 2.2 ON JSON (#44)

Author: dengliming

.github/workflows/build.yml

@@ -23,7 +23,7 @@ jobs:
         ports:
           - 6379:6379
       redisearch:
-        image: redislabs/redisearch:2.0.9
+        image: redislabs/redismod
         options: >-
           --health-cmd "redis-cli ping"
           --health-interval 10s

redisearch/pom.xml

@@ -15,6 +15,12 @@
             <groupId>io.github.dengliming.redismodule</groupId>
             <artifactId>commons</artifactId>
         </dependency>
+
+        <dependency>
+            <groupId>io.github.dengliming.redismodule</groupId>
+            <artifactId>redisjson</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
 </project>

redisearch/src/main/java/io/github/dengliming/redismodule/redisearch/RediSearch.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 dengliming.
+ * Copyright 2020-2022 dengliming.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -138,6 +138,10 @@ public RFuture<Boolean> alterIndexAsync(Field... fields) {
 
     private void appendFieldArgs(List<Object> args, Field field) {
         args.add(field.getName());
+        if (field.getAttribute() != null) {
+            args.add(Keywords.AS);
+            args.add(field.getAttribute());
+        }
         args.add(field.getFieldType().name());
         switch (field.getFieldType()) {
             case TAG:

redisearch/src/main/java/io/github/dengliming/redismodule/redisearch/index/IndexDefinition.java

@@ -0,0 +1,122 @@
+/*
+ * Copyright 2022 dengliming.
+ *
+ * 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 io.github.dengliming.redismodule.redisearch.index;
+
+import java.util.List;
+
+public class IndexDefinition {
+
+    public enum DataType {
+        HASH,
+        JSON
+    }
+
+    private final DataType dataType;
+
+    private boolean async;
+    private List<String> prefixes;
+    private String filter;
+    private RSLanguage languageField;
+    private RSLanguage language;
+    private String scoreFiled;
+    private double score = 1.0;
+    private String payloadField;
+
+    public IndexDefinition() {
+        this(DataType.HASH);
+    }
+
+    public IndexDefinition(DataType dataType) {
+        this.dataType = dataType;
+    }
+
+    public DataType getDataType() {
+        return dataType;
+    }
+
+    public boolean isAsync() {
+        return async;
+    }
+
+    public IndexDefinition setAsync(boolean async) {
+        this.async = async;
+        return this;
+    }
+
+    public List<String> getPrefixes() {
+        return prefixes;
+    }
+
+    public IndexDefinition setPrefixes(List<String> prefixes) {
+        this.prefixes = prefixes;
+        return this;
+    }
+
+    public String getFilter() {
+        return filter;
+    }
+
+    public IndexDefinition setFilter(String filter) {
+        this.filter = filter;
+        return this;
+    }
+
+    public RSLanguage getLanguageField() {
+        return languageField;
+    }
+
+    public IndexDefinition setLanguageField(RSLanguage languageField) {
+        this.languageField = languageField;
+        return this;
+    }
+
+    public RSLanguage getLanguage() {
+        return language;
+    }
+
+    public IndexDefinition setLanguage(RSLanguage language) {
+        this.language = language;
+        return this;
+    }
+
+    public String getScoreFiled() {
+        return scoreFiled;
+    }
+
+    public IndexDefinition setScoreFiled(String scoreFiled) {
+        this.scoreFiled = scoreFiled;
+        return this;
+    }
+
+    public double getScore() {
+        return score;
+    }
+
+    public IndexDefinition setScore(double score) {
+        this.score = score;
+        return this;
+    }
+
+    public String getPayloadField() {
+        return payloadField;
+    }
+
+    public IndexDefinition setPayloadField(String payloadField) {
+        this.payloadField = payloadField;
+        return this;
+    }
+}

redisearch/src/main/java/io/github/dengliming/redismodule/redisearch/index/IndexOptions.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 dengliming.
+ * Copyright 2020-2022 dengliming.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,6 +33,7 @@ public class IndexOptions {
     private boolean noHL;
     private List<String> stopwords;
     private List<String> prefixes;
+    private IndexDefinition definition;
 
     public long getExpire() {
         return expire;
@@ -105,17 +106,60 @@ public IndexOptions prefixes(List<String> prefixes) {
         return this;
     }
 
+    public IndexOptions definition(IndexDefinition definition) {
+        this.definition = definition;
+        return this;
+    }
+
+    public IndexDefinition getDefinition() {
+        return definition;
+    }
+
     public static IndexOptions defaultOptions() {
         return new IndexOptions();
     }
 
     public void build(List<Object> args) {
-
-        if (getPrefixes() != null) {
-            args.add(Keywords.PREFIX.name());
-            args.add(getPrefixes().size());
-            args.addAll(getPrefixes());
+        definition = getDefinition();
+        if (definition != null) {
+            args.add(Keywords.ON);
+            args.add(definition.getDataType());
+
+            if (definition.getPrefixes() != null) {
+                args.add(Keywords.PREFIX.name());
+                args.add(definition.getPrefixes().size());
+                args.addAll(definition.getPrefixes());
+            }
+
+            if (definition.getFilter() != null) {
+                args.add(Keywords.FILTER);
+                args.add(definition.getFilter());
+            }
+
+            if (definition.getLanguage() != null) {
+                args.add(Keywords.LANGUAGE);
+                args.add(definition.getLanguage());
+            }
+
+            if (definition.getLanguageField() != null) {
+                args.add(Keywords.LANGUAGE_FIELD);
+                args.add(definition.getLanguageField());
+            }
+
+            args.add(Keywords.SCORE);
+            args.add(definition.getScore());
+
+            if (definition.getScoreFiled() != null) {
+                args.add(Keywords.SCORE_FIELD);
+                args.add(definition.getScoreFiled());
+            }
+
+            if (definition.getPayloadField() != null) {
+                args.add(Keywords.PAYLOAD_FIELD);
+                args.add(definition.getPayloadField());
+            }
         }
+
         if (isMaxTextFields()) {
             args.add(Keywords.MAXTEXTFIELDS.name());
         }

redisearch/src/main/java/io/github/dengliming/redismodule/redisearch/index/schema/Field.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 dengliming.
+ * Copyright 2020-2022 dengliming.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@
  */
 public class Field {
     private String name;
+    private String attribute;
     private boolean sortable;
     private boolean noIndex;
     private FieldType fieldType;
@@ -55,4 +56,13 @@ public boolean isNoIndex() {
     public FieldType getFieldType() {
         return fieldType;
     }
+
+    public String getAttribute() {
+        return attribute;
+    }
+
+    public Field attribute(String attribute) {
+        this.attribute = attribute;
+        return this;
+    }
 }

redisearch/src/main/java/io/github/dengliming/redismodule/redisearch/protocol/Keywords.java

@@ -20,9 +20,9 @@
  * @author dengliming
  */
 public enum Keywords {
-    MAXTEXTFIELDS, TEMPORARY, NOOFFSETS, NOHL, FUZZY, WITHSCORES, WITHPAYLOADS, MAX, PAYLOAD, INCR, LANGUAGE, REPLACE,
+    MAXTEXTFIELDS, TEMPORARY, NOOFFSETS, NOHL, FUZZY, WITHSCORES, WITHPAYLOADS, MAX, PAYLOAD, INCR, LANGUAGE, LANGUAGE_FIELD, REPLACE, ON,
     DD, FIELDS, IF, NOSAVE, KEEPDOCS, NOINDEX, SORTABLE, PHONETIC, NOSTEM, WEIGHT, SEPARATOR, ADD, SCHEMA, STOPWORDS, PREFIX, NOFREQS, NOFIELDS,
-    NOCONTENT, VERBATIM, NOSTOPWORDS, WITHSORTKEYS, FILTER, GEOFILTER, INKEYS, INFIELDS, RETURN, SUMMARIZE, FRAGS, LEN,
-    HIGHLIGHT, TAGS, SLOP, INORDER, EXPANDER, SCORER, EXPLAINSCORE, SORTBY, LIMIT, AVG, REDUCE, STDDEV, COUNT, COUNT_DISTINCT,
+    NOCONTENT, VERBATIM, NOSTOPWORDS, WITHSORTKEYS, FILTER, GEOFILTER, INKEYS, INFIELDS, RETURN, SUMMARIZE, FRAGS, LEN, SCORE, SCORE_FIELD,
+    HIGHLIGHT, TAGS, SLOP, INORDER, EXPANDER, SCORER, EXPLAINSCORE, SORTBY, LIMIT, AVG, REDUCE, STDDEV, COUNT, COUNT_DISTINCT, PAYLOAD_FIELD,
     COUNT_DISTINCTISH, SUM, MIN, QUANTILE, TOLIST, FIRST_VALUE, BY, RANDOM_SAMPLE, GROUPBY, LOAD, APPLY, AS, DISTANCE, INCLUDE, EXCLUDE, TERMS;
 }

redisearch/src/test/java/io/github/dengliming/redismodule/redisearch/AbstractTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 dengliming.
+ * Copyright 2020-2022 dengliming.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,7 @@
 
 import io.github.dengliming.redismodule.common.util.TestSettings;
 import io.github.dengliming.redismodule.redisearch.client.RediSearchClient;
+import io.github.dengliming.redismodule.redisjson.client.RedisJSONClient;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.redisson.config.Config;
@@ -28,13 +29,16 @@
 public abstract class AbstractTest {
 
     private RediSearchClient rediSearchClient;
+    private RedisJSONClient redisJSONClient;
 
     @BeforeEach
     public void init() {
         Config config = new Config();
         config.useSingleServer().setAddress("redis://" + TestSettings.host() + ":" + TestSettings.port());
         rediSearchClient = new RediSearchClient(config);
+        redisJSONClient = new RedisJSONClient(config);
         rediSearchClient.flushall();
+        redisJSONClient.flushall();
     }
 
     @AfterEach
@@ -47,4 +51,9 @@ public void destroy() {
     protected RediSearchClient getRediSearchClient() {
         return rediSearchClient;
     }
+
+    protected RedisJSONClient getRedisJSONClient() {
+        return redisJSONClient;
+    }
 }
+