Implemented the 'partial_replace' feature (#208)

* Implemented the 'partial_replace' feature * Updated path setting for PartialReplace * Updated path setting for PartialReplace * Fixed passing params for partialReplace * Updated the test on partialReplace --------- Co-authored-by: nick <[email protected]>
manticoresoftware · Apr 17, 2024 · a9eee18 · a9eee18
1 parent 3f2e3c6
commit a9eee18
Show file tree

Hide file tree

Showing 6 changed files with 103 additions and 3 deletions.
diff --git a/docs/indexclass.md b/docs/indexclass.md
@@ -140,6 +140,7 @@ Replace an existing document in the index.
 Expects:
 - an array of values
 - a document ID
+- to execute a partial replace ( `false|true`, `false` by default )
 
 Example:
 
@@ -156,6 +157,15 @@ $index->replaceDocument([
         ], 1);
 ```
 
+```php
+$index->replaceDocument([
+            'title' => 'find me',
+            'label' => 'not used'
+        ], 2, true);
+```
+
+
+
 ### replaceDocuments()
 
 Replace multiple documents in the index.

diff --git a/src/Manticoresearch/Client.php b/src/Manticoresearch/Client.php
@@ -194,6 +194,21 @@ public function replace(array $params = []) {
 		return $response->getResponse();
 	}
 
+	/**
+	 * Endpoint: _update
+	 * @param string $index
+	 * @param int $id
+	 * @param array $params
+	 * @return mixed
+	 */
+	public function partialReplace(string $index, int $id, array $params = []) {
+		$endpoint = new Endpoints\PartialReplace($params);
+		$endpoint->setPathByIndexAndId($index, $id);
+		$response = $this->request($endpoint);
+
+		return $response->getResponse();
+	}
+
 	/**
 	 * Endpoint: update
 	 * @param array $params

diff --git a/src/Manticoresearch/Endpoints/PartialReplace.php b/src/Manticoresearch/Endpoints/PartialReplace.php
@@ -0,0 +1,34 @@
+<?php
+
+
+namespace Manticoresearch\Endpoints;
+
+use Manticoresearch\Request;
+
+/**
+ * Class PartialReplace
+ * @package Manticoresearch\Endpoints
+ */
+class PartialReplace extends Request
+{
+	/**
+	 * @var string
+	 */
+	protected $index;
+
+	/**
+	 * @param string $index
+	 * @param int $id
+	 */
+	public function setPathByIndexAndId($index, $id) {
+		$path = '/' .  $index . '/_update/' . $id;
+		parent::setPath($path);
+	}
+
+	/**
+	 * @return mixed|string
+	 */
+	public function getMethod() {
+		return 'POST';
+	}
+}
diff --git a/src/Manticoresearch/Index.php b/src/Manticoresearch/Index.php
@@ -200,7 +200,7 @@ public function updateDocuments($data, $query) {
 		return $this->client->update($params);
 	}
 
-	public function replaceDocument($data, $id) {
+	public function replaceDocument($data, $id, $isPartialReplace = false) {
 		static::checkDocumentId($id);
 		static::checkDocument($data);
 		if (is_object($data)) {
@@ -210,11 +210,17 @@ public function replaceDocument($data, $id) {
 		}
 		$params = [
 			'body' => [
-				'index' => $this->index,
-				'id' => $id,
 				'doc' => $data,
 			],
 		];
+		if ($isPartialReplace) {
+			return $this->client->partialReplace($this->index, $id, $params);
+		}
+		$params['body'] += [
+			'index' => $this->index,
+			'id' => $id,
+			'doc' => $data,
+		];
 		if ($this->cluster !== null) {
 			$params['body']['cluster'] = $this->cluster;
 		}

diff --git a/test/Manticoresearch/Endpoints/PartialReplaceTest.php b/test/Manticoresearch/Endpoints/PartialReplaceTest.php
@@ -0,0 +1,17 @@
+<?php
+namespace Manticoresearch\Test\Endpoints;
+
+class PartialReplaceTest extends \PHPUnit\Framework\TestCase
+{
+
+	public function testGetPath() {
+		$replace = new \Manticoresearch\Endpoints\PartialReplace();
+		$replace->setPathByIndexAndId('test', 1);
+		$this->assertEquals('/test/_update/1', $replace->getPath());
+	}
+
+	public function testGetMethod() {
+		$replace = new \Manticoresearch\Endpoints\Replace();
+		$this->assertEquals('POST', $replace->getMethod());
+	}
+}
diff --git a/test/Manticoresearch/IndexTest.php b/test/Manticoresearch/IndexTest.php
@@ -92,6 +92,24 @@ public function testReplaceDocument() {
 		);
 	}
 
+	public function testPartialReplaceDocument() {
+		$index = $this->getIndex();
+		$this->addDocument($index);
+		$response = $index->replaceDocument(
+			[
+				'title' => 'This is an example document for cooking',
+				'label' => 'not used',
+			], 1, true
+		);
+
+		$this->assertEquals(
+			[
+			'_index' => 'testindex',
+			'updated' => 1,
+			], $response
+		);
+	}
+
 	public function testReplaceDocuments() {
 		$index = $this->getIndex();
 		$this->addDocument($index);