org.springframework.data.mongodb.core.aggregation

Class AggregationUpdate

java.lang.Object

org.springframework.data.mongodb.core.aggregation.Aggregation

org.springframework.data.mongodb.core.aggregation.AggregationUpdate

All Implemented Interfaces:

UpdateDefinition

public class AggregationUpdate
extends Aggregation
implements UpdateDefinition

Abstraction for db.collection.update() using an aggregation pipeline. Aggregation pipeline updates use a more expressive update statement expressing conditional updates based on current field values or updating one field using the value of another field(s).

 AggregationUpdate update = AggregationUpdate.update().set("average")
                .toValue(ArithmeticOperators.valueOf("tests").avg()).set("grade")
                .toValue(ConditionalOperators
                                .switchCases(CaseOperator.when(Gte.valueOf("average").greaterThanEqualToValue(90)).then("A"),
                                                CaseOperator.when(Gte.valueOf("average").greaterThanEqualToValue(80)).then("B"),
                                                CaseOperator.when(Gte.valueOf("average").greaterThanEqualToValue(70)).then("C"),
                                                CaseOperator.when(Gte.valueOf("average").greaterThanEqualToValue(60)).then("D"))
                                .defaultTo("F"));
 

The above sample is equivalent to the JSON update statement:

 db.collection.update(
    { },
    [
      { $set: { average : { $avg: "$tests" } } },
      { $set: { grade: { $switch: {
                            branches: [
                                { case: { $gte: [ "$average", 90 ] }, then: "A" },
                                { case: { $gte: [ "$average", 80 ] }, then: "B" },
                                { case: { $gte: [ "$average", 70 ] }, then: "C" },
                                { case: { $gte: [ "$average", 60 ] }, then: "D" }
                            ],
                            default: "F"
      } } } }
    ],
    { multi: true }
 )
 

Since:

3.0

Author:

Christoph Strobl, Mark Paluch

See Also:

MongoDB Reference Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AggregationUpdate.SetValueAppender Fluent API AggregationUpdate builder.

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.query.UpdateDefinition

UpdateDefinition.ArrayFilter

Field Summary

Fields inherited from class org.springframework.data.mongodb.core.aggregation.Aggregation

CURRENT, DEFAULT_CONTEXT, DEFAULT_OPTIONS, pipeline, REMOVE, ROOT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AggregationUpdate() Create new AggregationUpdate.
protected	AggregationUpdate(List<AggregationOperation> pipeline) Create new AggregationUpdate with the given aggregation pipeline to apply.

Method Summary

Modifier and Type	Method and Description
static AggregationUpdate	from(List<AggregationOperation> pipeline) Create a new AggregationUpdate from the given AggregationOperations.
List<UpdateDefinition.ArrayFilter>	getArrayFilters() Get the specification which elements to modify in an array field.
org.bson.Document	getUpdateObject()
void	inc(String key) Increment the value of a given key by 1.
Boolean	isIsolated() If true prevents a write operation that affects multiple documents from yielding to other reads or writes once the first document is written.
AggregationUpdate	isolated() Prevents a write operation that affects multiple documents from yielding to other reads or writes once the first document is written.
boolean	modifies(String key) Check if a given key is modified by applying the update.
AggregationUpdate	replaceWith(Object value) $replaceWith replaces the input document with the value.
AggregationUpdate	replaceWith(ReplaceWithOperation replaceWithOperation) $replaceWith replaces the input document with the specified document.
AggregationUpdate	set(SetOperation setOperation) Adds new fields to documents.
AggregationUpdate.SetValueAppender	set(String key) Fluent API variant for $set adding a single pipeline operation every time.
String	toString()
AggregationUpdate	unset(String... keys) Short for unset(UnsetOperation).
AggregationUpdate	unset(UnsetOperation unsetOperation) $unset removes/excludes fields from documents.
static AggregationUpdate	update() Start defining the update pipeline to execute.

Methods inherited from class org.springframework.data.mongodb.core.aggregation.Aggregation

