Interface MongoOperations
- All Superinterfaces:
ExecutableAggregationOperation
,ExecutableFindOperation
,ExecutableInsertOperation
,ExecutableMapReduceOperation
,ExecutableRemoveOperation
,ExecutableUpdateOperation
,FluentMongoOperations
- All Known Implementing Classes:
MongoTemplate
MongoTemplate
. Not often used but
a useful option for extensibility and testability (as it can be easily mocked, stubbed, or be the target of a JDK
proxy). NOTE: Some operations cannot be executed within a MongoDB transaction. Please refer to the MongoDB specific documentation to learn more about Multi Document Transactions.
- Author:
- Thomas Risberg, Mark Pollack, Oliver Gierke, Tobias Trelle, Chuong Ngo, Christoph Strobl, Thomas Darimont, Maninder Singh, Mark Paluch
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.ExecutableAggregationOperation
ExecutableAggregationOperation.AggregationWithAggregation<T>, ExecutableAggregationOperation.AggregationWithCollection<T>, ExecutableAggregationOperation.ExecutableAggregation<T>, ExecutableAggregationOperation.TerminatingAggregation<T>
Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.ExecutableFindOperation
ExecutableFindOperation.DistinctWithProjection, ExecutableFindOperation.DistinctWithQuery<T>, ExecutableFindOperation.ExecutableFind<T>, ExecutableFindOperation.FindDistinct, ExecutableFindOperation.FindWithCollection<T>, ExecutableFindOperation.FindWithProjection<T>, ExecutableFindOperation.FindWithQuery<T>, ExecutableFindOperation.TerminatingDistinct<T>, ExecutableFindOperation.TerminatingFind<T>, ExecutableFindOperation.TerminatingFindNear<T>
Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.ExecutableInsertOperation
ExecutableInsertOperation.ExecutableInsert<T>, ExecutableInsertOperation.InsertWithBulkMode<T>, ExecutableInsertOperation.InsertWithCollection<T>, ExecutableInsertOperation.TerminatingBulkInsert<T>, ExecutableInsertOperation.TerminatingInsert<T>
Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.ExecutableMapReduceOperation
ExecutableMapReduceOperation.ExecutableMapReduce<T>, ExecutableMapReduceOperation.MapReduceWithCollection<T>, ExecutableMapReduceOperation.MapReduceWithMapFunction<T>, ExecutableMapReduceOperation.MapReduceWithOptions<T>, ExecutableMapReduceOperation.MapReduceWithProjection<T>, ExecutableMapReduceOperation.MapReduceWithQuery<T>, ExecutableMapReduceOperation.MapReduceWithReduceFunction<T>, ExecutableMapReduceOperation.TerminatingMapReduce<T>
Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.ExecutableRemoveOperation
ExecutableRemoveOperation.ExecutableRemove<T>, ExecutableRemoveOperation.RemoveWithCollection<T>, ExecutableRemoveOperation.RemoveWithQuery<T>, ExecutableRemoveOperation.TerminatingRemove<T>
Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.ExecutableUpdateOperation
ExecutableUpdateOperation.ExecutableUpdate<T>, ExecutableUpdateOperation.FindAndModifyWithOptions<T>, ExecutableUpdateOperation.FindAndReplaceWithOptions<T>, ExecutableUpdateOperation.FindAndReplaceWithProjection<T>, ExecutableUpdateOperation.TerminatingFindAndModify<T>, ExecutableUpdateOperation.TerminatingFindAndReplace<T>, ExecutableUpdateOperation.TerminatingUpdate<T>, ExecutableUpdateOperation.UpdateWithCollection<T>, ExecutableUpdateOperation.UpdateWithQuery<T>, ExecutableUpdateOperation.UpdateWithUpdate<T>
-
Method Summary
Modifier and TypeMethodDescription<O> AggregationResults<O>
aggregate
(Aggregation aggregation, Class<?> inputType, Class<O> outputType) Execute an aggregation operation.<O> AggregationResults<O>
aggregate
(Aggregation aggregation, String collectionName, Class<O> outputType) Execute an aggregation operation.<O> AggregationResults<O>
aggregate
(TypedAggregation<?> aggregation, Class<O> outputType) Execute an aggregation operation.<O> AggregationResults<O>
aggregate
(TypedAggregation<?> aggregation, String collectionName, Class<O> outputType) Execute an aggregation operation.<O> Stream<O>
aggregateStream
(Aggregation aggregation, Class<?> inputType, Class<O> outputType) Execute an aggregation operation backed by a Mongo DBAggregateIterable
.<O> Stream<O>
aggregateStream
(Aggregation aggregation, String collectionName, Class<O> outputType) Execute an aggregation operation backed by a Mongo DBAggregateIterable
.<O> Stream<O>
aggregateStream
(TypedAggregation<?> aggregation, Class<O> outputType) Execute an aggregation operation backed by a Mongo DBAggregateIterable
.<O> Stream<O>
aggregateStream
(TypedAggregation<?> aggregation, String collectionName, Class<O> outputType) Execute an aggregation operation backed by a Mongo DBAggregateIterable
.bulkOps
(BulkOperations.BulkMode mode, Class<?> entityType) Returns a newBulkOperations
for the given entity type.bulkOps
(BulkOperations.BulkMode mode, Class<?> entityType, String collectionName) Returns a newBulkOperations
for the given entity type and collection name.bulkOps
(BulkOperations.BulkMode mode, String collectionName) Returns a newBulkOperations
for the given collection.<T> boolean
collectionExists
(Class<T> entityClass) Check to see if a collection with a name indicated by the entity class exists.boolean
collectionExists
(String collectionName) Check to see if a collection with a given name exists.long
Returns the number of documents for the givenQuery
by querying the collection of the given entity class.long
long
Returns the number of documents for the givenQuery
querying the given collection.<T> com.mongodb.client.MongoCollection<org.bson.Document>
createCollection
(Class<T> entityClass) Create an uncapped collection with a name based on the provided entity class.<T> com.mongodb.client.MongoCollection<org.bson.Document>
createCollection
(Class<T> entityClass, CollectionOptions collectionOptions) Create a collection with a name based on the provided entity class using the options.com.mongodb.client.MongoCollection<org.bson.Document>
createCollection
(String collectionName) Create an uncapped collection with the provided name.com.mongodb.client.MongoCollection<org.bson.Document>
createCollection
(String collectionName, CollectionOptions collectionOptions) Create a collection with the provided name and options.default com.mongodb.client.MongoCollection<org.bson.Document>
createView
(String name, Class<?> source, AggregationOperation... stages) Create a view with the provided name.default com.mongodb.client.MongoCollection<org.bson.Document>
createView
(String name, Class<?> source, AggregationPipeline pipeline) Create a view with the provided name.com.mongodb.client.MongoCollection<org.bson.Document>
createView
(String name, Class<?> source, AggregationPipeline pipeline, ViewOptions options) Create a view with the provided name.com.mongodb.client.MongoCollection<org.bson.Document>
createView
(String name, String source, AggregationPipeline pipeline, ViewOptions options) Create a view with the provided name.<T> void
dropCollection
(Class<T> entityClass) Drop the collection with the name indicated by the entity class.void
dropCollection
(String collectionName) Drop the collection with the given name.default long
estimatedCount
(Class<?> entityClass) Estimate the number of documents, in the collectionidentified by the given type
, based on collection statistics.long
estimatedCount
(String collectionName) Estimate the number of documents in the given collection based on collection statistics.default long
exactCount
(Query query, Class<?> entityClass) Returns the number of documents for the givenQuery
by querying the collection of the given entity class.long
exactCount
(Query query, Class<?> entityClass, String collectionName) default long
exactCount
(Query query, String collectionName) Returns the number of documents for the givenQuery
querying the given collection.<T> T
execute
(Class<?> entityClass, CollectionCallback<T> action) Executes the givenCollectionCallback
on the entity collection of the specified class.<T> T
execute
(String collectionName, CollectionCallback<T> action) Executes the givenCollectionCallback
on the collection of the given name.<T> T
execute
(DbCallback<T> action) Executes aDbCallback
translating any exceptions as necessary.org.bson.Document
executeCommand
(String jsonCommand) Execute a MongoDB command expressed as a JSON string.org.bson.Document
executeCommand
(org.bson.Document command) Execute a MongoDB command.org.bson.Document
executeCommand
(org.bson.Document command, com.mongodb.ReadPreference readPreference) Execute a MongoDB command.void
executeQuery
(Query query, String collectionName, DocumentCallbackHandler dch) Execute a MongoDB query and iterate over the query results on a per-document basis with a DocumentCallbackHandler.boolean
Determine result of givenQuery
contains at least one element.boolean
Determine result of givenQuery
contains at least one element.boolean
Determine result of givenQuery
contains at least one element.<T> List<T>
Map the results of an ad-hoc query on the collection for the entity class to a List of the specified type.<T> List<T>
Map the results of an ad-hoc query on the specified collection to a List of the specified type.<T> List<T>
Query for a list of objects of type T from the collection used by the entity class.<T> List<T>
Query for a list of objects of type T from the specified collection.<T> List<T>
findAllAndRemove
(Query query, Class<T> entityClass) Returns and removes all documents matching the given query form the collection used to store the entityClass.<T> List<T>
findAllAndRemove
(Query query, Class<T> entityClass, String collectionName) Returns and removes all documents that match the provided query document criteria from the collection used to store the entityClass.<T> List<T>
findAllAndRemove
(Query query, String collectionName) Returns and removes all documents form the specified collection that match the provided query.<T> T
findAndModify
(Query query, UpdateDefinition update, Class<T> entityClass) <T> T
findAndModify
(Query query, UpdateDefinition update, Class<T> entityClass, String collectionName) <T> T
findAndModify
(Query query, UpdateDefinition update, FindAndModifyOptions options, Class<T> entityClass) Triggers findAndModify to apply providedUpdate
on documents matchingCriteria
of givenQuery
takingFindAndModifyOptions
into account.<T> T
findAndModify
(Query query, UpdateDefinition update, FindAndModifyOptions options, Class<T> entityClass, String collectionName) Triggers findAndModify to apply providedUpdate
on documents matchingCriteria
of givenQuery
takingFindAndModifyOptions
into account.<T> T
findAndRemove
(Query query, Class<T> entityClass) Map the results of an ad-hoc query on the collection for the entity type to a single instance of an object of the specified type.<T> T
findAndRemove
(Query query, Class<T> entityClass, String collectionName) Map the results of an ad-hoc query on the specified collection to a single instance of an object of the specified type.default <S,
T> T findAndReplace
(Query query, S replacement, FindAndReplaceOptions options, Class<S> entityType, Class<T> resultType) Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document takingFindAndReplaceOptions
into account.
NOTE: The replacement entity must not hold an id.<S,
T> T findAndReplace
(Query query, S replacement, FindAndReplaceOptions options, Class<S> entityType, String collectionName, Class<T> resultType) Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document takingFindAndReplaceOptions
into account.
NOTE: The replacement entity must not hold an id.default <T> T
findAndReplace
(Query query, T replacement) Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document.default <T> T
findAndReplace
(Query query, T replacement, String collectionName) Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document.
Options are defaulted toFindAndReplaceOptions.empty()
.default <T> T
findAndReplace
(Query query, T replacement, FindAndReplaceOptions options) Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document takingFindAndReplaceOptions
into account.
NOTE: The replacement entity must not hold an id.default <T> T
findAndReplace
(Query query, T replacement, FindAndReplaceOptions options, Class<T> entityType, String collectionName) Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document takingFindAndReplaceOptions
into account.
NOTE: The replacement entity must not hold an id.default <T> T
findAndReplace
(Query query, T replacement, FindAndReplaceOptions options, String collectionName) Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document takingFindAndReplaceOptions
into account.
NOTE: The replacement entity must not hold an id.<T> T
Returns a document with the given id mapped onto the given class.<T> T
Returns the document with the given id from the given collection mapped onto the given target class.default <T> List<T>
findDistinct
(String field, Class<?> entityClass, Class<T> resultClass) Finds the distinct values for a specified field across a singleMongoCollection
or view and returns the results in aList
.<T> List<T>
findDistinct
(Query query, String field, Class<?> entityClass, Class<T> resultClass) Finds the distinct values for a specified field across a singleMongoCollection
or view and returns the results in aList
.<T> List<T>
findDistinct
(Query query, String field, String collectionName, Class<?> entityClass, Class<T> resultClass) Finds the distinct values for a specified field across a singleMongoCollection
or view and returns the results in aList
.default <T> List<T>
findDistinct
(Query query, String field, String collection, Class<T> resultClass) Finds the distinct values for a specified field across a singleMongoCollection
or view and returns the results in aList
.<T> T
Map the results of an ad-hoc query on the collection for the entity class to a single instance of an object of the specified type.<T> T
Map the results of an ad-hoc query on the specified collection to a single instance of an object of the specified type.<T> GeoResults<T>
Deprecated.since 2.2.<T> GeoResults<T>
Deprecated.since 2.2.com.mongodb.client.MongoCollection<org.bson.Document>
getCollection
(String collectionName) Get aMongoCollection
by its name.getCollectionName
(Class<?> entityClass) The collection name used for the specified class by this template.A set of collection names.Returns the underlyingMongoConverter
.Returns the operations that can be performed on indexesReturns the operations that can be performed on indexes<T> Collection<T>
insert
(Collection<? extends T> batchToSave, Class<?> entityClass) Insert a Collection of objects into a collection in a single batch write to the database.<T> Collection<T>
insert
(Collection<? extends T> batchToSave, String collectionName) Insert a batch of objects into the specified collection in a single batch write to the database.<T> T
insert
(T objectToSave) Insert the object into the collection for the entity type of the object to save.<T> T
Insert the object into the specified collection.<T> Collection<T>
insertAll
(Collection<? extends T> objectsToSave) Insert a mixed Collection of objects into a database collection determining the collection name to use based on the class.<T> MapReduceResults<T>
mapReduce
(String inputCollectionName, String mapFunction, String reduceFunction, Class<T> entityClass) Deprecated.since 3.4 in favor ofaggregate(TypedAggregation, Class)
.<T> MapReduceResults<T>
mapReduce
(String inputCollectionName, String mapFunction, String reduceFunction, MapReduceOptions mapReduceOptions, Class<T> entityClass) Deprecated.since 3.4 in favor ofaggregate(TypedAggregation, Class)
.<T> MapReduceResults<T>
mapReduce
(Query query, String inputCollectionName, String mapFunction, String reduceFunction, Class<T> entityClass) Deprecated.since 3.4 in favor ofaggregate(TypedAggregation, Class)
.<T> MapReduceResults<T>
mapReduce
(Query query, String inputCollectionName, String mapFunction, String reduceFunction, MapReduceOptions mapReduceOptions, Class<T> entityClass) Deprecated.since 3.4 in favor ofaggregate(TypedAggregation, Class)
.com.mongodb.client.result.DeleteResult
Remove the given object from the collection by id and (if applicable) itsVersion
.com.mongodb.client.result.DeleteResult
Removes the given object from the given collection by id and (if applicable) itsVersion
.com.mongodb.client.result.DeleteResult
Remove all documents that match the provided query document criteria from the collection used to store the entityClass.com.mongodb.client.result.DeleteResult
Remove all documents that match the provided query document criteria from the collection used to store the entityClass.com.mongodb.client.result.DeleteResult
Remove all documents from the specified collection that match the provided query document criteria.<T> T
save
(T objectToSave) Save the object to the collection for the entity type of the object to save.<T> T
Save the object to the specified collection.Deprecated.since 2.2.<T> Window<T>
Query for a window of objects of type T from the specified collection.<T> Window<T>
Query for a window of objects of type T from the specified collection.<T> Stream<T>
Executes the givenQuery
on the entity collection of the specifiedentityType
backed by a Mongo DBFindIterable
.<T> Stream<T>
Executes the givenQuery
on the entity collection of the specifiedentityType
and collection backed by a Mongo DBFindIterable
.com.mongodb.client.result.UpdateResult
updateFirst
(Query query, UpdateDefinition update, Class<?> entityClass) Updates the first object that is found in the collection of the entity class that matches the query document with the provided update document.com.mongodb.client.result.UpdateResult
updateFirst
(Query query, UpdateDefinition update, Class<?> entityClass, String collectionName) Updates the first object that is found in the specified collection that matches the query document criteria with the provided updated document.com.mongodb.client.result.UpdateResult
updateFirst
(Query query, UpdateDefinition update, String collectionName) Updates the first object that is found in the specified collection that matches the query document criteria with the provided updated document.com.mongodb.client.result.UpdateResult
updateMulti
(Query query, UpdateDefinition update, Class<?> entityClass) Updates all objects that are found in the collection for the entity class that matches the query document criteria with the provided updated document.com.mongodb.client.result.UpdateResult
updateMulti
(Query query, UpdateDefinition update, Class<?> entityClass, String collectionName) Updates all objects that are found in the collection for the entity class that matches the query document criteria with the provided updated document.com.mongodb.client.result.UpdateResult
updateMulti
(Query query, UpdateDefinition update, String collectionName) Updates all objects that are found in the specified collection that matches the query document criteria with the provided updated document.com.mongodb.client.result.UpdateResult
upsert
(Query query, UpdateDefinition update, Class<?> entityClass) Performs an upsert.com.mongodb.client.result.UpdateResult
upsert
(Query query, UpdateDefinition update, Class<?> entityClass, String collectionName) Performs an upsert.com.mongodb.client.result.UpdateResult
upsert
(Query query, UpdateDefinition update, String collectionName) Performs an upsert.withSession
(com.mongodb.client.ClientSession session) Obtain aClientSession
bound instance ofMongoOperations
.withSession
(com.mongodb.ClientSessionOptions sessionOptions) Obtain asession
bound instance ofSessionScoped
binding a newClientSession
with given sessionOptions to each and every command issued against MongoDB.default SessionScoped
withSession
(Supplier<com.mongodb.client.ClientSession> sessionProvider) Obtain asession
bound instance ofSessionScoped
binding theClientSession
provided by the givenSupplier
to each and every command issued against MongoDB.Methods inherited from interface org.springframework.data.mongodb.core.ExecutableAggregationOperation
aggregateAndReturn
Methods inherited from interface org.springframework.data.mongodb.core.ExecutableFindOperation
query
Methods inherited from interface org.springframework.data.mongodb.core.ExecutableInsertOperation
insert
Methods inherited from interface org.springframework.data.mongodb.core.ExecutableMapReduceOperation
mapReduce
Methods inherited from interface org.springframework.data.mongodb.core.ExecutableRemoveOperation
remove
Methods inherited from interface org.springframework.data.mongodb.core.ExecutableUpdateOperation
update
-
Method Details
-
getCollectionName
The collection name used for the specified class by this template.- Parameters:
entityClass
- must not be null.- Returns:
- never null.
- Throws:
MappingException
- if the collection name cannot be derived from the type.
-
executeCommand
Execute a MongoDB command expressed as a JSON string. Parsing is delegated toDocument.parse(String)
to obtain theDocument
holding the actual command. Any errors that result from executing this command will be converted into Spring's DAO exception hierarchy.- Parameters:
jsonCommand
- a MongoDB command expressed as a JSON string. Must not be null.- Returns:
- a result object returned by the action.
-
executeCommand
org.bson.Document executeCommand(org.bson.Document command) Execute a MongoDB command. Any errors that result from executing this command will be converted into Spring's DAO exception hierarchy.- Parameters:
command
- a MongoDB command.- Returns:
- a result object returned by the action.
-
executeCommand
org.bson.Document executeCommand(org.bson.Document command, @Nullable com.mongodb.ReadPreference readPreference) Execute a MongoDB command. Any errors that result from executing this command will be converted into Spring's data access exception hierarchy.- Parameters:
command
- a MongoDB command, must not be null.readPreference
- read preferences to use, can be null.- Returns:
- a result object returned by the action.
- Since:
- 1.7
-
executeQuery
Execute a MongoDB query and iterate over the query results on a per-document basis with a DocumentCallbackHandler.- Parameters:
query
- the query class that specifies the criteria used to find a record and also an optional fields specification. Must not be null.collectionName
- name of the collection to retrieve the objects from.dch
- the handler that will extract results, one document at a time.
-
execute
Executes aDbCallback
translating any exceptions as necessary.
Allows for returning a result object, that is a domain object or a collection of domain objects.- Type Parameters:
T
- return type.- Parameters:
action
- callback object that specifies the MongoDB actions to perform on the passed in DB instance. Must not be null.- Returns:
- a result object returned by the action or null.
-
execute
Executes the givenCollectionCallback
on the entity collection of the specified class.
Allows for returning a result object, that is a domain object or a collection of domain objects.- Type Parameters:
T
- return type.- Parameters:
entityClass
- class that determines the collection to use. Must not be null.action
- callback object that specifies the MongoDB action. Must not be null.- Returns:
- a result object returned by the action or null.
-
execute
Executes the givenCollectionCallback
on the collection of the given name.
Allows for returning a result object, that is a domain object or a collection of domain objects.- Type Parameters:
T
- return type.- Parameters:
collectionName
- the name of the collection that specifies whichMongoCollection
instance will be passed into. Must not be null or empty.action
- callback object that specifies the MongoDB action the callback action. Must not be null.- Returns:
- a result object returned by the action or null.
-
withSession
Obtain asession
bound instance ofSessionScoped
binding a newClientSession
with given sessionOptions to each and every command issued against MongoDB.- Parameters:
sessionOptions
- must not be null.- Returns:
- new instance of
SessionScoped
. Never null. - Since:
- 2.1
-
withSession
Obtain asession
bound instance ofSessionScoped
binding theClientSession
provided by the givenSupplier
to each and every command issued against MongoDB.
Note: It is up to the caller to manage theClientSession
lifecycle. Use theSessionScoped.execute(SessionCallback, Consumer)
hook to potentially close theClientSession
.- Parameters:
sessionProvider
- must not be null.- Since:
- 2.1
-
withSession
Obtain aClientSession
bound instance ofMongoOperations
.
Note: It is up to the caller to manage theClientSession
lifecycle.- Parameters:
session
- must not be null.- Returns:
ClientSession
bound instance ofMongoOperations
.- Since:
- 2.1
-
stream
Executes the givenQuery
on the entity collection of the specifiedentityType
backed by a Mongo DBFindIterable
.Returns a
String
that wraps the Mongo DBFindIterable
that needs to be closed.- Type Parameters:
T
- element return type- Parameters:
query
- the query class that specifies the criteria used to find a record and also an optional fields specification. Must not be null.entityType
- must not be null.- Returns:
- the result
Stream
, containing mapped objects, needing to be closed once fully processed (e.g. through a try-with-resources clause). - Since:
- 1.7
-
stream
Executes the givenQuery
on the entity collection of the specifiedentityType
and collection backed by a Mongo DBFindIterable
.Returns a
Stream
that wraps the Mongo DBFindIterable
that needs to be closed.- Type Parameters:
T
- element return type- Parameters:
query
- the query class that specifies the criteria used to find a record and also an optional fields specification. Must not be null.entityType
- must not be null.collectionName
- must not be null or empty.- Returns:
- the result
Stream
, containing mapped objects, needing to be closed once fully processed (e.g. through a try-with-resources clause). - Since:
- 1.10
-
createCollection
Create an uncapped collection with a name based on the provided entity class.- Parameters:
entityClass
- class that determines the collection to create.- Returns:
- the created collection.
-
createCollection
<T> com.mongodb.client.MongoCollection<org.bson.Document> createCollection(Class<T> entityClass, @Nullable CollectionOptions collectionOptions) Create a collection with a name based on the provided entity class using the options.- Parameters:
entityClass
- class that determines the collection to create. Must not be null.collectionOptions
- options to use when creating the collection.- Returns:
- the created collection.
-
createCollection
Create an uncapped collection with the provided name.- Parameters:
collectionName
- name of the collection.- Returns:
- the created collection.
-
createCollection
com.mongodb.client.MongoCollection<org.bson.Document> createCollection(String collectionName, @Nullable CollectionOptions collectionOptions) Create a collection with the provided name and options.- Parameters:
collectionName
- name of the collection. Must not be null nor empty.collectionOptions
- options to use when creating the collection.- Returns:
- the created collection.
-
createView
default com.mongodb.client.MongoCollection<org.bson.Document> createView(String name, Class<?> source, AggregationOperation... stages) Create a view with the provided name. The view content is defined by thepipeline stages
on another collection or view identified by the givensource type
.- Parameters:
name
- the name of the view to create.source
- the type defining the views source collection.stages
- theaggregation pipeline stages
defining the view content.- Since:
- 4.0
-
createView
default com.mongodb.client.MongoCollection<org.bson.Document> createView(String name, Class<?> source, AggregationPipeline pipeline) Create a view with the provided name. The view content is defined by thepipeline
on another collection or view identified by the givensource type
.- Parameters:
name
- the name of the view to create.source
- the type defining the views source collection.pipeline
- theAggregationPipeline
defining the view content.- Since:
- 4.0
-
createView
com.mongodb.client.MongoCollection<org.bson.Document> createView(String name, Class<?> source, AggregationPipeline pipeline, @Nullable ViewOptions options) Create a view with the provided name. The view content is defined by thepipeline
on another collection or view identified by the givensource type
.- Parameters:
name
- the name of the view to create.source
- the type defining the views source collection.pipeline
- theAggregationPipeline
defining the view content.options
- additional settings to apply when creating the view. Can be null.- Since:
- 4.0
-
createView
com.mongodb.client.MongoCollection<org.bson.Document> createView(String name, String source, AggregationPipeline pipeline, @Nullable ViewOptions options) Create a view with the provided name. The view content is defined by thepipeline
on another collection or view identified by the given source.- Parameters:
name
- the name of the view to create.source
- the name of the collection or view defining the to be created views source.pipeline
- theAggregationPipeline
defining the view content.options
- additional settings to apply when creating the view. Can be null.- Since:
- 4.0
-
getCollectionNames
A set of collection names.- Returns:
- list of collection names.
-
getCollection
Get aMongoCollection
by its name. The returned collection may not exists yet (except in local memory) and is created on first interaction with the server. Collections can be explicitly created viacreateCollection(Class)
. Please make sure to check if the collectionexists
first.
Translate any exceptions as necessary.- Parameters:
collectionName
- name of the collection. Must not be null.- Returns:
- an existing collection or one created on first server interaction.
-
collectionExists
Check to see if a collection with a name indicated by the entity class exists.
Translate any exceptions as necessary.- Parameters:
entityClass
- class that determines the name of the collection. Must not be null.- Returns:
- true if a collection with the given name is found, false otherwise.
-
collectionExists
Check to see if a collection with a given name exists.
Translate any exceptions as necessary.- Parameters:
collectionName
- name of the collection. Must not be null.- Returns:
- true if a collection with the given name is found, false otherwise.
-
dropCollection
Drop the collection with the name indicated by the entity class.
Translate any exceptions as necessary.- Parameters:
entityClass
- class that determines the collection to drop/delete. Must not be null.
-
dropCollection
Drop the collection with the given name.
Translate any exceptions as necessary.- Parameters:
collectionName
- name of the collection to drop/delete.
-
indexOps
Returns the operations that can be performed on indexes- Returns:
- index operations on the named collection
-
indexOps
Returns the operations that can be performed on indexes- Returns:
- index operations on the named collection associated with the given entity class
-
scriptOps
Deprecated.since 2.2. Theeval
command has been removed without replacement in MongoDB Server 4.2.0.Returns theScriptOperations
that can be performed onMongoDatabase
level.- Returns:
- never null.
- Since:
- 1.7
-
bulkOps
Returns a newBulkOperations
for the given collection.
NOTE: Any additional support for field mapping, etc. is not available for update or remove operations in bulk mode due to the lack of domain type information. UsebulkOps(BulkMode, Class, String)
to get full type specific support.- Parameters:
mode
- theBulkOperations.BulkMode
to use for bulk operations, must not be null.collectionName
- the name of the collection to work on, must not be null or empty.- Returns:
BulkOperations
on the named collection
-
bulkOps
Returns a newBulkOperations
for the given entity type.- Parameters:
mode
- theBulkOperations.BulkMode
to use for bulk operations, must not be null.entityType
- the name of the entity class, must not be null.- Returns:
BulkOperations
on the named collection associated of the given entity class.
-
bulkOps
BulkOperations bulkOps(BulkOperations.BulkMode mode, @Nullable Class<?> entityType, String collectionName) Returns a newBulkOperations
for the given entity type and collection name.- Parameters:
mode
- theBulkOperations.BulkMode
to use for bulk operations, must not be null.entityType
- the name of the entity class. Can be null.collectionName
- the name of the collection to work on, must not be null or empty.- Returns:
BulkOperations
on the named collection associated with the given entity class.
-
findAll
Query for a list of objects of type T from the collection used by the entity class.
The object is converted from the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
If your collection does not contain a homogeneous collection of types, this operation will not be an efficient way to map objects since the test for class type is done in the client and not on the server.- Parameters:
entityClass
- the parametrized type of the returned list.- Returns:
- the converted collection.
-
findAll
Query for a list of objects of type T from the specified collection.
The object is converted from the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
If your collection does not contain a homogeneous collection of types, this operation will not be an efficient way to map objects since the test for class type is done in the client and not on the server.- Parameters:
entityClass
- the parametrized type of the returned list.collectionName
- name of the collection to retrieve the objects from.- Returns:
- the converted collection.
-
aggregate
<O> AggregationResults<O> aggregate(TypedAggregation<?> aggregation, String collectionName, Class<O> outputType) Execute an aggregation operation. The raw results will be mapped to the given entity class. The name of the inputCollection is derived from the inputType of the aggregation.- Parameters:
aggregation
- TheTypedAggregation
specification holding the aggregation operations, must not be null.collectionName
- The name of the input collection to use for the aggreation.outputType
- The parametrized type of the returned list, must not be null.- Returns:
- The results of the aggregation operation.
- Since:
- 1.3
-
aggregate
Execute an aggregation operation. The raw results will be mapped to the given entity class. The name of the inputCollection is derived from the inputType of the aggregation.- Parameters:
aggregation
- TheTypedAggregation
specification holding the aggregation operations, must not be null.outputType
- The parametrized type of the returned list, must not be null.- Returns:
- The results of the aggregation operation.
- Since:
- 1.3
-
aggregate
<O> AggregationResults<O> aggregate(Aggregation aggregation, Class<?> inputType, Class<O> outputType) Execute an aggregation operation. The raw results will be mapped to the given entity class.- Parameters:
aggregation
- TheAggregation
specification holding the aggregation operations, must not be null.inputType
- the inputType where the aggregation operation will read from, must not be null or empty.outputType
- The parametrized type of the returned list, must not be null.- Returns:
- The results of the aggregation operation.
- Since:
- 1.3
-
aggregate
<O> AggregationResults<O> aggregate(Aggregation aggregation, String collectionName, Class<O> outputType) Execute an aggregation operation. The raw results will be mapped to the given entity class.- Parameters:
aggregation
- TheAggregation
specification holding the aggregation operations, must not be null.collectionName
- the collection where the aggregation operation will read from, must not be null or empty.outputType
- The parametrized type of the returned list, must not be null.- Returns:
- The results of the aggregation operation.
- Since:
- 1.3
-
aggregateStream
<O> Stream<O> aggregateStream(TypedAggregation<?> aggregation, String collectionName, Class<O> outputType) Execute an aggregation operation backed by a Mongo DBAggregateIterable
.Returns a
Stream
that wraps the Mongo DBAggregateIterable
that needs to be closed. The raw results will be mapped to the given entity class. The name of the inputCollection is derived from the inputType of the aggregation.Aggregation streaming can't be used with
aggregation explain
. Enabling explanation mode will throw anIllegalArgumentException
.- Parameters:
aggregation
- TheTypedAggregation
specification holding the aggregation operations, must not be null.collectionName
- The name of the input collection to use for the aggreation.outputType
- The parametrized type of the returned list, must not be null.- Returns:
- the result
Stream
, containing mapped objects, needing to be closed once fully processed (e.g. through a try-with-resources clause). - Since:
- 2.0
-
aggregateStream
Execute an aggregation operation backed by a Mongo DBAggregateIterable
.Returns a
Stream
that wraps the Mongo DBAggregateIterable
that needs to be closed. The raw results will be mapped to the given entity class and are returned as stream. The name of the inputCollection is derived from the inputType of the aggregation.Aggregation streaming can't be used with
aggregation explain
. Enabling explanation mode will throw anIllegalArgumentException
.- Parameters:
aggregation
- TheTypedAggregation
specification holding the aggregation operations, must not be null.outputType
- The parametrized type of the returned list, must not be null.- Returns:
- the result
Stream
, containing mapped objects, needing to be closed once fully processed (e.g. through a try-with-resources clause). - Since:
- 2.0
-
aggregateStream
Execute an aggregation operation backed by a Mongo DBAggregateIterable
.Returns a
Stream
that wraps the Mongo DBAggregateIterable
that needs to be closed. The raw results will be mapped to the given entity class.Aggregation streaming can't be used with
aggregation explain
. Enabling explanation mode will throw anIllegalArgumentException
.- Parameters:
aggregation
- TheAggregation
specification holding the aggregation operations, must not be null.inputType
- the inputType where the aggregation operation will read from, must not be null or empty.outputType
- The parametrized type of the returned list, must not be null.- Returns:
- the result
Stream
, containing mapped objects, needing to be closed once fully processed (e.g. through a try-with-resources clause). - Since:
- 2.0
-
aggregateStream
Execute an aggregation operation backed by a Mongo DBAggregateIterable
.Returns a
Stream
that wraps the Mongo DBAggregateIterable
that needs to be closed. The raw results will be mapped to the given entity class.Aggregation streaming can't be used with
aggregation explain
. Enabling explanation mode will throw anIllegalArgumentException
.- Parameters:
aggregation
- TheAggregation
specification holding the aggregation operations, must not be null.collectionName
- the collection where the aggregation operation will read from, must not be null or empty.outputType
- The parametrized type of the returned list, must not be null.- Returns:
- the result
Stream
, containing mapped objects, needing to be closed once fully processed (e.g. through a try-with-resources clause). - Since:
- 2.0
-
mapReduce
@Deprecated <T> MapReduceResults<T> mapReduce(String inputCollectionName, String mapFunction, String reduceFunction, Class<T> entityClass) Deprecated.since 3.4 in favor ofaggregate(TypedAggregation, Class)
.Execute a map-reduce operation. The map-reduce operation will be formed with an output type of INLINE- Parameters:
inputCollectionName
- the collection where the map-reduce will read from. Must not be null.mapFunction
- The JavaScript map function.reduceFunction
- The JavaScript reduce functionentityClass
- The parametrized type of the returned list. Must not be null.- Returns:
- The results of the map reduce operation
-
mapReduce
@Deprecated <T> MapReduceResults<T> mapReduce(String inputCollectionName, String mapFunction, String reduceFunction, @Nullable MapReduceOptions mapReduceOptions, Class<T> entityClass) Deprecated.since 3.4 in favor ofaggregate(TypedAggregation, Class)
.Execute a map-reduce operation that takes additional map-reduce options.- Parameters:
inputCollectionName
- the collection where the map-reduce will read from. Must not be null.mapFunction
- The JavaScript map functionreduceFunction
- The JavaScript reduce functionmapReduceOptions
- Options that specify detailed map-reduce behavior.entityClass
- The parametrized type of the returned list. Must not be null.- Returns:
- The results of the map reduce operation
-
mapReduce
@Deprecated <T> MapReduceResults<T> mapReduce(Query query, String inputCollectionName, String mapFunction, String reduceFunction, Class<T> entityClass) Deprecated.since 3.4 in favor ofaggregate(TypedAggregation, Class)
.Execute a map-reduce operation that takes a query. The map-reduce operation will be formed with an output type of INLINE- Parameters:
query
- The query to use to select the data for the map phase. Must not be null.inputCollectionName
- the collection where the map-reduce will read from. Must not be null.mapFunction
- The JavaScript map functionreduceFunction
- The JavaScript reduce functionentityClass
- The parametrized type of the returned list. Must not be null.- Returns:
- The results of the map reduce operation
-
mapReduce
@Deprecated <T> MapReduceResults<T> mapReduce(Query query, String inputCollectionName, String mapFunction, String reduceFunction, @Nullable MapReduceOptions mapReduceOptions, Class<T> entityClass) Deprecated.since 3.4 in favor ofaggregate(TypedAggregation, Class)
.Execute a map-reduce operation that takes a query and additional map-reduce options- Parameters:
query
- The query to use to select the data for the map phase. Must not be null.inputCollectionName
- the collection where the map-reduce will read from. Must not be null.mapFunction
- The JavaScript map functionreduceFunction
- The JavaScript reduce functionmapReduceOptions
- Options that specify detailed map-reduce behaviorentityClass
- The parametrized type of the returned list. Must not be null.- Returns:
- The results of the map reduce operation
-
geoNear
Deprecated.since 2.2. Theeval
command has been removed in MongoDB Server 4.2.0. Use Aggregations withAggregation.geoNear(NearQuery, String)
instead.ReturnsGeoResults
for all entities matching the givenNearQuery
. Will consider entity mapping information to determine the collection the query is ran against. Note, that MongoDB limits the number of results by default. Make sure to add an explicit limit to theNearQuery
if you expect a particular number of results.MongoDB 4.2 has removed the
geoNear
command. This method uses since version 2.2 aggregations and the$geoNear
aggregation command to emulategeoNear
command functionality. We recommend using aggregations directly:TypedAggregation<T> geoNear = TypedAggregation.newAggregation(entityClass, Aggregation.geoNear(near, "dis")) .withOptions(AggregationOptions.builder().collation(near.getCollation()).build()); AggregationResults<Document> results = aggregate(geoNear, Document.class);
- Parameters:
near
- must not be null.entityClass
- must not be null.- Returns:
-
geoNear
Deprecated.since 2.2. Theeval
command has been removed in MongoDB Server 4.2.0. Use Aggregations withAggregation.geoNear(NearQuery, String)
instead.ReturnsGeoResults
for all entities matching the givenNearQuery
. Note, that MongoDB limits the number of results by default. Make sure to add an explicit limit to theNearQuery
if you expect a particular number of results.MongoDB 4.2 has removed the
geoNear
command. This method uses since version 2.2 aggregations and the$geoNear
aggregation command to emulategeoNear
command functionality. We recommend using aggregations directly:TypedAggregation<T> geoNear = TypedAggregation.newAggregation(entityClass, Aggregation.geoNear(near, "dis")) .withOptions(AggregationOptions.builder().collation(near.getCollation()).build()); AggregationResults<Document> results = aggregate(geoNear, Document.class);
- Parameters:
near
- must not be null.entityClass
- must not be null.collectionName
- the collection to trigger the query against. If no collection name is given the entity class will be inspected. Must not be null nor empty.- Returns:
-
findOne
Map the results of an ad-hoc query on the collection for the entity class to a single instance of an object of the specified type.
The object is converted from the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
The query is specified as aQuery
which can be created either using theBasicQuery
or the more feature richQuery
.- Parameters:
query
- the query class that specifies the criteria used to find a record and also an optional fields specification.entityClass
- the parametrized type of the returned list.- Returns:
- the converted object.
-
findOne
Map the results of an ad-hoc query on the specified collection to a single instance of an object of the specified type.
The object is converted from the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
The query is specified as aQuery
which can be created either using theBasicQuery
or the more feature richQuery
.- Parameters:
query
- the query class that specifies the criteria used to find a record and also an optional fields specification.entityClass
- the parametrized type of the returned list.collectionName
- name of the collection to retrieve the objects from.- Returns:
- the converted object.
-
exists
Determine result of givenQuery
contains at least one element.
NOTE: Any additional support for query/field mapping, etc. is not available due to the lack of domain type information. Useexists(Query, Class, String)
to get full type specific support.- Parameters:
query
- theQuery
class that specifies the criteria used to find a record.collectionName
- name of the collection to check for objects.- Returns:
- true if the query yields a result.
-
exists
Determine result of givenQuery
contains at least one element.- Parameters:
query
- theQuery
class that specifies the criteria used to find a record.entityClass
- the parametrized type.- Returns:
- true if the query yields a result.
-
exists
Determine result of givenQuery
contains at least one element.- Parameters:
query
- theQuery
class that specifies the criteria used to find a record.entityClass
- the parametrized type. Can be null.collectionName
- name of the collection to check for objects.- Returns:
- true if the query yields a result.
-
find
Map the results of an ad-hoc query on the collection for the entity class to a List of the specified type.
The object is converted from the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
The query is specified as aQuery
which can be created either using theBasicQuery
or the more feature richQuery
.- Parameters:
query
- the query class that specifies the criteria used to find a record and also an optional fields specification. Must not be null.entityClass
- the parametrized type of the returned list. Must not be null.- Returns:
- the List of converted objects.
-
find
Map the results of an ad-hoc query on the specified collection to a List of the specified type.
The object is converted from the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
The query is specified as aQuery
which can be created either using theBasicQuery
or the more feature richQuery
.- Parameters:
query
- the query class that specifies the criteria used to find a record and also an optional fields specification. Must not be null.entityClass
- the parametrized type of the returned list. Must not be null.collectionName
- name of the collection to retrieve the objects from. Must not be null.- Returns:
- the List of converted objects.
-
scroll
Query for a window of objects of type T from the specified collection.
Make sure to either setQuery.skip(long)
orQuery.with(KeysetScrollPosition)
along withQuery.limit(int)
to limit large query results for efficient scrolling.
Result objects are converted from the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
If your collection does not contain a homogeneous collection of types, this operation will not be an efficient way to map objects since the test for class type is done in the client and not on the server.When using
KeysetScrollPosition
, make sure to use non-nullablesort properties
as MongoDB does not support criteria to reconstruct a query result from absent document fields ornull
values through$gt/$lt
operators.- Parameters:
query
- the query class that specifies the criteria used to find a record and also an optional fields specification. Must not be null.entityType
- the parametrized type of the returned window.- Returns:
- the converted window.
- Throws:
IllegalStateException
- if a potentialKeysetScrollPosition
contains an invalid position.- Since:
- 4.1
- See Also:
-
scroll
Query for a window of objects of type T from the specified collection.
Make sure to either setQuery.skip(long)
orQuery.with(KeysetScrollPosition)
along withQuery.limit(int)
to limit large query results for efficient scrolling.
Result objects are converted from the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
If your collection does not contain a homogeneous collection of types, this operation will not be an efficient way to map objects since the test for class type is done in the client and not on the server.When using
KeysetScrollPosition
, make sure to use non-nullablesort properties
as MongoDB does not support criteria to reconstruct a query result from absent document fields ornull
values through$gt/$lt
operators.- Parameters:
query
- the query class that specifies the criteria used to find a record and also an optional fields specification. Must not be null.entityType
- the parametrized type of the returned window.collectionName
- name of the collection to retrieve the objects from.- Returns:
- the converted window.
- Throws:
IllegalStateException
- if a potentialKeysetScrollPosition
contains an invalid position.- Since:
- 4.1
- See Also:
-
findById
Returns a document with the given id mapped onto the given class. The collection the query is ran against will be derived from the given target class as well.- Parameters:
id
- the id of the document to return. Must not be null.entityClass
- the type the document shall be converted into. Must not be null.- Returns:
- the document with the given id mapped onto the given target class.
-
findById
Returns the document with the given id from the given collection mapped onto the given target class.- Parameters:
id
- the id of the document to return.entityClass
- the type to convert the document to.collectionName
- the collection to query for the document.- Returns:
- he converted object or null if document does not exist.
-
findDistinct
Finds the distinct values for a specified field across a singleMongoCollection
or view and returns the results in aList
.- Parameters:
field
- the name of the field to inspect for distinct values. Must not be null.entityClass
- the domain type used for determining the actualMongoCollection
. Must not be null.resultClass
- the result type. Must not be null.- Returns:
- never null.
- Since:
- 2.1
-
findDistinct
Finds the distinct values for a specified field across a singleMongoCollection
or view and returns the results in aList
.- Parameters:
query
- filterQuery
to restrict search. Must not be null.field
- the name of the field to inspect for distinct values. Must not be null.entityClass
- the domain type used for determining the actualMongoCollection
and mapping theQuery
to the domain type fields. Must not be null.resultClass
- the result type. Must not be null.- Returns:
- never null.
- Since:
- 2.1
-
findDistinct
<T> List<T> findDistinct(Query query, String field, String collectionName, Class<?> entityClass, Class<T> resultClass) Finds the distinct values for a specified field across a singleMongoCollection
or view and returns the results in aList
.- Parameters:
query
- filterQuery
to restrict search. Must not be null.field
- the name of the field to inspect for distinct values. Must not be null.collectionName
- the explicit name of the actualMongoCollection
. Must not be null.entityClass
- the domain type used for mapping theQuery
to the domain type fields.resultClass
- the result type. Must not be null.- Returns:
- never null.
- Since:
- 2.1
-
findDistinct
default <T> List<T> findDistinct(Query query, String field, String collection, Class<T> resultClass) Finds the distinct values for a specified field across a singleMongoCollection
or view and returns the results in aList
.- Parameters:
query
- filterQuery
to restrict search. Must not be null.field
- the name of the field to inspect for distinct values. Must not be null.collection
- the explicit name of the actualMongoCollection
. Must not be null.resultClass
- the result type. Must not be null.- Returns:
- never null.
- Since:
- 2.1
-
findAndModify
Triggers findAndModify to apply providedUpdate
on documents matchingCriteria
of givenQuery
.A potential
Version
property of the entityClass will be auto-incremented if not explicitly specified in the update.- Parameters:
query
- theQuery
class that specifies theCriteria
used to find a record and also an optional fields specification. Must not be null.update
- theUpdateDefinition
to apply on matching documents. Must not be null.entityClass
- the parametrized type. Must not be null.- Returns:
- the converted object that was updated before it was updated or null, if not found.
- Since:
- 3.0
- See Also:
-
findAndModify
@Nullable <T> T findAndModify(Query query, UpdateDefinition update, Class<T> entityClass, String collectionName) Triggers findAndModify to apply providedUpdate
on documents matchingCriteria
of givenQuery
.A potential
Version
property of the entityClass will be auto-incremented if not explicitly specified in the update.- Parameters:
query
- theQuery
class that specifies theCriteria
used to find a record and also an optional fields specification. Must not be null.update
- theUpdateDefinition
to apply on matching documents. Must not be null.entityClass
- the parametrized type. Must not be null.collectionName
- the collection to query. Must not be null.- Returns:
- the converted object that was updated before it was updated or null, if not found.
- Since:
- 3.0
- See Also:
-
findAndModify
@Nullable <T> T findAndModify(Query query, UpdateDefinition update, FindAndModifyOptions options, Class<T> entityClass) Triggers findAndModify to apply providedUpdate
on documents matchingCriteria
of givenQuery
takingFindAndModifyOptions
into account.A potential
Version
property of the entityClass will be auto-incremented if not explicitly specified in the update.- Parameters:
query
- theQuery
class that specifies theCriteria
used to find a record and also an optional fields specification.update
- theUpdateDefinition
to apply on matching documents.options
- theFindAndModifyOptions
holding additional information.entityClass
- the parametrized type.- Returns:
- the converted object that was updated or null, if not found. Depending on the value of
FindAndModifyOptions.isReturnNew()
this will either be the object as it was before the update or as it is after the update. - Since:
- 3.0
- See Also:
-
findAndModify
@Nullable <T> T findAndModify(Query query, UpdateDefinition update, FindAndModifyOptions options, Class<T> entityClass, String collectionName) Triggers findAndModify to apply providedUpdate
on documents matchingCriteria
of givenQuery
takingFindAndModifyOptions
into account.A potential
Version
property of the entityClass will be auto-incremented if not explicitly specified in the update.- Parameters:
query
- theQuery
class that specifies theCriteria
used to find a record and also an optional fields specification. Must not be null.update
- theUpdateDefinition
to apply on matching documents. Must not be null.options
- theFindAndModifyOptions
holding additional information. Must not be null.entityClass
- the parametrized type. Must not be null.collectionName
- the collection to query. Must not be null.- Returns:
- the converted object that was updated or null, if not found. Depending on the value of
FindAndModifyOptions.isReturnNew()
this will either be the object as it was before the update or as it is after the update. - Since:
- 3.0
- See Also:
-
findAndReplace
Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document.
The collection name is derived from the replacement type.
Options are defaulted toFindAndReplaceOptions.empty()
.
NOTE: The replacement entity must not hold an id.- Parameters:
query
- theQuery
class that specifies theCriteria
used to find a record and also an optional fields specification. Must not be null.replacement
- the replacement document. Must not be null.- Returns:
- the converted object that was updated or null, if not found.
- Throws:
MappingException
- if the collection name cannot bederived
from the given replacement value.- Since:
- 2.1
-
findAndReplace
Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document.
Options are defaulted toFindAndReplaceOptions.empty()
.
NOTE: The replacement entity must not hold an id.- Parameters:
query
- theQuery
class that specifies theCriteria
used to find a record and also an optional fields specification. Must not be null.replacement
- the replacement document. Must not be null.collectionName
- the collection to query. Must not be null.- Returns:
- the converted object that was updated or null, if not found.
- Since:
- 2.1
-
findAndReplace
Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document takingFindAndReplaceOptions
into account.
NOTE: The replacement entity must not hold an id.- Parameters:
query
- theQuery
class that specifies theCriteria
used to find a record and also an optional fields specification. Must not be null.replacement
- the replacement document. Must not be null.options
- theFindAndModifyOptions
holding additional information. Must not be null.- Returns:
- the converted object that was updated or null, if not found. Depending on the value of
FindAndReplaceOptions.isReturnNew()
this will either be the object as it was before the update or as it is after the update. - Throws:
MappingException
- if the collection name cannot bederived
from the given replacement value.- Since:
- 2.1
-
findAndReplace
@Nullable default <T> T findAndReplace(Query query, T replacement, FindAndReplaceOptions options, String collectionName) Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document takingFindAndReplaceOptions
into account.
NOTE: The replacement entity must not hold an id.- Parameters:
query
- theQuery
class that specifies theCriteria
used to find a record and also an optional fields specification. Must not be null.replacement
- the replacement document. Must not be null.options
- theFindAndModifyOptions
holding additional information. Must not be null.- Returns:
- the converted object that was updated or null, if not found. Depending on the value of
FindAndReplaceOptions.isReturnNew()
this will either be the object as it was before the update or as it is after the update. - Since:
- 2.1
-
findAndReplace
@Nullable default <T> T findAndReplace(Query query, T replacement, FindAndReplaceOptions options, Class<T> entityType, String collectionName) Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document takingFindAndReplaceOptions
into account.
NOTE: The replacement entity must not hold an id.- Parameters:
query
- theQuery
class that specifies theCriteria
used to find a record and also an optional fields specification. Must not be null.replacement
- the replacement document. Must not be null.options
- theFindAndModifyOptions
holding additional information. Must not be null.entityType
- the parametrized type. Must not be null.collectionName
- the collection to query. Must not be null.- Returns:
- the converted object that was updated or null, if not found. Depending on the value of
FindAndReplaceOptions.isReturnNew()
this will either be the object as it was before the update or as it is after the update. - Since:
- 2.1
-
findAndReplace
@Nullable default <S,T> T findAndReplace(Query query, S replacement, FindAndReplaceOptions options, Class<S> entityType, Class<T> resultType) Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document takingFindAndReplaceOptions
into account.
NOTE: The replacement entity must not hold an id.- Parameters:
query
- theQuery
class that specifies theCriteria
used to find a record and also an optional fields specification. Must not be null.replacement
- the replacement document. Must not be null.options
- theFindAndModifyOptions
holding additional information. Must not be null.entityType
- the type used for mapping theQuery
to domain type fields and deriving the collection from. Must not be null.resultType
- the parametrized type projection return type. Must not be null, use the domain type ofObject.class
instead.- Returns:
- the converted object that was updated or null, if not found. Depending on the value of
FindAndReplaceOptions.isReturnNew()
this will either be the object as it was before the update or as it is after the update. - Throws:
MappingException
- if the collection name cannot bederived
from the given replacement value.- Since:
- 2.1
-
findAndReplace
@Nullable <S,T> T findAndReplace(Query query, S replacement, FindAndReplaceOptions options, Class<S> entityType, String collectionName, Class<T> resultType) Triggers findOneAndReplace to replace a single document matchingCriteria
of givenQuery
with thereplacement
document takingFindAndReplaceOptions
into account.
NOTE: The replacement entity must not hold an id.- Parameters:
query
- theQuery
class that specifies theCriteria
used to find a record and also an optional fields specification. Must not be null.replacement
- the replacement document. Must not be null.options
- theFindAndModifyOptions
holding additional information. Must not be null.entityType
- the type used for mapping theQuery
to domain type fields. Must not be null.collectionName
- the collection to query. Must not be null.resultType
- the parametrized type projection return type. Must not be null, use the domain type ofObject.class
instead.- Returns:
- the converted object that was updated or null, if not found. Depending on the value of
FindAndReplaceOptions.isReturnNew()
this will either be the object as it was before the update or as it is after the update. - Since:
- 2.1
-
findAndRemove
Map the results of an ad-hoc query on the collection for the entity type to a single instance of an object of the specified type. The first document that matches the query is returned and also removed from the collection in the database.
The object is converted from the MongoDB native representation using an instance of .
The query is specified as aQuery
which can be created either using theBasicQuery
or the more feature richQuery
.- Parameters:
query
- the query class that specifies the criteria used to find a record and also an optional fields specification.entityClass
- the parametrized type of the returned list.- Returns:
- the converted object
-
findAndRemove
Map the results of an ad-hoc query on the specified collection to a single instance of an object of the specified type. The first document that matches the query is returned and also removed from the collection in the database.
The object is converted from the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
The query is specified as aQuery
which can be created either using theBasicQuery
or the more feature richQuery
.- Parameters:
query
- the query class that specifies the criteria used to find a record and also an optional fields specification.entityClass
- the parametrized type of the returned list.collectionName
- name of the collection to retrieve the objects from.- Returns:
- the converted object.
-
count
Returns the number of documents for the givenQuery
by querying the collection of the given entity class.
NOTE: Queryoffset
andlimit
can have direct influence on the resulting number of documents found as those values are passed on to the server and potentially limit the range and order within which the server performs the count operation. Use an unpaged query to count all matches.
This method may choose to useestimatedCount(Class)
for empty queries instead of running anaggregation execution
which may have an impact on performance.- Parameters:
query
- theQuery
class that specifies the criteria used to find documents. Must not be null.entityClass
- class that determines the collection to use. Must not be null.- Returns:
- the count of matching documents.
- Throws:
MappingException
- if the collection name cannot bederived
from the given type.- See Also:
-
count
Returns the number of documents for the givenQuery
querying the given collection. The givenQuery
must solely consist of document field references as we lack type information to map potential property references onto document fields. Usecount(Query, Class, String)
to get full type specific support.
NOTE: Queryoffset
andlimit
can have direct influence on the resulting number of documents found as those values are passed on to the server and potentially limit the range and order within which the server performs the count operation. Use an unpaged query to count all matches.
This method may choose to useestimatedCount(Class)
for empty queries instead of running anaggregation execution
which may have an impact on performance.- Parameters:
query
- theQuery
class that specifies the criteria used to find documents.collectionName
- must not be null or empty.- Returns:
- the count of matching documents.
- See Also:
-
count
Returns the number of documents for the givenQuery
by querying the given collection using the given entity class to map the givenQuery
.
NOTE: Queryoffset
andlimit
can have direct influence on the resulting number of documents found as those values are passed on to the server and potentially limit the range and order within which the server performs the count operation. Use an unpaged query to count all matches.
This method may choose to useestimatedCount(Class)
for empty queries instead of running anaggregation execution
which may have an impact on performance.- Parameters:
query
- theQuery
class that specifies the criteria used to find documents. Must not be null.entityClass
- the parametrized type. Can be null.collectionName
- must not be null or empty.- Returns:
- the count of matching documents.
- See Also:
-
estimatedCount
Estimate the number of documents, in the collectionidentified by the given type
, based on collection statistics.
Please make sure to read the MongoDB reference documentation about limitations on eg. sharded cluster or inside transactions.- Parameters:
entityClass
- must not be null.- Returns:
- the estimated number of documents.
- Throws:
MappingException
- if the collection name cannot bederived
from the given type.- Since:
- 3.1
-
estimatedCount
Estimate the number of documents in the given collection based on collection statistics.
Please make sure to read the MongoDB reference documentation about limitations on eg. sharded cluster or inside transactions.- Parameters:
collectionName
- must not be null.- Returns:
- the estimated number of documents.
- Since:
- 3.1
-
exactCount
Returns the number of documents for the givenQuery
by querying the collection of the given entity class.
NOTE: Queryoffset
andlimit
can have direct influence on the resulting number of documents found as those values are passed on to the server and potentially limit the range and order within which the server performs the count operation. Use an unpaged query to count all matches.
This method uses anaggregation execution
even for emptyqueries
which may have an impact on performance, but guarantees shard, session and transaction compliance. In case an inaccurate count satisfies the applications needs useestimatedCount(Class)
for empty queries instead.- Parameters:
query
- theQuery
class that specifies the criteria used to find documents. Must not be null.entityClass
- class that determines the collection to use. Must not be null.- Returns:
- the count of matching documents.
- Throws:
MappingException
- if the collection name cannot bederived
from the given type.- Since:
- 3.4
-
exactCount
Returns the number of documents for the givenQuery
querying the given collection. The givenQuery
must solely consist of document field references as we lack type information to map potential property references onto document fields. Usecount(Query, Class, String)
to get full type specific support.
NOTE: Queryoffset
andlimit
can have direct influence on the resulting number of documents found as those values are passed on to the server and potentially limit the range and order within which the server performs the count operation. Use an unpaged query to count all matches.
This method uses anaggregation execution
even for emptyqueries
which may have an impact on performance, but guarantees shard, session and transaction compliance. In case an inaccurate count satisfies the applications needs useestimatedCount(String)
for empty queries instead.- Parameters:
query
- theQuery
class that specifies the criteria used to find documents.collectionName
- must not be null or empty.- Returns:
- the count of matching documents.
- Since:
- 3.4
- See Also:
-
exactCount
Returns the number of documents for the givenQuery
by querying the given collection using the given entity class to map the givenQuery
.
NOTE: Queryoffset
andlimit
can have direct influence on the resulting number of documents found as those values are passed on to the server and potentially limit the range and order within which the server performs the count operation. Use an unpaged query to count all matches.
This method uses anaggregation execution
even for emptyqueries
which may have an impact on performance, but guarantees shard, session and transaction compliance. In case an inaccurate count satisfies the applications needs useestimatedCount(String)
for empty queries instead.- Parameters:
query
- theQuery
class that specifies the criteria used to find documents. Must not be null.entityClass
- the parametrized type. Can be null.collectionName
- must not be null or empty.- Returns:
- the count of matching documents.
- Since:
- 3.4
-
insert
<T> T insert(T objectToSave) Insert the object into the collection for the entity type of the object to save.
The object is converted to the MongoDB native representation using an instance of .
If your object has an Id property which holds a null value, it will be set with the generated Id from MongoDB. If your Id property is a String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See Spring's Type Conversion" for more details.
Insert is used to initially store the object into the database. To update an existing object use thesave(Object)
method.Inserting new objects will trigger
Version
property initialization.The
objectToSave
must not be collection-like.- Parameters:
objectToSave
- the object to store in the collection. Must not be null.- Returns:
- the inserted object.
- Throws:
IllegalArgumentException
- in case theobjectToSave
is collection-like.MappingException
- if the target collection name cannot bederived
from the given object type.
-
insert
Insert the object into the specified collection.
The object is converted to the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
Insert is used to initially store the object into the database. To update an existing object use the save method.Inserting new objects will trigger
Version
property initialization.The
objectToSave
must not be collection-like.- Parameters:
objectToSave
- the object to store in the collection. Must not be null.collectionName
- name of the collection to store the object in. Must not be null.- Returns:
- the inserted object.
- Throws:
IllegalArgumentException
- in case theobjectToSave
is collection-like.
-
insert
Insert a Collection of objects into a collection in a single batch write to the database.If an object within the batch has an Id property which holds a null value, it will be set with the generated Id from MongoDB.
Inserting new objects will trigger
Version
property initialization.- Parameters:
batchToSave
- the batch of objects to save. Must not be null.entityClass
- class that determines the collection to use. Must not be null.- Returns:
- the inserted objects that.
- Throws:
MappingException
- if the target collection name cannot bederived
from the given type.
-
insert
Insert a batch of objects into the specified collection in a single batch write to the database.If an object within the batch has an Id property which holds a null value, it will be set with the generated Id from MongoDB.
Inserting new objects will trigger
Version
property initialization.- Parameters:
batchToSave
- the list of objects to save. Must not be null.collectionName
- name of the collection to store the object in. Must not be null.- Returns:
- the inserted objects that.
-
insertAll
Insert a mixed Collection of objects into a database collection determining the collection name to use based on the class.If an object within the batch has an Id property which holds a null value, it will be set with the generated Id from MongoDB.
Inserting new objects will trigger
Version
property initialization.- Parameters:
objectsToSave
- the list of objects to save. Must not be null.- Returns:
- the inserted objects.
- Throws:
MappingException
- if the target collection name cannot bederived
for the given objects.
-
save
<T> T save(T objectToSave) Save the object to the collection for the entity type of the object to save. This will perform an insert if the object is not already present, that is an 'upsert'.
The object is converted to the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
If your object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See Spring's Type Conversion" for more details.A potential
Version
the property will be auto incremented. The operation raises an error in case the document has been modified in between.The
objectToSave
must not be collection-like.- Parameters:
objectToSave
- the object to store in the collection. Must not be null.- Returns:
- the saved object.
- Throws:
IllegalArgumentException
- in case theobjectToSave
is collection-like.MappingException
- if the target collection name cannot bederived
from the given object type.org.springframework.dao.OptimisticLockingFailureException
- in case of version mismatch in case aVersion
is defined.
-
save
Save the object to the specified collection. This will perform an insert if the object is not already present, that is an 'upsert'.
The object is converted to the MongoDB native representation using an instance of . Unless configured otherwise, an instance ofMappingMongoConverter
will be used.
If your object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See Spring's Type Conversion for more details.A potential
Version
the property will be auto incremented. The operation raises an error in case the document has been modified in between.The
objectToSave
must not be collection-like.- Parameters:
objectToSave
- the object to store in the collection. Must not be null.collectionName
- name of the collection to store the object in. Must not be null.- Returns:
- the saved object.
- Throws:
IllegalArgumentException
- in case theobjectToSave
is collection-like.org.springframework.dao.OptimisticLockingFailureException
- in case of version mismatch in case aVersion
is defined.
-
upsert
com.mongodb.client.result.UpdateResult upsert(Query query, UpdateDefinition update, Class<?> entityClass) Performs an upsert. If no document is found that matches the query, a new document is created and inserted by combining the query document and the update document.A potential
Version
property of the entityClass will be auto-incremented if not explicitly specified in the update.NOTE:
sorting
is not supported bydb.collection.updateOne
. UsefindAndModify(Query, UpdateDefinition, FindAndModifyOptions, Class, String)
instead.- Parameters:
query
- the query document that specifies the criteria used to select a record to be upserted. Must not be null.update
- theUpdateDefinition
that contains the updated object or$
operators to manipulate the existing object. Must not be null.entityClass
- class that determines the collection to use. Must not be null.- Returns:
- the
UpdateResult
which lets you access the results of the previous write. - Throws:
MappingException
- if the target collection name cannot bederived
from the given type.- Since:
- 3.0
- See Also:
-
upsert
com.mongodb.client.result.UpdateResult upsert(Query query, UpdateDefinition update, String collectionName) Performs an upsert. If no document is found that matches the query, a new document is created and inserted by combining the query document and the update document.
NOTE: Any additional support for field mapping, versions, etc. is not available due to the lack of domain type information. Useupsert(Query, UpdateDefinition, Class, String)
to get full type specific support.
NOTE:sorting
is not supported bydb.collection.updateOne
. UsefindAndModify(Query, UpdateDefinition, FindAndModifyOptions, Class, String)
instead.- Parameters:
query
- the query document that specifies the criteria used to select a record to be upserted. Must not be null.update
- theUpdateDefinition
that contains the updated object or$
operators to manipulate the existing object. Must not be null.collectionName
- name of the collection to update the object in.- Returns:
- the
UpdateResult
which lets you access the results of the previous write. - Since:
- 3.0
- See Also:
-
upsert
com.mongodb.client.result.UpdateResult upsert(Query query, UpdateDefinition update, Class<?> entityClass, String collectionName) Performs an upsert. If no document is found that matches the query, a new document is created and inserted by combining the query document and the update document.A potential
Version
property of the entityClass will be auto-incremented if not explicitly specified in the update.- Parameters:
query
- the query document that specifies the criteria used to select a record to be upserted. Must not be null.update
- theUpdateDefinition
that contains the updated object or$
operators to manipulate the existing object. Must not be null.entityClass
- class of the pojo to be operated on. Must not be null.collectionName
- name of the collection to update the object in. Must not be null.- Returns:
- the
UpdateResult
which lets you access the results of the previous write. - Since:
- 3.0
- See Also:
-
updateFirst
com.mongodb.client.result.UpdateResult updateFirst(Query query, UpdateDefinition update, Class<?> entityClass) Updates the first object that is found in the collection of the entity class that matches the query document with the provided update document.A potential
Version
property of the entityClass will be auto-incremented if not explicitly specified in the update.- Parameters:
query
- the query document that specifies the criteria used to select a record to be updated. Must not be null.update
- theUpdateDefinition
that contains the updated object or$
operators to manipulate the existing. Must not be null.entityClass
- class that determines the collection to use.- Returns:
- the
UpdateResult
which lets you access the results of the previous write. - Throws:
MappingException
- if the target collection name cannot bederived
from the given type.- Since:
- 3.0
- See Also:
-
updateFirst
com.mongodb.client.result.UpdateResult updateFirst(Query query, UpdateDefinition update, String collectionName) Updates the first object that is found in the specified collection that matches the query document criteria with the provided updated document.
NOTE: Any additional support for field mapping, versions, etc. is not available due to the lack of domain type information. UseupdateFirst(Query, UpdateDefinition, Class, String)
to get full type specific support.
NOTE:sorting
is not supported bydb.collection.updateOne
. UsefindAndModify(Query, UpdateDefinition, Class, String)
instead.- Parameters:
query
- the query document that specifies the criteria used to select a record to be updated. Must not be null.update
- theUpdateDefinition
that contains the updated object or$
operators to manipulate the existing. Must not be null.collectionName
- name of the collection to update the object in. Must not be null.- Returns:
- the
UpdateResult
which lets you access the results of the previous write. - Since:
- 3.0
- See Also:
-
updateFirst
com.mongodb.client.result.UpdateResult updateFirst(Query query, UpdateDefinition update, Class<?> entityClass, String collectionName) Updates the first object that is found in the specified collection that matches the query document criteria with the provided updated document.A potential
Version
property of the entityClass will be auto incremented if not explicitly specified in the update.- Parameters:
query
- the query document that specifies the criteria used to select a record to be updated. Must not be null.update
- theUpdateDefinition
that contains the updated object or$
operators to manipulate the existing. Must not be null.entityClass
- class of the pojo to be operated on. Must not be null.collectionName
- name of the collection to update the object in. Must not be null.- Returns:
- the
UpdateResult
which lets you access the results of the previous write. - Since:
- 3.0
- See Also:
-
updateMulti
com.mongodb.client.result.UpdateResult updateMulti(Query query, UpdateDefinition update, Class<?> entityClass) Updates all objects that are found in the collection for the entity class that matches the query document criteria with the provided updated document.A potential
Version
property of the entityClass will be auto incremented if not explicitly specified in the update.- Parameters:
query
- the query document that specifies the criteria used to select a record to be updated. Must not be null.update
- theUpdateDefinition
that contains the updated object or$
operators to manipulate the existing. Must not be null.entityClass
- class of the pojo to be operated on. Must not be null.- Returns:
- the
UpdateResult
which lets you access the results of the previous write. - Throws:
MappingException
- if the target collection name cannot bederived
from the given type.- Since:
- 3.0
- See Also:
-
updateMulti
com.mongodb.client.result.UpdateResult updateMulti(Query query, UpdateDefinition update, String collectionName) Updates all objects that are found in the specified collection that matches the query document criteria with the provided updated document.
NOTE: Any additional support for field mapping, versions, etc. is not available due to the lack of domain type information. UseupdateMulti(Query, UpdateDefinition, Class, String)
to get full type specific support.- Parameters:
query
- the query document that specifies the criteria used to select a record to be updated. Must not be null.update
- theUpdateDefinition
that contains the updated object or$
operators to manipulate the existing. Must not be null.collectionName
- name of the collection to update the object in. Must not be null.- Returns:
- the
UpdateResult
which lets you access the results of the previous write. - Since:
- 3.0
- See Also:
-
updateMulti
com.mongodb.client.result.UpdateResult updateMulti(Query query, UpdateDefinition update, Class<?> entityClass, String collectionName) Updates all objects that are found in the collection for the entity class that matches the query document criteria with the provided updated document.A potential
Version
property of the entityClass will be auto incremented if not explicitly specified in the update.- Parameters:
query
- the query document that specifies the criteria used to select a record to be updated. Must not be null.update
- theUpdateDefinition
that contains the updated object or$
operators to manipulate the existing. Must not be null.entityClass
- class of the pojo to be operated on. Must not be null.collectionName
- name of the collection to update the object in. Must not be null.- Returns:
- the
UpdateResult
which lets you access the results of the previous write. - Since:
- 3.0
- See Also:
-
remove
Remove the given object from the collection by id and (if applicable) itsVersion
.
UseDeleteResult.getDeletedCount()
for insight whether anacknowledged
remove operation was successful or not.- Parameters:
object
- must not be null.- Returns:
- the
DeleteResult
which lets you access the results of the previous delete. - Throws:
MappingException
- if the target collection name cannot bederived
from the given object type.
-
remove
Removes the given object from the given collection by id and (if applicable) itsVersion
.
UseDeleteResult.getDeletedCount()
for insight whether anacknowledged
remove operation was successful or not.- Parameters:
object
- must not be null.collectionName
- name of the collection where the objects will removed, must not be null or empty.- Returns:
- the
DeleteResult
which lets you access the results of the previous delete.
-
remove
Remove all documents that match the provided query document criteria from the collection used to store the entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the query.- Parameters:
query
- the query document that specifies the criteria used to remove a record.entityClass
- class that determines the collection to use.- Returns:
- the
DeleteResult
which lets you access the results of the previous delete. - Throws:
IllegalArgumentException
- when query or entityClass is null.MappingException
- if the target collection name cannot bederived
from the given type.
-
remove
com.mongodb.client.result.DeleteResult remove(Query query, Class<?> entityClass, String collectionName) Remove all documents that match the provided query document criteria from the collection used to store the entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the query.- Parameters:
query
- the query document that specifies the criteria used to remove a record.entityClass
- class of the pojo to be operated on. Can be null.collectionName
- name of the collection where the objects will removed, must not be null or empty.- Returns:
- the
DeleteResult
which lets you access the results of the previous delete. - Throws:
IllegalArgumentException
- when query, entityClass or collectionName is null.
-
remove
Remove all documents from the specified collection that match the provided query document criteria. There is no conversion/mapping done for any criteria using the id field.
NOTE: Any additional support for field mapping is not available due to the lack of domain type information. Useremove(Query, Class, String)
to get full type specific support.- Parameters:
query
- the query document that specifies the criteria used to remove a record.collectionName
- name of the collection where the objects will removed, must not be null or empty.- Returns:
- the
DeleteResult
which lets you access the results of the previous delete. - Throws:
IllegalArgumentException
- when query or collectionName is null.
-
findAllAndRemove
Returns and removes all documents form the specified collection that match the provided query.
NOTE: Any additional support for field mapping is not available due to the lack of domain type information. UsefindAllAndRemove(Query, Class, String)
to get full type specific support.- Parameters:
query
- the query document that specifies the criteria used to find and remove documents.collectionName
- name of the collection where the objects will removed, must not be null or empty.- Returns:
- the
List
converted objects deleted by this operation. - Since:
- 1.5
-
findAllAndRemove
Returns and removes all documents matching the given query form the collection used to store the entityClass.- Parameters:
query
- the query document that specifies the criteria used to find and remove documents.entityClass
- class of the pojo to be operated on.- Returns:
- the
List
converted objects deleted by this operation. - Throws:
MappingException
- if the target collection name cannot bederived
from the given type.- Since:
- 1.5
-
findAllAndRemove
Returns and removes all documents that match the provided query document criteria from the collection used to store the entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the query.- Parameters:
query
- the query document that specifies the criteria used to find and remove documents.entityClass
- class of the pojo to be operated on.collectionName
- name of the collection where the objects will removed, must not be null or empty.- Returns:
- the
List
converted objects deleted by this operation. - Since:
- 1.5
-
getConverter
MongoConverter getConverter()Returns the underlyingMongoConverter
.- Returns:
- never null.
-