[DE-104]: deprecate skiplist and hash indexes

jsteemann · jsteemann · commit b36e96739e94 · 2021-12-01T19:54:43.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Changelog
 
+## Release notes for the ArangoDB-PHP driver 3.10.x
+
+Using the index types "hash", "skiplist" or "fulltext" is deprecated. 
+With the RocksDB storage engine, "hash" and "skiplist" indexes are mere aliases of
+the "persistent" index type. Thus the "persistent" index is the preferred type to
+use from the PHP driver as well.
+
+ArangoDB 3.10 also deprecates the usage of fulltext indexes, so using the "fulltext"
+index type from the PHP driver is also deprecated.
+
 ## Release notes for the ArangoDB-PHP driver 3.9.x
 
 This version of the PHP driver is compatible with PHP versions 7.4 and 8.0.
diff --git a/lib/ArangoDBClient/CollectionHandler.php b/lib/ArangoDBClient/CollectionHandler.php
@@ -144,11 +144,13 @@ class CollectionHandler extends Handler
 
     /**
      * hash index option
+     * @deprecated "hash" is now an alias for "persistent". use "persistent" instead
      */
     const OPTION_HASH_INDEX = 'hash';
 
     /**
      * fulltext index option
+     * @deprecated fulltext indexes are deprecated from ArangoDB 3.10 onwards
      */
     const OPTION_FULLTEXT_INDEX = 'fulltext';
 
@@ -159,6 +161,7 @@ class CollectionHandler extends Handler
 
     /**
      * skiplist index option
+     * @deprecated "skiplist" is now an alias for "persistent". use "persistent" instead
      */
     const OPTION_SKIPLIST_INDEX = 'skiplist';
 
