Make create_query_index always supply partitioned (#470)

`create_query_index` does not always supply `partitioned` which is
always required by the service.

This commit changes that so that `partitioned` is now always
present in the `create_query_index` requests when defined.

This fixes #468

Author: bessbd

CHANGES.md

@@ -1,6 +1,7 @@
 # UNRELEASED
 
 - [FIXED] Set default value for `partitioned` parameter to false when creating a design document.
+- [FIXED] Corrected setting of `partitioned` flag for `create_query_index` requests.
 
 # 2.13.0 (2020-04-16)
 

docs/getting_started.rst

@@ -284,8 +284,12 @@ when constructing the new ``DesignDocument`` class.
     ddoc.add_view('myview','function(doc) { emit(doc.foo, doc.bar); }')
     ddoc.save()
 
-Similarly, to define a partitioned Cloudant Query index you must set the
-``partitioned=True`` optional.
+
+To define a partitioned Cloudant Query index you may set the
+``partitioned=True`` optional, but it is not required as the index will be
+partitioned by default in a partitioned database. Conversely, you must
+set the ``partitioned=False`` optional if you wish to create a global
+(non-partitioned) index in a partitioned database.
 
 .. code-block:: python
 

src/cloudant/database.py

@@ -1100,7 +1100,7 @@ def create_query_index(
             design_document_id=None,
             index_name=None,
             index_type='json',
-            partitioned=False,
+            partitioned=None,
             **kwargs
     ):
         """

src/cloudant/index.py

@@ -47,7 +47,7 @@ class Index(object):
         :func:`~cloudant.database.CloudantDatabase.create_query_index`.
     """
 
-    def __init__(self, database, design_document_id=None, name=None, partitioned=False, **kwargs):
+    def __init__(self, database, design_document_id=None, name=None, partitioned=None, **kwargs):
         self._database = database
         self._r_session = self._database.r_session
         self._ddoc_id = design_document_id
@@ -154,8 +154,8 @@ def create(self):
         self._def_check()
         payload['index'] = self._def
 
-        if self._partitioned:
-            payload['partitioned'] = True
+        if self._partitioned is not None:
+            payload['partitioned'] = bool(self._partitioned)
 
         headers = {'Content-Type': 'application/json'}
         resp = self._r_session.post(

tests/unit/index_tests.py

@@ -554,6 +554,21 @@ def test_create_a_search_index_invalid_selector_value(self):
             '<{} \'dict\'>'.format('type' if PY2 else 'class')
         )
 
+    def test_create_unpartitioned_query_index(self):
+        """
+        Test that create_query_index works on an unpartitioned database
+        """
+        ddoc = DesignDocument(self.db, document_id="unpartitioned_query_index_ddoc")
+        ddoc["language"] = "query"
+        ddoc.save()
+        index = self.db.create_query_index(
+            design_document_id="_design/unpartitioned_query_index_ddoc",
+            fields=["key"],
+            partitioned=False
+        )
+        index.create()
+        self.assertGreater(len(self.db.get_query_indexes()), 0)
+
     def test_search_index_via_query(self):
         """
         Test that a created TEXT index will produce expected query results.