added support for persistent indexes

jsteemann · jsteemann · commit 0801ad8c4761 · 2016-10-26T16:13:53.000+02:00
diff --git a/lib/triagens/ArangoDb/CollectionHandler.php b/lib/triagens/ArangoDb/CollectionHandler.php
@@ -168,6 +168,11 @@ class CollectionHandler extends
      * skiplist index option
      */
     const OPTION_SKIPLIST_INDEX = 'skiplist';
+    
+    /**
+     * persistent index option
+     */
+    const OPTION_PERSISTENT_INDEX = 'persistent';
 
     /**
      * sparse index option
@@ -907,6 +912,33 @@ public function createSkipListIndex($collectionId, array $fields, $unique = null
 
         return $this->index($collectionId, self::OPTION_SKIPLIST_INDEX, $fields, null, $indexOptions);
     }
+    
+    /**
+     * Create a persistent index
+     *
+     * @param string $collectionId - the collection id
+     * @param array  $fields       - an array of fields
+     * @param bool   $unique       - whether the index is unique or not
+     * @param bool   $sparse       - whether the index should be sparse
+     *
+     * @link https://docs.arangodb.com/HttpIndexes/Skiplist.html
+     *
+     * @return array - server response of the created index
+     * @throws \triagens\ArangoDb\Exception
+     */
+    public function createPersistentIndex($collectionId, array $fields, $unique = null, $sparse = null)
+    {
+        $indexOptions = [];
+
+        if ($unique) {
+            $indexOptions[self::OPTION_UNIQUE] = (bool) $unique;
+        }
+        if ($sparse) {
+            $indexOptions[self::OPTION_SPARSE] = (bool) $sparse;
+        }
+
+        return $this->index($collectionId, self::OPTION_PERSISTENT_INDEX, $fields, null, $indexOptions);
+    }
 
     /**
      * Create a geo index
@@ -957,7 +989,7 @@ public function createGeoIndex(
      * @throws Exception
      *
      * @param mixed  $collectionId - The id of the collection where the index is to be created
-     * @param string $type         - index type: hash, skiplist or geo
+     * @param string $type         - index type: hash, skiplist, geo, fulltext, or persistent
      * @param array  $attributes   - an array of attributes that can be defined like array('a') or array('a', 'b.c')
      * @param bool   $unique       - true/false to create a unique index
      * @param array  $indexOptions - an associative array of options for the index like array('geoJson' => true, 'sparse' => false)
diff --git a/tests/CollectionBasicTest.php b/tests/CollectionBasicTest.php
@@ -692,6 +692,75 @@ public function testCreateSparseSkipListIndex()
             static::assertTrue($indexInfo[CollectionHandler::OPTION_SPARSE], 'sparse flag was not set to true!');
         }
     }
+    
+    
+    /**
+     * Create a persistent index and verify it by getting information about the index from the server
+     */
+    public function testCreatePersistentIndex()
+    {
+        $result = $this->collectionHandler->createPersistentIndex(
+            'ArangoDB_PHP_TestSuite_IndexTestCollection',
+            ['field1', 'field2'],
+            true
+        );
+
+        $indices = $this->collectionHandler->getIndexes('ArangoDB_PHP_TestSuite_IndexTestCollection');
+
+        $indicesByIdentifiers = $indices['identifiers'];
+
+        static::assertArrayHasKey($result['id'], $indicesByIdentifiers, 'persistent index was not created!');
+
+        $indexInfo = $indicesByIdentifiers[$result['id']];
+
+        static::assertEquals(
+            CollectionHandler::OPTION_PERSISTENT_INDEX,
+            $indexInfo[CollectionHandler::OPTION_TYPE],
+            "Index type is not 'persistent'!"
+        );
+        static::assertCount(2, $indexInfo['fields'], 'There should only be 2 indexed fields');
+        static::assertEquals('field1', $indexInfo['fields'][0], "The indexed field is not 'field1'");
+        static::assertEquals('field2', $indexInfo['fields'][1], "The indexed field is not 'field2'");
+        static::assertTrue($indexInfo[CollectionHandler::OPTION_UNIQUE], 'unique was not set to true!');
+        if ($this->hasSparseIndexes) {
+            static::assertFalse($indexInfo[CollectionHandler::OPTION_SPARSE], 'sparse flag was not set to false!');
+        }
+    }
+
+
+    /**
+     * Create a sparse persistent index and verify it by getting information about the index from the server
+     */
+    public function testCreateSparsePersistentIndex()
+    {
+        $result = $this->collectionHandler->createPersistentIndex(
+            'ArangoDB_PHP_TestSuite_IndexTestCollection',
+            ['field1', 'field2'],
+            false,
+            ['sparse' => true]
+        );
+
+        $indices = $this->collectionHandler->getIndexes('ArangoDB_PHP_TestSuite_IndexTestCollection');
+
+        $indicesByIdentifiers = $indices['identifiers'];
+
+        static::assertArrayHasKey($result['id'], $indicesByIdentifiers, 'persistent index was not created!');
+
+        $indexInfo = $indicesByIdentifiers[$result['id']];
+
+        static::assertEquals(
+            CollectionHandler::OPTION_PERSISTENT_INDEX,
+            $indexInfo[CollectionHandler::OPTION_TYPE],
+            "Index type is not 'persistent'!"
+        );
+        static::assertCount(2, $indexInfo['fields'], 'There should only be 2 indexed fields');
+        static::assertEquals('field1', $indexInfo['fields'][0], "The indexed field is not 'field1'");
+        static::assertEquals('field2', $indexInfo['fields'][1], "The indexed field is not 'field2'");
+        static::assertFalse($indexInfo[CollectionHandler::OPTION_UNIQUE], 'unique was not set to false!');
+        if ($this->hasSparseIndexes) {
+            static::assertTrue($indexInfo[CollectionHandler::OPTION_SPARSE], 'sparse flag was not set to true!');
+        }
+    }
 
 
     /**