@@ -897,7 +900,7 @@ public function createHashIndex($collection, array $fields, $unique = null, $spa
      * @param int    $minLength    - the minimum length of words to index
      * @param bool   $inBackground - true if index shall be created in background
      *
-     * @deprecated use CollectionHandler::createIndex instead
+     * @deprecated use CollectionHandler::createIndex instead. additionally, fulltext indexes are deprecated from ArangoDB 3.10 onwards
      *
      * @return array - server response of the created index
      * @throws \ArangoDBClient\Exception
diff --git a/tests/.phpunit.result.cache b/tests/.phpunit.result.cache
diff --git a/tests/CollectionBasicTest.php b/tests/CollectionBasicTest.php
@@ -790,8 +790,8 @@ public function testCreateIndex()
     {
         $result = $this->collectionHandler->createIndex(
             'ArangoDB_PHP_TestSuite_IndexTestCollection' . '_' . static::$testsTimestamp, [
-                'type' => 'hash',
-                'name' => 'mr-hash',
+                'type' => 'persistent',
+                'name' => 'mr-persistent',
                 'fields' => ['a', 'b'],
                 'unique' => true,
                 'sparse' => true,
@@ -807,11 +807,11 @@ public function testCreateIndex()
 
         $indexInfo = $indicesByIdentifiers[$result['id']];
 
-        static::assertEquals('hash', $indexInfo[CollectionHandler::OPTION_TYPE]);
+        static::assertEquals('persistent', $indexInfo[CollectionHandler::OPTION_TYPE]);
         static::assertEquals(['a', 'b'], $indexInfo['fields']);
         static::assertTrue($indexInfo['unique']);
         static::assertTrue($indexInfo['sparse']);
-        static::assertEquals('mr-hash', $indexInfo['name']);
+        static::assertEquals('mr-persistent', $indexInfo['name']);
     }
     
     
@@ -848,20 +848,18 @@ public function testGetIndexByName()
     {
         $result = $this->collectionHandler->createIndex(
             'ArangoDB_PHP_TestSuite_IndexTestCollection' . '_' . static::$testsTimestamp, [
-                'type' => 'fulltext',
+                'type' => 'persistent',
                 'name' => 'this-is-an-index',
                 'fields' => ['c'],
-                'minLength' => 4,
             ]
         ); 
         
         $indexInfo = $this->collectionHandler->getIndex('ArangoDB_PHP_TestSuite_IndexTestCollection' . '_' . static::$testsTimestamp, $result['id']);
 
-        static::assertEquals('fulltext', $indexInfo[CollectionHandler::OPTION_TYPE]);
+        static::assertEquals('persistent', $indexInfo[CollectionHandler::OPTION_TYPE]);
         static::assertEquals(['c'], $indexInfo['fields']);
         static::assertFalse($indexInfo['unique']);
-        static::assertTrue($indexInfo['sparse']);
-        static::assertEquals(4, $indexInfo['minLength']);
+        static::assertFalse($indexInfo['sparse']);
         static::assertEquals('this-is-an-index', $indexInfo['name']);
     }
     
@@ -872,10 +870,9 @@ public function testDropIndexById()
     {
         $result = $this->collectionHandler->createIndex(
             'ArangoDB_PHP_TestSuite_IndexTestCollection' . '_' . static::$testsTimestamp, [
-                'type' => 'fulltext',
+                'type' => 'persistent',
                 'name' => 'this-is-an-index',
                 'fields' => ['c'],
-                'minLength' => 4,
             ]
         ); 
         
@@ -891,10 +888,9 @@ public function testDropIndexByName()
     {
         $result = $this->collectionHandler->createIndex(
             'ArangoDB_PHP_TestSuite_IndexTestCollection' . '_' . static::$testsTimestamp, [
-                'type' => 'fulltext',
+                'type' => 'persistent',
                 'name' => 'this-is-an-index',
                 'fields' => ['c'],
-                'minLength' => 4,
             ]
         ); 
         
@@ -960,6 +956,7 @@ public function testCreateGeo2Index()
 
     /**
      * Create a hash index and verify it by getting information about the index from the server
+     * @deprecated the "hash" index type is deprecated on the server side
      */
     public function testCreateHashIndex()
     {
@@ -994,6 +991,7 @@ public function testCreateHashIndex()
 
     /**
      * Create a sparse hash index and verify it by getting information about the index from the server
+     * @deprecated the "hash" index type is deprecated on the server side
      */
     public function testCreateSparseHashIndex()
     {
@@ -1029,6 +1027,7 @@ public function testCreateSparseHashIndex()
 
     /**
      * Create a fulltext index and verify it by getting information about the index from the server
+     * @deprecated the "fulltext" index type is deprecated from ArangoDB 3.10 onwards
      */
     public function testCreateFulltextIndex()
     {
@@ -1059,6 +1058,7 @@ public function testCreateFulltextIndex()
 
     /**
      * Create a skiplist index and verify it by getting information about the index from the server
+     * @deprecated the "skiplist" index type is deprecated on the server side
      */
     public function testCreateSkipListIndex()
     {
@@ -1091,6 +1091,7 @@ public function testCreateSkipListIndex()
 
     /**
      * Create a sparse skiplist index and verify it by getting information about the index from the server
+     * @deprecated the "skiplist" index type is deprecated on the server side
      */
     public function testCreateSparseSkipListIndex()
     {
@@ -1221,6 +1222,7 @@ public function testCreateTtlIndex()
 
     /**
      * Test creating an index and getting it to verify.
+     * @deprecated the "fulltext" index type is deprecated from ArangoDB 3.10 onwards
      */
     public function testGetIndex()
     {
@@ -1251,12 +1253,14 @@ public function testGetIndex()
      */
     public function testCreateIndexInBackground()
     {
-        $result = $this->collectionHandler->createHashIndex(
-            'ArangoDB_PHP_TestSuite_IndexTestCollection' . '_' . static::$testsTimestamp,
-            ['test'],
-            false, 
-            false, 
-            true
+        $result = $this->collectionHandler->createIndex(
+            'ArangoDB_PHP_TestSuite_IndexTestCollection' . '_' . static::$testsTimestamp, [
+                'type' => 'persistent',
+                'fields' => ['test'],
+                'unique' => false,
+                'sparse' => false,
+                'inBackground' => true
+            ]
         );
 
         $indices = $this->collectionHandler->getIndexes('ArangoDB_PHP_TestSuite_IndexTestCollection' . '_' . static::$testsTimestamp);
@@ -1268,7 +1272,7 @@ public function testCreateIndexInBackground()
         $indexInfo = $indicesByIdentifiers[$result['id']];
 
         static::assertEquals(
-            CollectionHandler::OPTION_HASH_INDEX,
+            CollectionHandler::OPTION_PERSISTENT_INDEX,
             $indexInfo[CollectionHandler::OPTION_TYPE]
         );
         static::assertEquals(['test'], $indexInfo['fields']);
diff --git a/tests/CollectionExtendedTest.php b/tests/CollectionExtendedTest.php
@@ -2038,6 +2038,7 @@ public function testGetAll()
     
     /**
      * test for creation of a hash index
+     * @deprecated the "hash" index type is deprecated on the server side
      */
     public function testCreateHashIndex()
     {
@@ -2070,7 +2071,7 @@ public function testCreateHashIndex()
     /**
      * test for creation of a hash index, uniqueness violation
      */
-    public function testCreateUniqueHashIndex()
+    public function testCreateUniquePersistentIndex()
     {
         // set up collections, indexes and test-documents
         $collectionHandler = $this->collectionHandler;
@@ -2086,7 +2087,7 @@ public function testCreateUniqueHashIndex()
         $documentHandler->save($collection->getName(), $document2);
 
         try {
-            $collectionHandler->index($collection->getName(), 'hash', ['index'], true);
+            $collectionHandler->index($collection->getName(), 'persistent', ['index'], true);
         } catch (ServerException $e) {
             static::assertInstanceOf(
                 ServerException::class,
@@ -2105,6 +2106,7 @@ public function testCreateUniqueHashIndex()
 
     /**
      * test for creation of a skip-list indexed collection and querying by range (first level and nested), with closed, skip and limit options
+     * @deprecated the functionality is deprecated on the server side
      */
 
     public function testCreateSkipListIndexedCollectionAddDocumentsAndQueryRange()
@@ -2456,6 +2458,7 @@ public function testCreateGeoIndexedCollectionAddDocumentsAndQueryWithin()
 
     /**
      * test for creation of a fulltext indexed collection and querying by within, with distance, skip and limit options
+     * @deprecated the "fulltext" index type is deprecated from ArangoDB 3.10 onwards
      */
     public function testCreateFulltextIndexedCollectionAddDocumentsAndQuery()
     {
@@ -2491,6 +2494,7 @@ public function testCreateFulltextIndexedCollectionAddDocumentsAndQuery()
 
     /**
      * Test if we can create a full text index with options, on a collection
+     * @deprecated the "fulltext" index type is deprecated from ArangoDB 3.10 onwards
      */
     public function testCreateFulltextIndexedCollectionWithOptions()
     {
