Added updateByQuery endpoint (#1499)

Author: mmoreram

CHANGELOG.md

@@ -13,6 +13,7 @@ All notable changes to this project will be documented in this file based on the
 * Added support for pipeline when indexing document. [#1455](https://github.com/ruflin/Elastica/pull/1455)
 * Added support for multiple bucket sort orders for aggregations. [#1480](https://github.com/ruflin/Elastica/pull/1480)
 * Added basic support for the Elasticsearch Task Api
+* Added updateByQuery endpoint. [#1499](https://github.com/ruflin/Elastica/pull/1499) 
 
 ### Improvements
 

lib/Elastica/Index.php

@@ -6,6 +6,7 @@
 use Elastica\Index\Settings as IndexSettings;
 use Elastica\Index\Stats as IndexStats;
 use Elastica\ResultSet\BuilderInterface;
+use Elastica\Script\AbstractScript;
 use Elasticsearch\Endpoints\AbstractEndpoint;
 use Elasticsearch\Endpoints\DeleteByQuery;
 use Elasticsearch\Endpoints\Indices\Aliases\Update;
@@ -21,6 +22,7 @@
 use Elasticsearch\Endpoints\Indices\Open;
 use Elasticsearch\Endpoints\Indices\Refresh;
 use Elasticsearch\Endpoints\Indices\Settings\Put;
+use Elasticsearch\Endpoints\UpdateByQuery;
 
 /**
  * Elastica index object.
@@ -134,6 +136,33 @@ public function updateDocuments(array $docs, array $options = [])
         return $this->getClient()->updateDocuments($docs, $options);
     }
 
+    /**
+     * Update entries in the db based on a query.
+     *
+     * @param \Elastica\Query|string|array $query   Query object or array
+     * @param AbstractScript $script Script
+     * @param array                        $options Optional params
+     *
+     * @return \Elastica\Response
+     *
+     * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html
+     */
+    public function updateByQuery($query, AbstractScript $script , array $options = [])
+    {
+        $query = Query::create($query)->getQuery();
+
+        $endpoint = new UpdateByQuery();
+        $body = ['query' => is_array($query)
+            ? $query
+            : $query->toArray()];
+
+        $body['script'] = $script->toArray()['script'];
+        $endpoint->setBody($body);
+        $endpoint->setParams($options);
+
+        return $this->requestEndpoint($endpoint);
+    }
+
     /**
      * Uses _bulk to send documents to the server.
      *

test/Elastica/IndexTest.php

@@ -8,6 +8,7 @@
 use Elastica\Query\SimpleQueryString;
 use Elastica\Query\Term;
 use Elastica\Request;
+use Elastica\Script\Script;
 use Elastica\Status;
 use Elastica\Test\Base as BaseTest;
 use Elastica\Type;
@@ -290,6 +291,74 @@ public function testDeleteByQueryWithQueryAndOptions()
         $this->assertEquals(0, $response->count());
     }
 
+    /**
+     * @group functional
+     */
+    public function testUpdateByQueryWithQueryString()
+    {
+        $index = $this->_createIndex();
+        $type1 = new Type($index, 'test1');
+        $type1->addDocument(new Document(1, ['name' => 'ruflin nicolas']));
+        $type1->addDocument(new Document(2, ['name' => 'ruflin']));
+        $index->refresh();
+
+        $response = $index->search('ruflin*');
+        $this->assertEquals(2, $response->count());
+
+        $response = $index->search('nicolas');
+        $this->assertEquals(1, $response->count());
+
+        // Update the element, searched by specific word. Should match first one
+        $response = $index->updateByQuery('nicolas', new Script('ctx._source.name = "marc"'));
+        $this->assertTrue($response->isOk());
+
+        $index->refresh();
+
+        // Makes sure first element is updated and renamed to marc. Should match only second
+        $response = $index->search('ruflin*');
+        $this->assertEquals(1, $response->count());
+
+        $response = $index->search('marc*');
+        $this->assertEquals(1, $response->count());
+
+        $response = $index->search('nicolas');
+        $this->assertEquals(0, $response->count());
+    }
+
+    /**
+     * @group functional
+     */
+    public function testUpdateByQueryAll()
+    {
+        $index = $this->_createIndex();
+        $type1 = new Type($index, 'test1');
+        $type1->addDocument(new Document(1, ['name' => 'ruflin nicolas']));
+        $type1->addDocument(new Document(2, ['name' => 'ruflin']));
+        $index->refresh();
+
+        $response = $index->search('ruflin*');
+        $this->assertEquals(2, $response->count());
+
+        $response = $index->search('nicolas');
+        $this->assertEquals(1, $response->count());
+
+        // Update all elements to name "marc"
+        $response = $index->updateByQuery('*', new Script('ctx._source.name = "marc"'));
+        $this->assertTrue($response->isOk());
+
+        $index->refresh();
+
+        // Because all documents have changed to marc, searching by "ruflin*" should match 0
+        $response = $index->search('ruflin*');
+        $this->assertEquals(0, $response->count());
+
+        $response = $index->search('marc');
+        $this->assertEquals(2, $response->count());
+
+        $response = $index->search('nicolas');
+        $this->assertEquals(0, $response->count());
+    }
+
     /**
      * @group functional
      */