[DE-373] index stored values

(cherry picked from commit 0d1f01a)

Author: rashtao

src/main/java/com/arangodb/entity/IndexEntity.java

@@ -43,6 +43,7 @@ public final class IndexEntity {
     private Boolean inBackground;
     private Boolean estimates;
     private Boolean cacheEnabled;
+    private Collection<String> storedValues;
     private Boolean legacyPolygons;
 
     public IndexEntity() {
@@ -113,6 +114,10 @@ public Boolean getCacheEnabled() {
         return cacheEnabled;
     }
 
+    public Collection<String> getStoredValues() {
+        return storedValues;
+    }
+
     public Boolean getLegacyPolygons() {
         return legacyPolygons;
     }

src/main/java/com/arangodb/model/PersistentIndexOptions.java

@@ -22,6 +22,10 @@
 
 import com.arangodb.entity.IndexType;
 
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
+
 /**
  * @author Mark Vollmary
  * @see <a href="https://www.arangodb.com/docs/stable/http/indexes-persistent.html#create-a-persistent-index">API
@@ -36,6 +40,7 @@ public final class PersistentIndexOptions extends IndexOptions<PersistentIndexOp
     private Boolean deduplicate;
     private Boolean estimates;
     private Boolean cacheEnabled;
+    private Collection<String> storedValues;
 
     public PersistentIndexOptions() {
         super();
@@ -119,6 +124,7 @@ public Boolean getEstimates() {
 
     /**
      * @param cacheEnabled enables in-memory caching of index entries
+     * @return options
      * @since ArangoDB 3.10
      */
     public PersistentIndexOptions cacheEnabled(final Boolean cacheEnabled) {
@@ -130,4 +136,23 @@ public Boolean getCacheEnabled() {
         return cacheEnabled;
     }
 
+    public Collection<String> getStoredValues() {
+        return storedValues;
+    }
+
+    /**
+     * @param storedValues (optional) array of paths to additional attributes to store in the index. These additional
+     *                     attributes cannot be used for index lookups or for sorting, but they can be used for
+     *                     projections. This allows an index to fully cover more queries and avoid extra document
+     *                     lookups. The maximum number of attributes in `storedValues` is 32.
+     * @return options
+     */
+    public PersistentIndexOptions storedValues(final String... storedValues) {
+        if (this.storedValues == null) {
+            this.storedValues = new HashSet<>();
+        }
+        Collections.addAll(this.storedValues, storedValues);
+        return this;
+    }
+
 }

src/test/java/com/arangodb/ArangoCollectionTest.java

@@ -1514,6 +1514,33 @@ void createPersistentIndexCacheEnabled(ArangoCollection collection) {
         assertThat(indexResult.getCacheEnabled()).isTrue();
     }
 
+    @ParameterizedTest(name = "{index}")
+    @MethodSource("cols")
+    void createPersistentIndexStoredValues(ArangoCollection collection) {
+        assumeTrue(isAtLeastVersion(3, 10));
+
+        String f1 = "field-" + rnd();
+        String f2 = "field-" + rnd();
+        final Collection<String> fields = Arrays.asList(f1, f2);
+
+        final IndexEntity indexResult = collection.ensurePersistentIndex(fields, new PersistentIndexOptions().storedValues("v1", "v2"));
+        assertThat(indexResult).isNotNull();
+        assertThat(indexResult.getConstraint()).isNull();
+        assertThat(indexResult.getFields()).contains(f1);
+        assertThat(indexResult.getFields()).contains(f2);
+        assertThat(indexResult.getId()).startsWith(COLLECTION_NAME);
+        assertThat(indexResult.getIsNewlyCreated()).isTrue();
+        assertThat(indexResult.getMinLength()).isNull();
+        assertThat(indexResult.getSparse()).isFalse();
+        assertThat(indexResult.getType()).isEqualTo(IndexType.persistent);
+        assertThat(indexResult.getUnique()).isFalse();
+        assertThat(indexResult.getDeduplicate()).isTrue();
+        assertThat(indexResult.getCacheEnabled()).isFalse();
+        assertThat(indexResult.getStoredValues())
+                .hasSize(2)
+                .contains("v1", "v2");
+    }
+
     @ParameterizedTest(name = "{index}")
     @MethodSource("cols")
     void createPersistentIndexWithOptions(ArangoCollection collection) {