New: overwrite flag for Solr.add (closes django-haystack#182)

Thanks to @robinsonkwame for the patch

Author: acdha

AUTHORS

@@ -35,3 +35,4 @@ Contributors:
 * Emmanuel Leblond (@touilleMan) for fixing error handling on Python 3
 * Michał Jaworski (@swistakm) for improved Sentry-friendly logging
 * Upayavira (@upayavira) for SolrCloud support
+* Kwame Porter Robinson (@robinsonkwame) for adding overwrite support to Solr.add

pysolr.py

@@ -426,7 +426,7 @@ def _suggest_terms(self, params):
         path = 'terms/?%s' % safe_urlencode(params, True)
         return self._send_request('get', path)
 
-    def _update(self, message, clean_ctrl_chars=True, commit=True, softCommit=False, waitFlush=None, waitSearcher=None):
+    def _update(self, message, clean_ctrl_chars=True, commit=True, softCommit=False, waitFlush=None, waitSearcher=None, overwrite=None):
         """
         Posts the given xml message to http://<self.url>/update and
         returns the result.
@@ -451,6 +451,9 @@ def _update(self, message, clean_ctrl_chars=True, commit=True, softCommit=False,
         if waitFlush is not None:
             query_vars.append('waitFlush=%s' % str(bool(waitFlush)).lower())
 
+        if overwrite is not None:
+            query_vars.append('overwrite=%s' % str(bool(overwrite)).lower())
+
         if waitSearcher is not None:
             query_vars.append('waitSearcher=%s' % str(bool(waitSearcher)).lower())
 
@@ -810,7 +813,7 @@ def _build_doc(self, doc, boost=None, fieldUpdates=None):
 
         return doc_elem
 
-    def add(self, docs, boost=None, fieldUpdates=None, commit=True, softCommit=False, commitWithin=None, waitFlush=None, waitSearcher=None):
+    def add(self, docs, boost=None, fieldUpdates=None, commit=True, softCommit=False, commitWithin=None, waitFlush=None, waitSearcher=None, overwrite=None):
         """
         Adds or updates documents.
 
@@ -831,6 +834,8 @@ def add(self, docs, boost=None, fieldUpdates=None, commit=True, softCommit=False
 
         Optionally accepts ``waitSearcher``. Default is ``None``.
 
+        Optionally accepts ``overwrite``. Default is ``None``.
+
         Usage::
 
             solr.add([
@@ -861,7 +866,7 @@ def add(self, docs, boost=None, fieldUpdates=None, commit=True, softCommit=False
 
         end_time = time.time()
         self.log.debug("Built add request of %s docs in %0.2f seconds.", len(message), end_time - start_time)
-        return self._update(m, commit=commit, softCommit=softCommit, waitFlush=waitFlush, waitSearcher=waitSearcher)
+        return self._update(m, commit=commit, softCommit=softCommit, waitFlush=waitFlush, waitSearcher=waitSearcher, overwrite=overwrite)
 
     def delete(self, id=None, q=None, commit=True, waitFlush=None, waitSearcher=None):
         """
@@ -1167,11 +1172,10 @@ def _send_request(self, method, path='', body=None, headers=None, files=None):
             time.sleep(self.retry_timeout)  # give zookeeper time to notice
             return self._randomized_request(method, path, body, headers, files)
 
-    def _update(self, message, clean_ctrl_chars=True, commit=True, softCommit=False, waitFlush=None,
-                waitSearcher=None):
+    def _update(self, *args, **kwargs):
         self.url = self.zookeeper.getLeaderURL(self.collection)
         LOG.debug('Using random leader URL: %s', self.url)
-        return Solr._update(self, message, clean_ctrl_chars, commit, softCommit, waitFlush, waitSearcher)
+        return Solr._update(self, *args, **kwargs)
 
 
 class ZooKeeper(object):

tests/test_client.py

@@ -539,6 +539,20 @@ def test_commit(self):
         self.solr.commit()
         self.assertEqual(len(self.solr.search('doc')), 4)
 
+    def test_overwrite(self):
+        self.assertEqual(len(self.solr.search('id:doc_overwrite_1')), 0)
+        self.solr.add([
+            {
+                'id': 'doc_overwrite_1',
+                'title': 'Kim is awesome.',
+            },
+            {
+                'id': 'doc_overwrite_1',
+                'title': 'Kim is more awesome.',
+            }
+        ], overwrite=False)
+        self.assertEqual(len(self.solr.search('id:doc_overwrite_1')), 2)
+
     def test_optimize(self):
         # Make sure it doesn't blow up. Side effects are hard to measure. :/
         self.assertEqual(len(self.solr.search('doc')), 3)