DATAMONGO-934: Implementation of bulk operations

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/BulkOperationException.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2015 the original author or authors.
+ *
+ * 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.
+ */
+package org.springframework.data.mongodb;
+
+import java.util.List;
+
+import org.springframework.dao.DataAccessException;
+
+import com.mongodb.BulkWriteError;
+import com.mongodb.BulkWriteException;
+import com.mongodb.BulkWriteResult;
+
+/**
+ * Is thrown when errors occur during bulk operations.
+ * 
+ * @author Tobias Trelle
+ */
+public class BulkOperationException extends DataAccessException {
+	private static final long serialVersionUID = 73929601661154421L;
+	private final List<BulkWriteError> errors;
+	private final BulkWriteResult result;
+
+	public BulkOperationException(String msg, BulkWriteException e) {
+		super(msg, e);
+		this.errors = e.getWriteErrors();
+		this.result = e.getWriteResult();
+	}
+
+	public List<BulkWriteError> getErrors() {
+		return errors;
+	}
+
+	public BulkWriteResult getResult() {
+		return result;
+	}
+
+}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/BulkOperations.java

@@ -0,0 +1,167 @@
+/*
+ * Copyright 2015 the original author or authors.
+ *
+ * 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.
+ */
+package org.springframework.data.mongodb.core;
+
+import java.util.List;
+
+import org.springframework.data.mongodb.BulkOperationException;
+import org.springframework.data.mongodb.core.query.Query;
+import org.springframework.data.mongodb.core.query.Update;
+import org.springframework.data.mongodb.util.Tuple;
+
+import com.mongodb.BulkWriteResult;
+import com.mongodb.WriteConcern;
+
+/**
+ * Bulk operations for insert/update/remove actions on a collection.
+ * <p/>
+ * These bulks operation are available since MongoDB 2.6 and make use of low level bulk commands on the protocol level.
+ * <p/>
+ * This interface defines a fluent API add multiple single operations or list of similar operations in sequence.
+ * 
+ * @author Tobias Trelle
+ */
+public interface BulkOperations {
+
+	/** Mode for bulk operation. */
+	public enum BulkMode {
+
+		/** Perform bulk operations in sequence. The first error will cancel processing. */
+		ORDERED,
+
+		/** Perform bulk operations in parallel. Processing will continue on errors. */
+		UNORDERED
+	};
+	/**
+	 * Add a single insert to the bulk operation.
+	 * 
+	 * @param documents List of documents to insert.
+	 * 
+	 * @return The bulk operation.
+	 * 
+	 * @throws BulkOperationException if an error occured during bulk processing.
+	 */
+	BulkOperations insert(Object documents);	
+
+	/**
+	 * Add a list of inserts to the bulk operation.
+	 * 
+	 * @param documents List of documents to insert.
+	 * 
+	 * @return The bulk operation.
+	 * 
+	 * @throws BulkOperationException if an error occured during bulk processing.
+	 */
+	BulkOperations insert(List<? extends Object> documents);
+
+	/**
+	 * Add a single update to the bulk operation.	For the update request, only the first matching document is updated.
+	 * 
+	 * @param query Update criteria.
+	 * @param update Update operation to perform.
+	 * 
+	 * @return The bulk operation.
+	 */
+	BulkOperations updateOne(Query query, Update update);	
+
+	/**
+	 * Add a list of updates to the bulk operation.	For each update request, only the first matching document is updated.
+	 * 
+	 * @param updates Update operations to perform.
+	 * 
+	 * @return The bulk operation.
+	 */
+	BulkOperations updateOne(List<Tuple<Query, Update>> updates);
+
+	/**
+	 * Add a single update to the bulk operation. For the update request, all matching documents are updated.
+	 * 
+	 * @param query Update criteria.
+	 * @param update Update operation to perform.
+	 *  
+	 * @return The bulk operation.
+	 */
+	BulkOperations updateMulti(Query query, Update update);
+
+	/**
+	 * Add a list of updates to the bulk operation. For each update request, all matching documents are updated.
+	 * 
+	 * @param updates Update operations to perform.
+	 * 
+	 * @return The bulk operation.
+	 */
+	BulkOperations updateMulti(List<Tuple<Query, Update>> updates);
+
+	/**
+	 * Add a single upsert to the bulk operation. An upsert is an update if the set of matching documents is not empty,
+	 * else an insert.
+	 * 
+	 * @param query Update criteria.
+	 * @param update Update operation to perform.
+	 * 
+	 * @return The bulk operation.
+	 */
+	BulkOperations upsert(Query query, Update update);	
+
+	/**
+	 * Add a list of upserts to the bulk operation. An upsert is an update if the set of matching documents is not empty, else an
+	 * insert.
+	 * 
+	 * @param updates Updates/insert operations to perform.
+	 * 
+	 * @return The bulk operation.
+	 */
+	BulkOperations upsert(List<Tuple<Query, Update>> updates);
+
+	/**
+	 * Add a single remove operation to the bulk operation.
+	 * 
+	 * @param remove operations to perform.
+	 * 
+	 * @return The bulk operation.
+	 */
+	BulkOperations remove(Query remove);	
+
+	/**
+	 * Add a list of remove operations to the bulk operation.
+	 * 
+	 * @param remove operations to perform.
+	 * 
+	 * @return The bulk operation.
+	 */
+	BulkOperations remove(List<Query> removes);
+
+	/**
+	 * Execute all bulk operations using the default write concern.
+	 * 
+	 * @return Result of the bulk operation providing counters for inserts/updates etc.
+	 * 
+	 * @throws BulkOperationException if errors occur during the exection of the bulk operations.
+	 */
+	BulkWriteResult executeBulk();
+
+	/**
+	 * Execute all bulk operations using the given write concern.
+	 * 
+	 * @param writeConcern Write concern to use.
+	 * 
+	 * @return Result of the bulk operation providing counters for inserts/updates etc.
+	 * 
+	 * @throws BulkOperationException if errors occur during the exection of the bulk operations.
+	 */
+	BulkWriteResult executeBulk(WriteConcern writeConcern);
+
+}