Insert-Update (#336)

Author: rashtao

src/main/java/com/arangodb/internal/InternalArangoCollection.java

@@ -56,6 +56,7 @@ public abstract class InternalArangoCollection<A extends InternalArangoDB<E>, D
     private static final String NEW = "new";
     private static final String RETURN_OLD = "returnOld";
     private static final String OVERWRITE = "overwrite";
+    private static final String OVERWRITE_MODE = "overwriteMode";
     private static final String OLD = "old";
     private static final String SILENT = "silent";
 
@@ -86,6 +87,7 @@ protected <T> Request insertDocumentRequest(final T value, final DocumentCreateO
         request.putQueryParam(RETURN_OLD, params.getReturnOld());
         request.putQueryParam(SILENT, params.getSilent());
         request.putQueryParam(OVERWRITE, params.getOverwrite());
+        request.putQueryParam(OVERWRITE_MODE, params.getOverwriteMode() != null ? params.getOverwriteMode().getValue() : null);
         request.putHeaderParam(TRANSACTION_ID, params.getStreamTransactionId());
         request.setBody(util(Serializer.CUSTOM).serialize(value));
         return request;
@@ -122,6 +124,7 @@ protected <T> Request insertDocumentsRequest(final Collection<T> values, final D
         request.putQueryParam(RETURN_OLD, params.getReturnOld());
         request.putQueryParam(SILENT, params.getSilent());
         request.putQueryParam(OVERWRITE, params.getOverwrite());
+        request.putQueryParam(OVERWRITE_MODE, params.getOverwriteMode() != null ? params.getOverwriteMode().getValue() : null);
         request.putHeaderParam(TRANSACTION_ID, params.getStreamTransactionId());
         request.setBody(util(Serializer.CUSTOM)
                 .serialize(values, new ArangoSerializer.Options().serializeNullValues(false).stringAsJson(true)));

src/main/java/com/arangodb/model/DocumentCreateOptions.java

@@ -32,6 +32,7 @@ public class DocumentCreateOptions {
     private Boolean returnNew;
     private Boolean returnOld;
     private Boolean overwrite;
+    private OverwriteMode overwriteMode;
     private Boolean silent;
     private String streamTransactionId;
 
@@ -96,6 +97,22 @@ public DocumentCreateOptions overwrite(final Boolean overwrite) {
         return this;
     }
 
+    public OverwriteMode getOverwriteMode() {
+        return overwriteMode;
+    }
+
+    /**
+     * @param overwriteMode This parameter can be set to replace or update. If given it sets implicitly the overwrite
+     *                      flag. In case it is set to update, the replace-insert becomes an update-insert. Otherwise
+     *                      this option follows the rules of the overwrite parameter.
+     * @return options
+     * @since ArangoDB 3.7
+     */
+    public DocumentCreateOptions overwriteMode(final OverwriteMode overwriteMode) {
+        this.overwriteMode = overwriteMode;
+        return this;
+    }
+
     public Boolean getSilent() {
         return silent;
     }

src/main/java/com/arangodb/model/OverwriteMode.java

@@ -0,0 +1,39 @@
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2016 ArangoDB GmbH, Cologne, Germany
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb.model;
+
+
+/**
+ * @author Michele Rastelli
+ */
+public enum OverwriteMode {
+    replace("replace"), update("update");
+
+    private final String value;
+
+    OverwriteMode(String value) {
+        this.value = value;
+    }
+
+    public String getValue() {
+        return value;
+    }
+}

src/test/java/com/arangodb/ArangoCollectionTest.java

@@ -158,6 +158,44 @@ public void insertDocumentOverwriteReturnOld() {
         assertThat(collection.count().getCount(), is(initialCount + 1L));
     }
 
+    @Test
+    public void insertDocumentOverwriteModeReplace() {
+        assumeTrue(isAtLeastVersion(3, 7));
+
+        String key = "key-" + UUID.randomUUID().toString();
+        final BaseDocument doc = new BaseDocument(key);
+        doc.addAttribute("foo", "a");
+        final DocumentCreateEntity<BaseDocument> meta = collection.insertDocument(doc);
+
+        final BaseDocument doc2 = new BaseDocument(key);
+        doc2.addAttribute("bar", "b");
+        final DocumentCreateEntity<BaseDocument> repsert = collection
+                .insertDocument(doc2, new DocumentCreateOptions().overwriteMode(OverwriteMode.replace).returnNew(true));
+
+        assertThat(repsert, is(notNullValue()));
+        assertThat(repsert.getRev(), is(not(meta.getRev())));
+        assertThat(repsert.getNew().getProperties().containsKey("foo"), is(false));
+        assertThat(repsert.getNew().getAttribute("bar").toString(), is("b"));
+    }
+
+    @Test
+    public void insertDocumentOverwriteModeUpdate() {
+        assumeTrue(isAtLeastVersion(3, 7));
+
+        final BaseDocument doc = new BaseDocument();
+        doc.addAttribute("foo", "a");
+        final DocumentCreateEntity<BaseDocument> meta = collection.insertDocument(doc);
+
+        doc.addAttribute("bar", "b");
+        final DocumentCreateEntity<BaseDocument> upsert = collection
+                .insertDocument(doc, new DocumentCreateOptions().overwriteMode(OverwriteMode.update).returnNew(true));
+
+        assertThat(upsert, is(notNullValue()));
+        assertThat(upsert.getRev(), is(not(meta.getRev())));
+        assertThat(upsert.getNew().getAttribute("foo").toString(), is("a"));
+        assertThat(upsert.getNew().getAttribute("bar").toString(), is("b"));
+    }
+
     @Test
     public void insertDocumentWaitForSync() {
         final DocumentCreateOptions options = new DocumentCreateOptions().waitForSync(true);
@@ -1506,6 +1544,35 @@ public void insertDocumentsOverwrite() {
         }
     }
 
+    @Test
+    public void insertDocumentsOverwriteModeUpdate() {
+        assumeTrue(isAtLeastVersion(3, 7));
+
+        final BaseDocument doc1 = new BaseDocument();
+        doc1.addAttribute("foo", "a");
+        final DocumentCreateEntity<BaseDocument> meta1 = collection.insertDocument(doc1);
+
+        final BaseDocument doc2 = new BaseDocument();
+        doc2.addAttribute("foo", "a");
+        final DocumentCreateEntity<BaseDocument> meta2 = collection.insertDocument(doc2);
+
+        doc1.addAttribute("bar", "b");
+        doc2.addAttribute("bar", "b");
+
+        final MultiDocumentEntity<DocumentCreateEntity<BaseDocument>> repsert = collection
+                .insertDocuments(Arrays.asList(doc1, doc2),
+                        new DocumentCreateOptions().overwriteMode(OverwriteMode.update).returnNew(true));
+        assertThat(repsert, is(notNullValue()));
+        assertThat(repsert.getDocuments().size(), is(2));
+        assertThat(repsert.getErrors().size(), is(0));
+        for (final DocumentCreateEntity<BaseDocument> documentCreateEntity : repsert.getDocuments()) {
+            assertThat(documentCreateEntity.getRev(), is(not(meta1.getRev())));
+            assertThat(documentCreateEntity.getRev(), is(not(meta2.getRev())));
+            assertThat(documentCreateEntity.getNew().getAttribute("foo").toString(), is("a"));
+            assertThat(documentCreateEntity.getNew().getAttribute("bar").toString(), is("b"));
+        }
+    }
+
     @Test
     public void insertDocumentsJson() {
         final Collection<String> values = new ArrayList<>();