[DE-434] ArangoSearch cache

Author: rashtao

driver/src/main/java/com/arangodb/entity/arangosearch/CollectionLink.java

@@ -44,6 +44,7 @@ public final class CollectionLink {
     private Collection<FieldLink> fields;
     private Collection<FieldLink> nested;
     private Boolean inBackground;
+    private Boolean cache;
 
     private CollectionLink(final String name) {
         super();
@@ -135,6 +136,19 @@ public CollectionLink inBackground(final Boolean inBackground) {
         return this;
     }
 
+    /**
+     * @param cache If you enable this option, then field normalization values are always cached in memory. This can
+     *              improve the performance of scoring and ranking queries. Otherwise, these values are memory-mapped
+     *              and it is up to the operating system to load them from disk into memory and to evict them from
+     *              memory.
+     * @return link
+     * @since ArangoDB 3.9.5, Enterprise Edition only
+     */
+    public CollectionLink cache(final Boolean cache) {
+        this.cache = cache;
+        return this;
+    }
+
     @JsonIgnore
     public String getName() {
         return name;
@@ -169,4 +183,9 @@ public Collection<FieldLink> getNested() {
     public Boolean getInBackground() {
         return inBackground;
     }
+
+    public Boolean getCache() {
+        return cache;
+    }
+
 }

driver/src/main/java/com/arangodb/entity/arangosearch/StoredValue.java

@@ -36,16 +36,24 @@ public final class StoredValue {
 
     private final List<String> fields;
     private final ArangoSearchCompression compression;
+    private final Boolean cache;
 
     /**
      * @param fields      A list of attribute paths. The . character denotes sub-attributes.
      * @param compression Defines how to compress the attribute values.
+     * @param cache       Whether to cache stored values in memory. (Since ArangoDB 3.9.5, Enterprise Edition only)
      */
     @JsonCreator
     public StoredValue(@JsonProperty("fields") List<String> fields,
-                       @JsonProperty("compression") ArangoSearchCompression compression) {
+                       @JsonProperty("compression") ArangoSearchCompression compression,
+                       @JsonProperty("cache") Boolean cache) {
         this.fields = fields;
         this.compression = compression;
+        this.cache = cache;
+    }
+
+    public StoredValue(List<String> fields, ArangoSearchCompression compression) {
+        this(fields, compression, null);
     }
 
     public StoredValue(List<String> fields) {
@@ -60,16 +68,20 @@ public ArangoSearchCompression getCompression() {
         return compression;
     }
 
+    public Boolean getCache() {
+        return cache;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
         if (o == null || getClass() != o.getClass()) return false;
         StoredValue that = (StoredValue) o;
-        return Objects.equals(fields, that.fields) && compression == that.compression;
+        return Objects.equals(fields, that.fields) && compression == that.compression && Objects.equals(cache, that.cache);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(fields, compression);
+        return Objects.hash(fields, compression, cache);
     }
 }

driver/src/test/java/com/arangodb/ArangoSearchTest.java

@@ -657,11 +657,15 @@ void arangoSearchOptions(ArangoDatabase db) {
                 .includeAllFields(true)
                 .storeValues(StoreValuesType.ID)
                 .trackListPositions(false)
-                .inBackground(true);
+                .inBackground(true)
+                .cache(true);
+
         if (isEnterprise()) {
             link.nested(FieldLink.on("f3"));
         }
         ArangoSearchCreateOptions options = new ArangoSearchCreateOptions().link(link);
+        StoredValue storedValue = new StoredValue(Arrays.asList("a", "b"), ArangoSearchCompression.none, true);
+        options.storedValues(storedValue);
 
         final ArangoSearch view = db.arangoSearch(viewName);
         view.create(options);
@@ -679,6 +683,14 @@ void arangoSearchOptions(ArangoDatabase db) {
         assertThat(createdLink.getIncludeAllFields()).isTrue();
         assertThat(createdLink.getStoreValues()).isEqualTo(StoreValuesType.ID);
         assertThat(createdLink.getTrackListPositions()).isFalse();
+
+        if (isEnterprise() && isAtLeastVersion(3, 9, 5) && isLessThanVersion(3, 10)) {
+            assertThat(createdLink.getCache()).isTrue();
+            assertThat(properties.getStoredValues())
+                    .isNotEmpty()
+                    .allSatisfy(it -> assertThat(it.getCache()).isTrue());
+        }
+
         if (isEnterprise() && isAtLeastVersion(3, 10)) {
             assertThat(createdLink.getNested()).isNotEmpty();
             FieldLink nested = createdLink.getNested().iterator().next();