Add capability to update documents by query #50

Author: shinusuresh

src/main/java/org/typesense/api/Documents.java

@@ -1,12 +1,16 @@
 package org.typesense.api;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import org.typesense.model.*;
-
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.List;
 import java.util.Map;
-import java.util.Collection;
+import org.typesense.model.DeleteDocumentsParameters;
+import org.typesense.model.ExportDocumentsParameters;
+import org.typesense.model.ImportDocumentsParameters;
+import org.typesense.model.SearchParameters;
+import org.typesense.model.SearchResult;
+import org.typesense.model.UpdateDocumentsParameters;
 
 public class Documents {
 
@@ -78,6 +82,18 @@ public String import_(Collection<?> documents,
         return this.apiCall.post(this.getEndPoint("import"), reqBody, queryParameters, String.class);
     }
 
+    /**
+     * <a href="https://typesense.org/docs/0.25.1/api/documents.html#update-by-query">>Update by query</a>
+     *
+     * @param document - Document
+     * @param updateDocumentsParameters - {@link UpdateDocumentsParameters}
+     * @return
+     * @throws Exception
+     */
+    public Map<String, Integer> update(Map<String, Object> document, UpdateDocumentsParameters updateDocumentsParameters) throws Exception {
+        return this.apiCall.patch(this.getEndPoint("/"), document, updateDocumentsParameters, Map.class);
+    }
+
     public String getEndPoint(String target){
         return Collections.RESOURCE_PATH + "/" + this.collectionName + Documents.RESOURCE_PATH + "/" + target;
     }

src/test/java/org/typesense/api/DocumentsTest.java

@@ -1,5 +1,15 @@
 package org.typesense.api;
 
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.fail;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.typesense.api.exceptions.ObjectNotFound;
@@ -10,16 +20,7 @@
 import org.typesense.model.ImportDocumentsParameters;
 import org.typesense.model.SearchParameters;
 import org.typesense.model.SearchResult;
-
-import java.util.ArrayList;
-import java.util.EmptyStackException;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.fail;
+import org.typesense.model.UpdateDocumentsParameters;
 
 class DocumentsTest {
 
@@ -263,4 +264,20 @@ void testNestedObjectImport() throws Exception {
         assertEquals(1, searchResult.getFound().intValue());
         assertEquals(1, searchResult.getHits().size());
     }
-}
+
+    @Test
+    void testUpdateDocumentsByQuery() throws Exception {
+        helper.createTestDocument();
+
+        UpdateDocumentsParameters updateDocumentsParameters = new UpdateDocumentsParameters()
+                .filterBy("publication_year:1666");
+        Map<String, Object> fieldToAdd = new HashMap<>();
+        fieldToAdd.put("ratings_count", "200");
+        Map<String, Integer> response = client.collections("books").documents().update(fieldToAdd, updateDocumentsParameters);
+        assertThat(response.get("num_updated"), is(1));
+
+        // try fetching the document back
+        Map<String, Object> resp = client.collections("books").documents("1").retrieve();
+        assertThat(resp.get("ratings_count"), is(200));
+    }
+}