Add forward_to_replicas parameter

Author: LeoErcolanelli

ChangeLog

@@ -1,5 +1,8 @@
 CHANGELOG
 
+2017-01-02 1.11.1
+    * Add `forward_to_replicas` on top of `forward_to_slaves`
+
 2016-12-02 1.11.0
     * Configure DNS resolvinf timeout
     * Implement new retry logic

algoliasearch/index.py

@@ -540,7 +540,8 @@ def browse_all(self, params=None):
         """
         return IndexIterator(self, params=params)
 
-    def save_synonym(self, content, object_id, forward_to_slaves=False):
+    def save_synonym(self, content, object_id, forward_to_slaves=False,
+                     forward_to_replicas=False):
         """
         Add a synonym in this index.
 
@@ -551,12 +552,15 @@ def save_synonym(self, content, object_id, forward_to_slaves=False):
         @param forward_to_slaves (optional) should the changes be forwarded to
             slave indexes
         """
+        forward_to_slaves |= forward_to_replicas
+
         path = '/synonyms/%s' % safe(object_id)
         params = {'forwardToSlaves': forward_to_slaves}
         return self._req(False, path, 'PUT', params, content)
 
     def batch_synonyms(self, synonyms, forward_to_slaves=False,
-                       replace_existing_synonyms=False):
+                       replace_existing_synonyms=False,
+                       forward_to_replicas=False):
         """
         Add several synonyms in this index.
 
@@ -566,6 +570,8 @@ def batch_synonyms(self, synonyms, forward_to_slaves=False,
         @param replace_existing_synonyms (optional) should the index be cleared
             of existing synonyms
         """
+        forward_to_slaves |= forward_to_replicas
+
         params = {
             'forwardToSlaves': forward_to_slaves,
             'replaceExistingSynonyms': replace_existing_synonyms
@@ -582,25 +588,31 @@ def get_synonym(self, object_id):
         path = '/synonyms/%s' % safe(object_id)
         return self._req(True, path, 'GET')
 
-    def delete_synonym(self, object_id, forward_to_slaves=False):
+    def delete_synonym(self, object_id, forward_to_slaves=False,
+                       forward_to_replicas=False):
         """
         Delete a synonym from the index.
 
         @param object_id the unique identifier of the synonyms set to delete
         @param forward_to_slaves (optional) should the changes be forwarded to
             slave indexes
         """
+        forward_to_slaves |= forward_to_replicas
+
         path = '/synonyms/%s' % safe(object_id)
         params = {'forwardToSlaves': forward_to_slaves}
         return self._req(False, path, 'DELETE', params)
 
-    def clear_synonyms(self, forward_to_slaves=False):
+    def clear_synonyms(self, forward_to_slaves=False,
+                       forward_to_replicas=False):
         """
         Delete all synonyms from the index.
 
         @param forward_to_slaves (optional) should the changes be forwarded to
             slave indexes
         """
+        forward_to_slaves |= forward_to_replicas
+
         path = '/synonyms/clear'
         params = {'forwardToSlaves': forward_to_slaves}
         return self._req(False, path, 'POST', params)
@@ -681,7 +693,8 @@ def clear_index(self):
     def setSettings(self, settings):
         return self.set_settings(settings)
 
-    def set_settings(self, settings, forward_to_slaves=True):
+    def set_settings(self, settings, forward_to_slaves=True,
+                     forward_to_replicas=True):
         """
         Set settings for this index.
 
@@ -765,6 +778,8 @@ def set_settings(self, settings, forward_to_slaves=True):
             - optionalWords: (array of strings) Specify a list of words that
             should be considered as optional when found in the query.
         """
+        forward_to_slaves &= forward_to_replicas
+
         params = {'forwardToSlaves': forward_to_slaves}
         return self._req(False, '/settings', 'PUT', params, settings)