add keep_docs to drop_index (#108)

* add keep_docs to drop_index

* streamline test

* changed keep_documents param to delete_documents

* no need for different index name

* revent to ft.drop for back support

* Add dropindex function. deprecated drop_index

Co-authored-by: Emmanuel Keller <[email protected]>

Author: ashtul

redisearch/client.py

@@ -299,11 +299,29 @@ def alter_schema_add(self, fields):
 
         return self.redis.execute_command(*args)
 
-    def drop_index(self):
+    def drop_index(self, delete_documents=True):
         """
-        Drop the index if it exists
+        Drop the index if it exists. Deprecated from RediSearch 2.0.
+
+        ### Parameters:
+
+        - **delete_documents**: If `True`, all documents will be deleted.
+        """
+        keep_str = '' if delete_documents else 'KEEPDOCS'
+        return self.redis.execute_command(self.DROP_CMD, self.index_name, keep_str)
+
+    def dropindex(self, delete_documents=False):
+        """
+        Drop the index if it exists.
+        Replaced `drop_index` in RediSearch 2.0.
+        Default behavior was changed to not delete the indexed documents. 
+
+        ### Parameters:
+
+        - **delete_documents**: If `True`, all documents will be deleted.
         """
-        return self.redis.execute_command(self.DROP_CMD, self.index_name)
+        keep_str = '' if delete_documents else 'KEEPDOCS'
+        return self.redis.execute_command(self.DROP_CMD, self.index_name, keep_str)
 
     def _add_document(self, doc_id, conn=None, nosave=False, score=1.0, payload=None,
                       replace=False, partial=False, language=None, no_create=False, **fields):

test/test.py

@@ -57,7 +57,7 @@ def createIndex(self, client, num_docs = 100, definition=None):
                                 TextField('txt'), 
                                 NumericField('chapter')), definition=definition)
         except redis.ResponseError:
-            client.drop_index()
+            client.dropindex(delete_documents=True)
             return self.createIndex(client, num_docs=num_docs, definition=definition)
 
         chapters = {}
@@ -193,7 +193,7 @@ def getCleanClient(self, name):
         """
         client = Client(name, port=self.server.port)
         try:
-            client.drop_index()
+            client.dropindex(delete_documents=True)
         except:
             pass
 
@@ -391,6 +391,25 @@ def testSortby(self):
             self.assertEqual('doc2', res2.docs[1].id)
             self.assertEqual('doc3', res2.docs[0].id)
 
+    def testDropIndex(self):
+        """
+        Ensure the index gets dropped by data remains by default
+        """
+        for x in range(20):
+            conn = self.redis()
+            with conn as r:
+                if check_version(r, 20000):
+                    for keep_docs in [[ True , {} ], [ False , {'name': 'haveit'} ]]:
+                        idx = "HaveIt"
+                        index = Client(idx, port=conn.port)
+                        index.redis.hset("index:haveit", mapping = {'name': 'haveit'})
+                        idef = IndexDefinition(prefix=['index:'])
+                        index.create_index((TextField('name'),),definition=idef)
+                        waitForIndex(index.redis, idx)
+                        index.dropindex(delete_documents=keep_docs[0])
+                        i = index.redis.hgetall("index:haveit")
+                        self.assertEqual(i, keep_docs[1])
+
     def testExample(self):
         conn = self.redis()
 
@@ -923,6 +942,5 @@ def testCreateClientDefiniontion(self):
             info = client.info()
             self.assertEqual(495, int(info['num_docs']))
 
-
 if __name__ == '__main__':
     unittest.main()