Package org.springframework.data.mongodb.core.aggregation

Class MergeOperation.WhenDocumentsMatch

java.lang.Object

org.springframework.data.mongodb.core.aggregation.MergeOperation.WhenDocumentsMatch

Enclosing class:

MergeOperation

public static class MergeOperation.WhenDocumentsMatch
extends Object

Value Object specifying how to deal with a result document that matches an existing document in the collection based on the fields of the on property describing the unique identifier.

Since:

2.3

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
static MergeOperation.WhenDocumentsMatch	failOnMatch()	Stop and fail the aggregation operation.
static MergeOperation.WhenDocumentsMatch	keepExistingDocument()	Keep the existing document in the output collection.
static MergeOperation.WhenDocumentsMatch	mergeDocuments()	Merge the matching documents.
static MergeOperation.WhenDocumentsMatch	replaceDocument()	Replace the existing document in the output collection with the matching results document.
static MergeOperation.WhenDocumentsMatch	updateWith(List<AggregationOperation> aggregationPipeline)	Use an aggregation pipeline to update the document in the collection.
static MergeOperation.WhenDocumentsMatch	updateWith(Aggregation aggregation)	Use an Aggregation to update the document in the collection.
static MergeOperation.WhenDocumentsMatch	whenMatchedOf(String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

whenMatchedOf

public static MergeOperation.WhenDocumentsMatch whenMatchedOf(String value)

replaceDocument

public static MergeOperation.WhenDocumentsMatch replaceDocument()

Replace the existing document in the output collection with the matching results document.

Returns:

new instance of MergeOperation.WhenDocumentsMatch.

keepExistingDocument

public static MergeOperation.WhenDocumentsMatch keepExistingDocument()

Keep the existing document in the output collection.

Returns:

new instance of MergeOperation.WhenDocumentsMatch.

mergeDocuments

public static MergeOperation.WhenDocumentsMatch mergeDocuments()

Merge the matching documents. Please see the MongoDB reference documentation for details.

Returns:

new instance of MergeOperation.WhenDocumentsMatch.

failOnMatch

public static MergeOperation.WhenDocumentsMatch failOnMatch()

Stop and fail the aggregation operation. Does not revert already performed changes on previous documents.

Returns:

new instance of MergeOperation.WhenDocumentsMatch.

updateWith

public static MergeOperation.WhenDocumentsMatch updateWith(Aggregation aggregation)

Use an Aggregation to update the document in the collection. Please see the MongoDB reference documentation for details.

Parameters:

aggregation - must not be null.

Returns:

new instance of MergeOperation.WhenDocumentsMatch.

updateWith

public static MergeOperation.WhenDocumentsMatch updateWith(List<AggregationOperation> aggregationPipeline)

Use an aggregation pipeline to update the document in the collection. Please see the MongoDB reference documentation for details.

Parameters:

aggregationPipeline - must not be null.

Returns:

new instance of MergeOperation.WhenDocumentsMatch.