sirius.db.mongo

Class Updater

java.lang.Object

sirius.db.mongo.QueryBuilder<Updater>

sirius.db.mongo.Updater

public class Updater
extends QueryBuilder<Updater>

Fluent builder to build an update statement.

Field Summary

Fields inherited from class sirius.db.mongo.QueryBuilder

filterObject, FILTERS, mixing, mongo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Updater(Mongo mongo)

Method Summary

Modifier and Type	Method and Description
Updater	addToSet(Mapping field, Object value) Adds the given value to the given set / list.
Updater	addToSet(String field, Object value) Adds the given value to the given set / list.
com.mongodb.client.result.UpdateResult	executeFor(Class<?> type) Executes the update on the given collection.
com.mongodb.client.result.UpdateResult	executeFor(MongoEntity entity) Executes the update on the given entity.
com.mongodb.client.result.UpdateResult	executeFor(String collection) Executes the update on the given collection.
Updater	inc(Mapping field, int value) Increments the given field by the given value.
Updater	inc(String field, int value) Increments the given field by the given value.
Updater	many() Specifies that multiple documents should be updated.
protected org.bson.Document	prepareUpdate(String collection)
Updater	pull(Mapping field, Object value) Removes all occurences of the given value from the list in the given field.
Updater	pull(String field, Object value) Removes all occurences of the given value from the list in the given field.
Updater	pullAll(Mapping field, Object... values) Removes all occurences of the given values from the list in the given field.
Updater	pullAll(String field, Object... values) Removes all occurences of the given values from the list in the given field.
Updater	set(Mapping field, Object value) Sets a field to a new value.
Updater	set(String field, Object value) Sets a field to a new value.
Updater	setList(Mapping key, Object... values) Sets a field to the given list of values.
Updater	setList(String key, Object... values) Sets a field to the given list of values.
Updater	unset(Mapping field) Unsets a field.
Updater	unset(String field) Unsets a field.
Updater	upsert() Specifies that a new document should be created if the update filter does not match anything.

Methods inherited from class sirius.db.mongo.QueryBuilder

getRelationName, toString, traceIfRequired, transferFilters, where, where, where

Methods inherited from class java.lang.Object

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

Constructor Detail

Updater

protected Updater(Mongo mongo)

Method Detail

many

public Updater many()

Specifies that multiple documents should be updated.

By default only one document is updated.

Returns:

the builder itself for fluent method calls

upsert

public Updater upsert()

Specifies that a new document should be created if the update filter does not match anything.

By default nothing happens if the update filter does not match anything.

Returns:

the builder itself for fluent method calls

set

public Updater set(Mapping field,
                   Object value)

Sets a field to a new value.

Parameters:

field - the field to update

value - the new value of the field

Returns:

the builder itself for fluent method calls

set

public Updater set(String field,
                   Object value)

Sets a field to a new value.

Parameters:

field - the field to update

value - the new value of the field

Returns:

the builder itself for fluent method calls

unset

public Updater unset(Mapping field)

Unsets a field.

Parameters:

field - the field to remove

Returns:

the builder itself for fluent method calls

unset

public Updater unset(String field)

Unsets a field.

Parameters:

field - the field to remove

Returns:

the builder itself for fluent method calls

setList

public Updater setList(Mapping key,
                       Object... values)

Sets a field to the given list of values.

Parameters:

key - the name of the field to set

values - the values to set the field to

Returns:

the builder itself for fluent method calls

setList

public Updater setList(String key,
                       Object... values)

Sets a field to the given list of values.

Parameters:

key - the name of the field to set

values - the values to set the field to

Returns:

the builder itself for fluent method calls

inc

public Updater inc(Mapping field,
                   int value)

Increments the given field by the given value.

Parameters:

field - the field to increment

value - the amount by which the field should be incremented

Returns:

the builder itself for fluent method calls

inc

public Updater inc(String field,
                   int value)

Increments the given field by the given value.

Parameters:

field - the field to increment

value - the amount by which the field should be incremented

Returns:

the builder itself for fluent method calls

addToSet

public Updater addToSet(Mapping field,
                        Object value)

Adds the given value to the given set / list.

Parameters:

field - the field containing the set / list

value - the value to add

Returns:

the builder itself for fluent method calls

addToSet

public Updater addToSet(String field,
                        Object value)

Adds the given value to the given set / list.

Parameters:

field - the field containing the set / list

value - the value to add

Returns:

the builder itself for fluent method calls

pullAll

public Updater pullAll(Mapping field,
                       Object... values)

Removes all occurences of the given values from the list in the given field.

Parameters:

field - the field containing the list

values - the values to remove

Returns:

the builder itself for fluent method calls

pullAll

public Updater pullAll(String field,
                       Object... values)

Removes all occurences of the given values from the list in the given field.

Parameters:

field - the field containing the list

values - the values to remove

Returns:

the builder itself for fluent method calls

pull

public Updater pull(Mapping field,
                    Object value)

Removes all occurences of the given value from the list in the given field.

Parameters:

field - the field containing the list

value - the value to remove

Returns:

the builder itself for fluent method calls

pull

public Updater pull(String field,
                    Object value)

Removes all occurences of the given value from the list in the given field.

Parameters:

field - the field containing the list

value - the value to remove

Returns:

the builder itself for fluent method calls

executeFor

public com.mongodb.client.result.UpdateResult executeFor(Class<?> type)

Executes the update on the given collection.

Parameters:

type - the type of entities to update

Returns:

the result of the update

executeFor

public com.mongodb.client.result.UpdateResult executeFor(MongoEntity entity)

Executes the update on the given entity.

Parameters:

entity - the entity to filter (by ID) and update

Returns:

the result of the update

executeFor

public com.mongodb.client.result.UpdateResult executeFor(String collection)

Executes the update on the given collection.

Parameters:

collection - the collection to update

Returns:

the result of the update

prepareUpdate

@Nonnull
protected org.bson.Document prepareUpdate(String collection)