addFields, asAggregationList, bind, bucket, bucket, bucketAuto, bucketAuto, count, facet, facet, fields, geoNear, getOptions, getPipeline, graphLookup, group, group, limit, lookup, lookup, match, match, match, merge, newAggregation, newAggregation, newAggregation, newAggregation, newAggregationOptions, newUpdate, out, previousOperation, project, project, project, redact, replaceRoot, replaceRoot, replaceRoot, sample, skip, skip, sort, sort, sortByCount, sortByCount, toDocument, toPipeline, unwind, unwind, unwind, unwind, withOptions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.core.query.UpdateDefinition

hasArrayFilters

Constructor Detail

AggregationUpdate

protected AggregationUpdate()

Create new AggregationUpdate.

AggregationUpdate

protected AggregationUpdate(List<AggregationOperation> pipeline)

Create new AggregationUpdate with the given aggregation pipeline to apply.

Parameters:

pipeline - must not be null.

Method Detail

update

public static AggregationUpdate update()

Start defining the update pipeline to execute.

Returns:

new instance of AggregationUpdate.

from

public static AggregationUpdate from(List<AggregationOperation> pipeline)

Create a new AggregationUpdate from the given AggregationOperations.

Returns:

new instance of AggregationUpdate.

set

public AggregationUpdate set(SetOperation setOperation)

Adds new fields to documents. $set outputs documents that contain all existing fields from the input documents and newly added fields.

Parameters:

setOperation - must not be null.

Returns:

this.

See Also:

$set Aggregation Reference

unset

public AggregationUpdate unset(UnsetOperation unsetOperation)

$unset removes/excludes fields from documents.

Parameters:

unsetOperation - must not be null.

Returns:

this.

See Also:

$unset Aggregation Reference

replaceWith

public AggregationUpdate replaceWith(ReplaceWithOperation replaceWithOperation)

$replaceWith replaces the input document with the specified document. The operation replaces all existing fields in the input document, including the _id field.

Parameters:

replaceWithOperation - must not be null.

Returns:

this.

See Also:

$replaceWith Aggregation Reference

replaceWith

public AggregationUpdate replaceWith(Object value)

$replaceWith replaces the input document with the value.

Parameters:

value - must not be null.

Returns:

this.

set

public AggregationUpdate.SetValueAppender set(String key)

Fluent API variant for $set adding a single pipeline operation every time. To update multiple fields within one SetOperation use set(SetOperation).

Parameters:

key - must not be null.

Returns:

new instance of AggregationUpdate.SetValueAppender.

See Also:

set(SetOperation)

unset

public AggregationUpdate unset(String... keys)

Short for unset(UnsetOperation).

Parameters:

keys - the fields to remove.

Returns:

this.

isolated

public AggregationUpdate isolated()

Prevents a write operation that affects multiple documents from yielding to other reads or writes once the first document is written.
Use with MongoOperations.updateMulti(Query, UpdateDefinition, Class).

Returns:

never null.

isIsolated

public Boolean isIsolated()

Description copied from interface: UpdateDefinition

If true prevents a write operation that affects multiple documents from yielding to other reads or writes once the first document is written.

Specified by:

isIsolated in interface UpdateDefinition

Returns:

true if update isolated is set.

getUpdateObject

public org.bson.Document getUpdateObject()

Specified by:

getUpdateObject in interface UpdateDefinition

Returns:

the actual update in its native Document format. Never null.

modifies

public boolean modifies(String key)

Description copied from interface: UpdateDefinition

Check if a given key is modified by applying the update.

Specified by:

modifies in interface UpdateDefinition

Parameters:

key - must not be null.

Returns:

true if the actual UpdateDefinition attempts to modify the given key.

inc

public void inc(String key)

Description copied from interface: UpdateDefinition

Increment the value of a given key by 1.

Specified by:

inc in interface UpdateDefinition

Parameters:

key - must not be null.

getArrayFilters

public List<UpdateDefinition.ArrayFilter> getArrayFilters()

Description copied from interface: UpdateDefinition

Get the specification which elements to modify in an array field. UpdateDefinition.ArrayFilter are passed directly to the driver without further type or field mapping.

Specified by:

getArrayFilters in interface UpdateDefinition

Returns:

never null.

toString

public String toString()

Overrides:

toString in class Aggregation