Merge pull request #573 from xyu/delete-by-query-params

Allow for request params in delete by query calls

Author: ruflin

changes.txt

@@ -1,5 +1,8 @@
 CHANGES
 
+2014-03-20
+- Allow for request params in delete by query calls
+
 2014-03-17
 - Added filters: AbstractGeoShape, GeoShapePreIndexed, GeoShapeProvided #568
 

lib/Elastica/Type.php

@@ -440,19 +440,21 @@ public function deleteIds(array $ids)
     /**
      * Deletes entries in the db based on a query
      *
-     * @param  \Elastica\Query|string $query Query object
+     * @param  \Elastica\Query|string $query   Query object
+     * @param  array                  $options Optional params
      * @return \Elastica\Response
      * @link http://www.elasticsearch.org/guide/reference/api/delete-by-query.html
      */
-    public function deleteByQuery($query)
+    public function deleteByQuery($query, array $options = array())
     {
         if (is_string($query)) {
             // query_string queries are not supported for delete by query operations
-            return $this->request('_query', Request::DELETE, array(), array('q' => $query));
+            $options['q'] = $query;
+            return $this->request('_query', Request::DELETE, array(), $options);
         }
         $query = Query::create($query);
 
-        return $this->request('_query', Request::DELETE, array('query' => $query->getQuery()));
+        return $this->request('_query', Request::DELETE, array('query' => $query->getQuery()), $options);
     }
 
     /**

test/lib/Elastica/Test/Aggregation/BaseAggregationTest.php

@@ -21,8 +21,8 @@ protected function tearDown()
         }
     }
 
-    protected function _createIndex($name = 'test', $delete = true)
+    protected function _createIndex($name = 'test', $delete = true, $shards = 1)
     {
-        return parent::_createIndex('test_aggregation_' . $name, $delete);
+        return parent::_createIndex('test_aggregation_' . $name, $delete, $shards);
     }
 }

test/lib/Elastica/Test/Base.php

@@ -14,13 +14,14 @@ protected function _getClient()
     /**
      * @param  string         $name Index name
      * @param  bool           $delete Delete index if it exists
+     * @param  int            $shards Number of shards to create
      * @return \Elastica\Index
      */
-    protected function _createIndex($name = 'test', $delete = true)
+    protected function _createIndex($name = 'test', $delete = true, $shards = 1)
     {
         $client = $this->_getClient();
         $index = $client->getIndex('elastica_' . $name);
-        $index->create(array('index' => array('number_of_shards' => 1, 'number_of_replicas' => 0)), $delete);
+        $index->create(array('index' => array('number_of_shards' => $shards, 'number_of_replicas' => 0)), $delete);
 
         return $index;
     }

test/lib/Elastica/Test/TypeTest.php

@@ -396,6 +396,46 @@ public function testDeleteByQueryWithQuery()
         $this->assertEquals(0, $response->count());
     }
 
+    public function testDeleteByQueryWithQueryAndOptions()
+    {
+        $index = $this->_createIndex('test', true, 2);
+        $type = new Type($index, 'test');
+        $type->addDocument(new Document(1, array('name' => 'ruflin nicolas')));
+        $type->addDocument(new Document(2, array('name' => 'ruflin')));
+        $index->refresh();
+
+        $response = $index->search('ruflin*');
+        $this->assertEquals(2, $response->count());
+
+        $response = $index->search('nicolas');
+        $this->assertEquals(1, $response->count());
+
+        // Route to the wrong document id; should not delete
+        $response = $type->deleteByQuery(new SimpleQueryString('nicolas'), array('routing'=>'2'));
+        $this->assertTrue($response->isOk());
+
+        $index->refresh();
+
+        $response = $index->search('ruflin*');
+        $this->assertEquals(2, $response->count());
+
+        $response = $index->search('nicolas');
+        $this->assertEquals(1, $response->count());
+
+        // Delete first document
+        $response = $type->deleteByQuery(new SimpleQueryString('nicolas'), array('routing'=>'1'));
+        $this->assertTrue($response->isOk());
+
+        $index->refresh();
+
+        // Makes sure, document is deleted
+        $response = $index->search('ruflin*');
+        $this->assertEquals(1, $response->count());
+
+        $response = $index->search('nicolas');
+        $this->assertEquals(0, $response->count());
+    }
+
     /**
      * Test to see if Elastica_Type::getDocument() is properly using
      * the fields array when available instead of _source