public interface ReactiveMongoOperations extends ReactiveFluentMongoOperations
Implemented by ReactiveMongoTemplate
. 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). Command execution using
ReactiveMongoOperations
is deferred until subscriber subscribes to the Publisher
.
Flux
,
Mono
,
Project ReactorReactiveFindOperation.DistinctWithProjection, ReactiveFindOperation.DistinctWithQuery<T>, ReactiveFindOperation.FindDistinct, ReactiveFindOperation.FindWithCollection<T>, ReactiveFindOperation.FindWithProjection<T>, ReactiveFindOperation.FindWithQuery<T>, ReactiveFindOperation.ReactiveFind<T>, ReactiveFindOperation.TerminatingDistinct<T>, ReactiveFindOperation.TerminatingFind<T>, ReactiveFindOperation.TerminatingFindNear<T>
ReactiveInsertOperation.InsertWithCollection<T>, ReactiveInsertOperation.ReactiveInsert<T>, ReactiveInsertOperation.TerminatingInsert<T>
ReactiveUpdateOperation.FindAndModifyWithOptions<T>, ReactiveUpdateOperation.FindAndReplaceWithOptions<T>, ReactiveUpdateOperation.FindAndReplaceWithProjection<T>, ReactiveUpdateOperation.ReactiveUpdate<T>, ReactiveUpdateOperation.TerminatingFindAndModify<T>, ReactiveUpdateOperation.TerminatingFindAndReplace<T>, ReactiveUpdateOperation.TerminatingUpdate<T>, ReactiveUpdateOperation.UpdateWithCollection<T>, ReactiveUpdateOperation.UpdateWithQuery<T>, ReactiveUpdateOperation.UpdateWithUpdate<T>
ReactiveRemoveOperation.ReactiveRemove<T>, ReactiveRemoveOperation.RemoveWithCollection<T>, ReactiveRemoveOperation.RemoveWithQuery<T>, ReactiveRemoveOperation.TerminatingRemove<T>
ReactiveAggregationOperation.AggregationOperationWithAggregation<T>, ReactiveAggregationOperation.AggregationOperationWithCollection<T>, ReactiveAggregationOperation.ReactiveAggregation<T>, ReactiveAggregationOperation.TerminatingAggregationOperation<T>
ReactiveMapReduceOperation.MapReduceWithCollection<T>, ReactiveMapReduceOperation.MapReduceWithMapFunction<T>, ReactiveMapReduceOperation.MapReduceWithOptions<T>, ReactiveMapReduceOperation.MapReduceWithProjection<T>, ReactiveMapReduceOperation.MapReduceWithQuery<T>, ReactiveMapReduceOperation.MapReduceWithReduceFunction<T>, ReactiveMapReduceOperation.ReactiveMapReduce<T>, ReactiveMapReduceOperation.TerminatingMapReduce<T>
ReactiveChangeStreamOperation.ChangeStreamWithCollection<T>, ReactiveChangeStreamOperation.ChangeStreamWithFilterAndProjection<T>, ReactiveChangeStreamOperation.ChangeStreamWithOptions<T>, ReactiveChangeStreamOperation.ReactiveChangeStream<T>, ReactiveChangeStreamOperation.ResumingChangeStream<T>, ReactiveChangeStreamOperation.TerminatingChangeStream<T>
Modifier and Type | Method and Description |
---|---|
<O> reactor.core.publisher.Flux<O> |
aggregate(Aggregation aggregation,
Class<?> inputType,
Class<O> outputType)
Execute an aggregation operation.
|
<O> reactor.core.publisher.Flux<O> |
aggregate(Aggregation aggregation,
String collectionName,
Class<O> outputType)
Execute an aggregation operation.
|
<O> reactor.core.publisher.Flux<O> |
aggregate(TypedAggregation<?> aggregation,
Class<O> outputType)
Execute an aggregation operation.
|
<O> reactor.core.publisher.Flux<O> |
aggregate(TypedAggregation<?> aggregation,
String collectionName,
Class<O> outputType)
Execute an aggregation operation.
|
default <T> reactor.core.publisher.Flux<ChangeStreamEvent<T>> |
changeStream(ChangeStreamOptions options,
Class<T> targetType)
Subscribe to a MongoDB Change Stream for all events in
the configured default database via the reactive infrastructure.
|
default <T> reactor.core.publisher.Flux<ChangeStreamEvent<T>> |
changeStream(String collectionName,
ChangeStreamOptions options,
Class<T> targetType)
Subscribe to a MongoDB Change Stream for all events in
the given collection via the reactive infrastructure.
|
<T> reactor.core.publisher.Flux<ChangeStreamEvent<T>> |
changeStream(String database,
String collectionName,
ChangeStreamOptions options,
Class<T> targetType)
Subscribe to a MongoDB Change Stream via the reactive
infrastructure.
|
<T> reactor.core.publisher.Mono<Boolean> |
collectionExists(Class<T> entityClass)
Check to see if a collection with a name indicated by the entity class exists.
|
reactor.core.publisher.Mono<Boolean> |
collectionExists(String collectionName)
Check to see if a collection with a given name exists.
|
reactor.core.publisher.Mono<Long> |
count(Query query,
Class<?> entityClass)
Returns the number of documents for the given
Query by querying the collection of the given entity class. |
reactor.core.publisher.Mono<Long> |
count(Query query,
Class<?> entityClass,
String collectionName)
|
reactor.core.publisher.Mono<Long> |
count(Query query,
String collectionName)
Returns the number of documents for the given
Query querying the given collection. |
<T> reactor.core.publisher.Mono<com.mongodb.reactivestreams.client.MongoCollection<org.bson.Document>> |
createCollection(Class<T> entityClass)
Create an uncapped collection with a name based on the provided entity class.
|
<T> reactor.core.publisher.Mono<com.mongodb.reactivestreams.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.
|
reactor.core.publisher.Mono<com.mongodb.reactivestreams.client.MongoCollection<org.bson.Document>> |
createCollection(String collectionName)
Create an uncapped collection with the provided name.
|
reactor.core.publisher.Mono<com.mongodb.reactivestreams.client.MongoCollection<org.bson.Document>> |
createCollection(String collectionName,
CollectionOptions collectionOptions)
Create a collection with the provided name and options.
|
<T> reactor.core.publisher.Mono<Void> |
dropCollection(Class<T> entityClass)
Drop the collection with the name indicated by the entity class.
|
reactor.core.publisher.Mono<Void> |
dropCollection(String collectionName)
Drop the collection with the given name.
|
default reactor.core.publisher.Mono<Long> |
estimatedCount(Class<?> entityClass)
Estimate the number of documents, in the collection
identified by the given type ,
based on collection statistics. |
reactor.core.publisher.Mono<Long> |
estimatedCount(String collectionName)
Estimate the number of documents in the given collection based on collection statistics.
|
<T> reactor.core.publisher.Flux<T> |
execute(Class<?> entityClass,
ReactiveCollectionCallback<T> action)
Executes the given
ReactiveCollectionCallback on the entity collection of the specified class. |
<T> reactor.core.publisher.Flux<T> |
execute(ReactiveDatabaseCallback<T> action)
Executes a
ReactiveDatabaseCallback translating any exceptions as necessary. |
<T> reactor.core.publisher.Flux<T> |
execute(String collectionName,
ReactiveCollectionCallback<T> action)
Executes the given
ReactiveCollectionCallback on the collection of the given name. |
reactor.core.publisher.Mono<org.bson.Document> |
executeCommand(org.bson.Document command)
Execute a MongoDB command.
|
reactor.core.publisher.Mono<org.bson.Document> |
executeCommand(org.bson.Document command,
com.mongodb.ReadPreference readPreference)
Execute a MongoDB command.
|
reactor.core.publisher.Mono<org.bson.Document> |
executeCommand(String jsonCommand)
Execute the a MongoDB command expressed as a JSON string.
|
reactor.core.publisher.Mono<Boolean> |
exists(Query query,
Class<?> entityClass)
Determine result of given
Query contains at least one element. |
reactor.core.publisher.Mono<Boolean> |
exists(Query query,
Class<?> entityClass,
String collectionName)
Determine result of given
Query contains at least one element. |
reactor.core.publisher.Mono<Boolean> |
exists(Query query,
String collectionName)
Determine result of given
Query contains at least one element. |
<T> reactor.core.publisher.Flux<T> |
find(Query query,
Class<T> entityClass)
Map the results of an ad-hoc query on the collection for the entity class to a
Flux of the specified type. |
<T> reactor.core.publisher.Flux<T> |
find(Query query,
Class<T> entityClass,
String collectionName)
Map the results of an ad-hoc query on the specified collection to a
Flux of the specified type. |
<T> reactor.core.publisher.Flux<T> |
findAll(Class<T> entityClass)
Query for a
Flux of objects of type T from the collection used by the entity class. |
<T> reactor.core.publisher.Flux<T> |
findAll(Class<T> entityClass,
String collectionName)
Query for a
Flux of objects of type T from the specified collection. |
<T> reactor.core.publisher.Flux<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> reactor.core.publisher.Flux<T> |
findAllAndRemove(Query query,
Class<T> entityClass,
String collectionName)
Returns and removes all documents that match the provided query document criteria from the the collection used to
store the entityClass.
|
<T> reactor.core.publisher.Flux<T> |
findAllAndRemove(Query query,
String collectionName)
Returns and removes all documents form the specified collection that match the provided query.
|
<T> reactor.core.publisher.Mono<T> |
findAndModify(Query query,
UpdateDefinition update,
Class<T> entityClass)
|
<T> reactor.core.publisher.Mono<T> |
findAndModify(Query query,
UpdateDefinition update,
Class<T> entityClass,
String collectionName)
|
<T> reactor.core.publisher.Mono<T> |
findAndModify(Query query,
UpdateDefinition update,
FindAndModifyOptions options,
Class<T> entityClass)
Triggers findAndModify
to apply provided
Update on documents matching Criteria of given Query taking
FindAndModifyOptions into account. |
<T> reactor.core.publisher.Mono<T> |
findAndModify(Query query,
UpdateDefinition update,
FindAndModifyOptions options,
Class<T> entityClass,
String collectionName)
Triggers findAndModify
to apply provided
Update on documents matching Criteria of given Query taking
FindAndModifyOptions into account. |
<T> reactor.core.publisher.Mono<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> reactor.core.publisher.Mono<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> reactor.core.publisher.Mono<T> |
findAndReplace(Query query,
S replacement,
FindAndReplaceOptions options,
Class<S> entityType,
Class<T> resultType)
Triggers
findOneAndReplace
to replace a single document matching
Criteria of given Query with the replacement document
taking FindAndReplaceOptions into account. |
<S,T> reactor.core.publisher.Mono<T> |
findAndReplace(Query query,
S replacement,
FindAndReplaceOptions options,
Class<S> entityType,
String collectionName,
Class<T> resultType)
Triggers
findOneAndReplace
to replace a single document matching
Criteria of given Query with the replacement document
taking FindAndReplaceOptions into account. |
default <T> reactor.core.publisher.Mono<T> |
findAndReplace(Query query,
T replacement)
Triggers
findOneAndReplace
to replace a single document matching
Criteria of given Query with the replacement
document. |
default <T> reactor.core.publisher.Mono<T> |
findAndReplace(Query query,
T replacement,
FindAndReplaceOptions options)
Triggers
findOneAndReplace
to replace a single document matching
Criteria of given Query with the replacement document
taking FindAndReplaceOptions into account. |
default <T> reactor.core.publisher.Mono<T> |
findAndReplace(Query query,
T replacement,
FindAndReplaceOptions options,
Class<T> entityType,
String collectionName)
Triggers
findOneAndReplace
to replace a single document matching
Criteria of given Query with the replacement document
taking FindAndReplaceOptions into account. |
default <T> reactor.core.publisher.Mono<T> |
findAndReplace(Query query,
T replacement,
FindAndReplaceOptions options,
String collectionName)
Triggers
findOneAndReplace
to replace a single document matching
Criteria of given Query with the replacement document
taking FindAndReplaceOptions into account. |
default <T> reactor.core.publisher.Mono<T> |
findAndReplace(Query query,
T replacement,
String collectionName)
Triggers
findOneAndReplace
to replace a single document matching
Criteria of given Query with the replacement
document. |
<T> reactor.core.publisher.Mono<T> |
findById(Object id,
Class<T> entityClass)
Returns a document with the given id mapped onto the given class.
|
<T> reactor.core.publisher.Mono<T> |
findById(Object id,
Class<T> entityClass,
String collectionName)
Returns the document with the given id from the given collection mapped onto the given target class.
|
<T> reactor.core.publisher.Flux<T> |
findDistinct(Query query,
String field,
Class<?> entityClass,
Class<T> resultClass)
Finds the distinct values for a specified field across a single
MongoCollection or view and
returns the results in a Flux . |
<T> reactor.core.publisher.Flux<T> |
findDistinct(Query query,
String field,
String collectionName,
Class<?> entityClass,
Class<T> resultClass)
Finds the distinct values for a specified field across a single
MongoCollection or view and
returns the results in a Flux . |
default <T> reactor.core.publisher.Flux<T> |
findDistinct(Query query,
String field,
String collection,
Class<T> resultClass)
Finds the distinct values for a specified field across a single
MongoCollection or view and
returns the results in a Flux . |
default <T> reactor.core.publisher.Flux<T> |
findDistinct(String field,
Class<?> entityClass,
Class<T> resultClass)
Finds the distinct values for a specified field across a single
MongoCollection or view and
returns the results in a Flux . |
<T> reactor.core.publisher.Mono<T> |
findOne(Query query,
Class<T> entityClass)
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> reactor.core.publisher.Mono<T> |
findOne(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.
|
<T> reactor.core.publisher.Flux<GeoResult<T>> |
geoNear(NearQuery near,
Class<T> entityClass)
Deprecated.
since 2.2. The
eval command has been removed in MongoDB Server 4.2.0. Use Aggregations with
Aggregation.geoNear(NearQuery, String) instead. |
<T> reactor.core.publisher.Flux<GeoResult<T>> |
geoNear(NearQuery near,
Class<T> entityClass,
String collectionName)
Deprecated.
since 2.2. The
eval command has been removed in MongoDB Server 4.2.0. Use Aggregations with
Aggregation.geoNear(NearQuery, String) instead. |
reactor.core.publisher.Mono<com.mongodb.reactivestreams.client.MongoCollection<org.bson.Document>> |
getCollection(String collectionName)
Get a
MongoCollection by name. |
String |
getCollectionName(Class<?> entityClass)
The collection name used for the specified class by this template.
|
reactor.core.publisher.Flux<String> |
getCollectionNames()
A set of collection names.
|
MongoConverter |
getConverter()
Returns the underlying
MongoConverter . |
ReactiveIndexOperations |
indexOps(Class<?> entityClass)
Returns the reactive operations that can be performed on indexes
|
ReactiveIndexOperations |
indexOps(String collectionName)
Returns the reactive operations that can be performed on indexes
|
<T> reactor.core.publisher.Flux<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> reactor.core.publisher.Flux<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> reactor.core.publisher.Mono<T> |
insert(reactor.core.publisher.Mono<? extends T> objectToSave)
Insert the object into the collection for the entity type of the object to save.
|
<T> reactor.core.publisher.Mono<T> |
insert(T objectToSave)
Insert the object into the collection for the entity type of the object to save.
|
<T> reactor.core.publisher.Mono<T> |
insert(T objectToSave,
String collectionName)
Insert the object into the specified collection.
|
<T> reactor.core.publisher.Flux<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> reactor.core.publisher.Flux<T> |
insertAll(reactor.core.publisher.Mono<? extends 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> reactor.core.publisher.Flux<T> |
insertAll(reactor.core.publisher.Mono<? extends Collection<? extends T>> batchToSave,
Class<?> entityClass)
Insert a Collection of objects into a collection in a single batch write to the database.
|
<T> reactor.core.publisher.Flux<T> |
insertAll(reactor.core.publisher.Mono<? extends Collection<? extends T>> batchToSave,
String collectionName)
Insert objects into the specified collection in a single batch write to the database.
|
ReactiveSessionScoped |
inTransaction()
Deprecated.
since 2.2. Use
@Transactional or TransactionalOperator . |
ReactiveSessionScoped |
inTransaction(org.reactivestreams.Publisher<com.mongodb.reactivestreams.client.ClientSession> sessionProvider)
Deprecated.
since 2.2. Use
@Transactional or TransactionalOperator . |
<T> reactor.core.publisher.Flux<T> |
mapReduce(Query filterQuery,
Class<?> domainType,
Class<T> resultType,
String mapFunction,
String reduceFunction,
MapReduceOptions options)
Execute a map-reduce operation.
|
<T> reactor.core.publisher.Flux<T> |
mapReduce(Query filterQuery,
Class<?> domainType,
String inputCollectionName,
Class<T> resultType,
String mapFunction,
String reduceFunction,
MapReduceOptions options)
Execute a map-reduce operation.
|
reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> |
remove(reactor.core.publisher.Mono<? extends Object> objectToRemove)
Remove the given object from the collection by id.
|
reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> |
remove(reactor.core.publisher.Mono<? extends Object> objectToRemove,
String collectionName)
Removes the given object from the given collection.
|
reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> |
remove(Object object)
Remove the given object from the collection by id.
|
reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> |
remove(Object object,
String collectionName)
Removes the given object from the given collection.
|
reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> |
remove(Query query,
Class<?> entityClass)
Remove all documents that match the provided query document criteria from the the collection used to store the
entityClass.
|
reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> |
remove(Query query,
Class<?> entityClass,
String collectionName)
Remove all documents that match the provided query document criteria from the the collection used to store the
entityClass.
|
reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> |
remove(Query query,
String collectionName)
Remove all documents from the specified collection that match the provided query document criteria.
|
<T> reactor.core.publisher.Mono<T> |
save(reactor.core.publisher.Mono<? extends T> objectToSave)
Save the object to the collection for the entity type of the object to save.
|
<T> reactor.core.publisher.Mono<T> |
save(reactor.core.publisher.Mono<? extends T> objectToSave,
String collectionName)
Save the object to the specified collection.
|
<T> reactor.core.publisher.Mono<T> |
save(T objectToSave)
Save the object to the collection for the entity type of the object to save.
|
<T> reactor.core.publisher.Mono<T> |
save(T objectToSave,
String collectionName)
Save the object to the specified collection.
|
<T> reactor.core.publisher.Flux<T> |
tail(Query query,
Class<T> entityClass)
Map the results of an ad-hoc query on the collection for the entity class to a stream of objects of the specified
type.
|
<T> reactor.core.publisher.Flux<T> |
tail(Query query,
Class<T> entityClass,
String collectionName)
Map the results of an ad-hoc query on the collection for the entity class to a stream of objects of the specified
type.
|
reactor.core.publisher.Mono<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.
|
reactor.core.publisher.Mono<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.
|
reactor.core.publisher.Mono<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.
|
reactor.core.publisher.Mono<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.
|
reactor.core.publisher.Mono<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.
|
reactor.core.publisher.Mono<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.
|
reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> |
upsert(Query query,
UpdateDefinition update,
Class<?> entityClass)
Performs an upsert.
|
reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> |
upsert(Query query,
UpdateDefinition update,
Class<?> entityClass,
String collectionName)
Performs an upsert.
|
reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> |
upsert(Query query,
UpdateDefinition update,
String collectionName)
Performs an upsert.
|
ReactiveMongoOperations |
withSession(com.mongodb.reactivestreams.client.ClientSession session)
Obtain a
ClientSession bound instance of ReactiveMongoOperations . |
ReactiveSessionScoped |
withSession(com.mongodb.ClientSessionOptions sessionOptions)
Obtain a
session bound instance of SessionScoped binding a new ClientSession
with given sessionOptions to each and every command issued against MongoDB. |
ReactiveSessionScoped |
withSession(org.reactivestreams.Publisher<com.mongodb.reactivestreams.client.ClientSession> sessionProvider)
Obtain a
session bound instance of ReactiveSessionScoped binding the
ClientSession provided by the given Publisher to each and every command issued against MongoDB. |
default ReactiveSessionScoped |
withSession(Supplier<com.mongodb.reactivestreams.client.ClientSession> sessionProvider)
Obtain a
session bound instance of SessionScoped binding the ClientSession
provided by the given Supplier to each and every command issued against MongoDB. |
query
insert
update
remove
aggregateAndReturn
mapReduce
changeStream
ReactiveIndexOperations indexOps(String collectionName)
collectionName
- must not be null.ReactiveIndexOperations indexOps(Class<?> entityClass)
entityClass
- must not be null.reactor.core.publisher.Mono<org.bson.Document> executeCommand(String jsonCommand)
jsonCommand
- a MongoDB command expressed as a JSON string.reactor.core.publisher.Mono<org.bson.Document> executeCommand(org.bson.Document command)
command
- a MongoDB command.reactor.core.publisher.Mono<org.bson.Document> executeCommand(org.bson.Document command, @Nullable com.mongodb.ReadPreference readPreference)
command
- a MongoDB command, must not be null.readPreference
- read preferences to use, can be null.<T> reactor.core.publisher.Flux<T> execute(ReactiveDatabaseCallback<T> action)
ReactiveDatabaseCallback
translating any exceptions as necessary.
Allows for returning a result object, that is a domain object or a collection of domain objects.T
- return type.action
- callback object that specifies the MongoDB actions to perform on the passed in DB instance. Must not
be null.<T> reactor.core.publisher.Flux<T> execute(Class<?> entityClass, ReactiveCollectionCallback<T> action)
ReactiveCollectionCallback
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.T
- return type.entityClass
- class that determines the collection to use. Must not be null.action
- callback object that specifies the MongoDB action. Must not be null.<T> reactor.core.publisher.Flux<T> execute(String collectionName, ReactiveCollectionCallback<T> action)
ReactiveCollectionCallback
on the collection of the given name.
Allows for returning a result object, that is a domain object or a collection of domain objects.T
- return type.collectionName
- the name of the collection that specifies which MongoCollection
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.default ReactiveSessionScoped withSession(Supplier<com.mongodb.reactivestreams.client.ClientSession> sessionProvider)
session
bound instance of SessionScoped
binding the ClientSession
provided by the given Supplier
to each and every command issued against MongoDB.
Note: It is up to the caller to manage the ClientSession
lifecycle. Use
ReactiveSessionScoped.execute(ReactiveSessionCallback, Consumer)
to provide a hook for processing the
ClientSession
when done.sessionProvider
- must not be null.ReactiveSessionScoped
. Never null.ReactiveSessionScoped withSession(com.mongodb.ClientSessionOptions sessionOptions)
session
bound instance of SessionScoped
binding a new ClientSession
with given sessionOptions to each and every command issued against MongoDB.
Note: It is up to the caller to manage the ClientSession
lifecycle. Use
ReactiveSessionScoped.execute(ReactiveSessionCallback, Consumer)
to provide a hook for processing the
ClientSession
when done.sessionOptions
- must not be null.ReactiveSessionScoped
. Never null.ReactiveSessionScoped withSession(org.reactivestreams.Publisher<com.mongodb.reactivestreams.client.ClientSession> sessionProvider)
session
bound instance of ReactiveSessionScoped
binding the
ClientSession
provided by the given Publisher
to each and every command issued against MongoDB.
Note: It is up to the caller to manage the ClientSession
lifecycle. Use
ReactiveSessionScoped.execute(ReactiveSessionCallback, Consumer)
to provide a hook for processing the
ClientSession
when done.sessionProvider
- must not be null.ReactiveSessionScoped
. Never null.ReactiveMongoOperations withSession(com.mongodb.reactivestreams.client.ClientSession session)
ClientSession
bound instance of ReactiveMongoOperations
.
Note: It is up to the caller to manage the ClientSession
lifecycle.session
- must not be null.ClientSession
bound instance of ReactiveMongoOperations
.@Deprecated ReactiveSessionScoped inTransaction()
@Transactional
or TransactionalOperator
.ClientSession
and obtain a session
bound instance of
ReactiveSessionScoped
. Starts the transaction and adds the ClientSession
to each and every command
issued against MongoDB.
Each execution
initiates a new managed transaction
that is committed
on success. Transactions are
rolled back
upon errors.ReactiveSessionScoped
. Never null.@Deprecated ReactiveSessionScoped inTransaction(org.reactivestreams.Publisher<com.mongodb.reactivestreams.client.ClientSession> sessionProvider)
@Transactional
or TransactionalOperator
.session
bound instance of ReactiveSessionScoped
, start the transaction and
bind the ClientSession
provided by the given Publisher
to each and every command issued against
MongoDB.
Each execution
initiates a new managed transaction
that is committed
on success. Transactions are
rolled back
upon errors.sessionProvider
- must not be null.ReactiveSessionScoped
. Never null.<T> reactor.core.publisher.Mono<com.mongodb.reactivestreams.client.MongoCollection<org.bson.Document>> createCollection(Class<T> entityClass)
entityClass
- class that determines the collection to create.<T> reactor.core.publisher.Mono<com.mongodb.reactivestreams.client.MongoCollection<org.bson.Document>> createCollection(Class<T> entityClass, @Nullable CollectionOptions collectionOptions)
entityClass
- class that determines the collection to create. Must not be null.collectionOptions
- options to use when creating the collection.reactor.core.publisher.Mono<com.mongodb.reactivestreams.client.MongoCollection<org.bson.Document>> createCollection(String collectionName)
collectionName
- name of the collection.reactor.core.publisher.Mono<com.mongodb.reactivestreams.client.MongoCollection<org.bson.Document>> createCollection(String collectionName, CollectionOptions collectionOptions)
collectionName
- name of the collection. Must not be null nor empty.collectionOptions
- options to use when creating the collection.reactor.core.publisher.Flux<String> getCollectionNames()
reactor.core.publisher.Mono<com.mongodb.reactivestreams.client.MongoCollection<org.bson.Document>> getCollection(String collectionName)
MongoCollection
by 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 via
createCollection(Class)
. Please make sure to check if the collection exists
first.
Translate any exceptions as necessary.collectionName
- name of the collection.<T> reactor.core.publisher.Mono<Boolean> collectionExists(Class<T> entityClass)
entityClass
- class that determines the name of the collection. Must not be null.reactor.core.publisher.Mono<Boolean> collectionExists(String collectionName)
collectionName
- name of the collection. Must not be null.<T> reactor.core.publisher.Mono<Void> dropCollection(Class<T> entityClass)
entityClass
- class that determines the collection to drop/delete. Must not be null.reactor.core.publisher.Mono<Void> dropCollection(String collectionName)
collectionName
- name of the collection to drop/delete.<T> reactor.core.publisher.Flux<T> findAll(Class<T> entityClass)
Flux
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 MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
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.entityClass
- the parametrized type of the returned Flux
.<T> reactor.core.publisher.Flux<T> findAll(Class<T> entityClass, String collectionName)
Flux
of objects of type T from the specified collection.
The object is converted from the MongoDB native representation using an instance of MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
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.entityClass
- the parametrized type of the returned Flux
.collectionName
- name of the collection to retrieve the objects from.<T> reactor.core.publisher.Mono<T> findOne(Query query, Class<T> entityClass)
MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
will be used.
The query is specified as a Query
which can be created either using the BasicQuery
or the more
feature rich Query
.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 Mono
.<T> reactor.core.publisher.Mono<T> findOne(Query query, Class<T> entityClass, String collectionName)
MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
will be used.
The query is specified as a Query
which can be created either using the BasicQuery
or the more
feature rich Query
.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 Mono
.collectionName
- name of the collection to retrieve the objects from.reactor.core.publisher.Mono<Boolean> exists(Query query, String collectionName)
Query
contains at least one element. exists(Query, Class, String)
to get full type specific support.query
- the Query
class that specifies the criteria used to find a record.collectionName
- name of the collection to check for objects.reactor.core.publisher.Mono<Boolean> exists(Query query, Class<?> entityClass)
Query
contains at least one element.query
- the Query
class that specifies the criteria used to find a record.entityClass
- the parametrized type.reactor.core.publisher.Mono<Boolean> exists(Query query, @Nullable Class<?> entityClass, String collectionName)
Query
contains at least one element.query
- the Query
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.<T> reactor.core.publisher.Flux<T> find(Query query, Class<T> entityClass)
Flux
of the specified type.
The object is converted from the MongoDB native representation using an instance of MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
will be used.
The query is specified as a Query
which can be created either using the BasicQuery
or the more
feature rich Query
.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 Flux
. Must not be null.Flux
of converted objects.<T> reactor.core.publisher.Flux<T> find(Query query, Class<T> entityClass, String collectionName)
Flux
of the specified type.
The object is converted from the MongoDB native representation using an instance of MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
will be used.
The query is specified as a Query
which can be created either using the BasicQuery
or the more
feature rich Query
.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 Flux
.collectionName
- name of the collection to retrieve the objects from. Must not be null.Flux
of converted objects.<T> reactor.core.publisher.Mono<T> findById(Object id, Class<T> entityClass)
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.<T> reactor.core.publisher.Mono<T> findById(Object id, Class<T> entityClass, String collectionName)
id
- the id of the document to return.entityClass
- the type to convert the document to.collectionName
- the collection to query for the document.default <T> reactor.core.publisher.Flux<T> findDistinct(String field, Class<?> entityClass, Class<T> resultClass)
MongoCollection
or view and
returns the results in a Flux
.field
- the name of the field to inspect for distinct values. Must not be null.entityClass
- the domain type used for determining the actual MongoCollection
. Must not be
null.resultClass
- the result type. Must not be null.<T> reactor.core.publisher.Flux<T> findDistinct(Query query, String field, Class<?> entityClass, Class<T> resultClass)
MongoCollection
or view and
returns the results in a Flux
.query
- filter Query
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 actual MongoCollection
and mapping the
Query
to the domain type fields. Must not be null.resultClass
- the result type. Must not be null.<T> reactor.core.publisher.Flux<T> findDistinct(Query query, String field, String collectionName, Class<?> entityClass, Class<T> resultClass)
MongoCollection
or view and
returns the results in a Flux
.query
- filter Query
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 actual MongoCollection
. Must not be null.entityClass
- the domain type used for mapping the Query
to the domain type fields.resultClass
- the result type. Must not be null.default <T> reactor.core.publisher.Flux<T> findDistinct(Query query, String field, String collection, Class<T> resultClass)
MongoCollection
or view and
returns the results in a Flux
.query
- filter Query
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 actual MongoCollection
. Must not be null.resultClass
- the result type. Must not be null.<O> reactor.core.publisher.Flux<O> aggregate(TypedAggregation<?> aggregation, String collectionName, Class<O> outputType)
The raw results will be mapped to the given entity class.
Aggregation streaming cannot be used with aggregation explain
nor with
AggregationOptions.getCursorBatchSize()
. Enabling explanation mode or setting batch size cause
IllegalArgumentException
.
aggregation
- The TypedAggregation
specification holding the aggregation operations. Must not be
null.collectionName
- The name of the input collection to use for the aggregation. Must not be null.outputType
- The parametrized type of the returned Flux
. Must not be null.IllegalArgumentException
- if aggregation
, collectionName
or outputType
is
null.<O> reactor.core.publisher.Flux<O> aggregate(TypedAggregation<?> aggregation, Class<O> outputType)
aggregation input type
.
Aggregation streaming cannot be used with aggregation explain
nor with
AggregationOptions.getCursorBatchSize()
. Enabling explanation mode or setting batch size cause
IllegalArgumentException
.aggregation
- The TypedAggregation
specification holding the aggregation operations. Must not be
null.outputType
- The parametrized type of the returned Flux
. Must not be null.IllegalArgumentException
- if aggregation
or outputType
is null.<O> reactor.core.publisher.Flux<O> aggregate(Aggregation aggregation, Class<?> inputType, Class<O> outputType)
ouputType
. The name of the inputCollection is derived from the
inputType
.
Aggregation streaming cannot be used with aggregation explain
nor with
AggregationOptions.getCursorBatchSize()
. Enabling explanation mode or setting batch size cause
IllegalArgumentException
.aggregation
- The Aggregation
specification holding the aggregation operations. Must not be
null.inputType
- the inputType where the aggregation operation will read from. Must not be null.outputType
- The parametrized type of the returned Flux
. Must not be null.IllegalArgumentException
- if aggregation
, inputType
or outputType
is
null.<O> reactor.core.publisher.Flux<O> aggregate(Aggregation aggregation, String collectionName, Class<O> outputType)
aggregation explain
nor with
AggregationOptions.getCursorBatchSize()
. Enabling explanation mode or setting batch size cause
IllegalArgumentException
.aggregation
- The Aggregation
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 Flux
. Must not be null.IllegalArgumentException
- if aggregation
, collectionName
or outputType
is
null.@Deprecated <T> reactor.core.publisher.Flux<GeoResult<T>> geoNear(NearQuery near, Class<T> entityClass)
eval
command has been removed in MongoDB Server 4.2.0. Use Aggregations with
Aggregation.geoNear(NearQuery, String)
instead.Flux
of GeoResult
for all entities matching the given NearQuery
. 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 the NearQuery
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 emulate geoNear
command functionality. We recommend using
aggregations directly:
TypedAggregation<T> geoNear = TypedAggregation.newAggregation(entityClass, Aggregation.geoNear(near, "dis")) .withOptions(AggregationOptions.builder().collation(near.getCollation()).build()); Flux<Document> results = aggregate(geoNear, Document.class);
near
- must not be null.entityClass
- must not be null.GeoResult
s.@Deprecated <T> reactor.core.publisher.Flux<GeoResult<T>> geoNear(NearQuery near, Class<T> entityClass, String collectionName)
eval
command has been removed in MongoDB Server 4.2.0. Use Aggregations with
Aggregation.geoNear(NearQuery, String)
instead.Flux
of GeoResult
for all entities matching the given NearQuery
. Note, that MongoDB
limits the number of results by default. Make sure to add an explicit limit to the NearQuery
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 emulate geoNear
command functionality. We recommend using
aggregations directly:
TypedAggregation<T> geoNear = TypedAggregation.newAggregation(entityClass, Aggregation.geoNear(near, "dis")) .withOptions(AggregationOptions.builder().collation(near.getCollation()).build()); Flux<Document> results = aggregate(geoNear, Document.class);
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.GeoResult
s.<T> reactor.core.publisher.Mono<T> findAndModify(Query query, UpdateDefinition update, Class<T> entityClass)
query
- the Query
class that specifies the Criteria
used to find a record and also an optional
fields specification. Must not be null.update
- the UpdateDefinition
to apply on matching documents. Must not be null.entityClass
- the parametrized type. Must not be null.Update
,
AggregationUpdate
<T> reactor.core.publisher.Mono<T> findAndModify(Query query, UpdateDefinition update, Class<T> entityClass, String collectionName)
query
- the Query
class that specifies the Criteria
used to find a record and also an optional
fields specification. Must not be null.update
- the UpdateDefinition
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.Update
,
AggregationUpdate
<T> reactor.core.publisher.Mono<T> findAndModify(Query query, UpdateDefinition update, FindAndModifyOptions options, Class<T> entityClass)
Update
on documents matching Criteria
of given Query
taking
FindAndModifyOptions
into account.query
- the Query
class that specifies the Criteria
used to find a record and also an optional
fields specification.update
- the UpdateDefinition
to apply on matching documents.options
- the FindAndModifyOptions
holding additional information.entityClass
- the parametrized type.FindAndModifyOptions.isReturnNew()
this will either be the object as it was before the update or as it is after the update.Update
,
AggregationUpdate
<T> reactor.core.publisher.Mono<T> findAndModify(Query query, UpdateDefinition update, FindAndModifyOptions options, Class<T> entityClass, String collectionName)
Update
on documents matching Criteria
of given Query
taking
FindAndModifyOptions
into account.query
- the Query
class that specifies the Criteria
used to find a record and also an optional
fields specification. Must not be null.update
- the UpdateDefinition
to apply on matching documents. Must not be null.options
- the FindAndModifyOptions
holding additional information. Must not be null.entityClass
- the parametrized type. Must not be null.collectionName
- the collection to query. Must not be null.FindAndModifyOptions.isReturnNew()
this will either be the object as it was before the update or as it is after the update.Update
,
AggregationUpdate
default <T> reactor.core.publisher.Mono<T> findAndReplace(Query query, T replacement)
Criteria
of given Query
with the replacement
document. FindAndReplaceOptions.empty()
. default <T> reactor.core.publisher.Mono<T> findAndReplace(Query query, T replacement, String collectionName)
Criteria
of given Query
with the replacement
document. FindAndReplaceOptions.empty()
. query
- the Query
class that specifies the Criteria
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.Mono.empty()
, if not found.default <T> reactor.core.publisher.Mono<T> findAndReplace(Query query, T replacement, FindAndReplaceOptions options)
Criteria
of given Query
with the replacement
document
taking FindAndReplaceOptions
into account. query
- the Query
class that specifies the Criteria
used to find a record and also an optional
fields specification. Must not be null.replacement
- the replacement document. Must not be null.options
- the FindAndModifyOptions
holding additional information. Must not be null.Mono.empty()
, 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.default <T> reactor.core.publisher.Mono<T> findAndReplace(Query query, T replacement, FindAndReplaceOptions options, String collectionName)
Criteria
of given Query
with the replacement
document
taking FindAndReplaceOptions
into account. query
- the Query
class that specifies the Criteria
used to find a record and also an optional
fields specification. Must not be null.replacement
- the replacement document. Must not be null.options
- the FindAndModifyOptions
holding additional information. Must not be null.Mono.empty()
, 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.default <T> reactor.core.publisher.Mono<T> findAndReplace(Query query, T replacement, FindAndReplaceOptions options, Class<T> entityType, String collectionName)
Criteria
of given Query
with the replacement
document
taking FindAndReplaceOptions
into account. query
- the Query
class that specifies the Criteria
used to find a record and also an optional
fields specification. Must not be null.replacement
- the replacement document. Must not be null.options
- the FindAndModifyOptions
holding additional information. Must not be null.entityType
- the parametrized type. Must not be null.collectionName
- the collection to query. Must not be null.Mono.empty()
, 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.default <S,T> reactor.core.publisher.Mono<T> findAndReplace(Query query, S replacement, FindAndReplaceOptions options, Class<S> entityType, Class<T> resultType)
Criteria
of given Query
with the replacement
document
taking FindAndReplaceOptions
into account. query
- the Query
class that specifies the Criteria
used to find a record and also an optional
fields specification. Must not be null.replacement
- the replacement document. Must not be null.options
- the FindAndModifyOptions
holding additional information. Must not be null.entityType
- the type used for mapping the Query
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 of
Object.class
instead.Mono.empty()
, 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.<S,T> reactor.core.publisher.Mono<T> findAndReplace(Query query, S replacement, FindAndReplaceOptions options, Class<S> entityType, String collectionName, Class<T> resultType)
Criteria
of given Query
with the replacement
document
taking FindAndReplaceOptions
into account. query
- the Query
class that specifies the Criteria
used to find a record and also an optional
fields specification. Must not be null.replacement
- the replacement document. Must not be null.options
- the FindAndModifyOptions
holding additional information. Must not be null.entityType
- the type used for mapping the Query
to domain type fields and deriving the collection
from. Must not be null.collectionName
- the collection to query. Must not be null.resultType
- resultType the parametrized type projection return type. Must not be null, use the
domain type of Object.class
instead.Mono.empty()
, 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.<T> reactor.core.publisher.Mono<T> findAndRemove(Query query, Class<T> entityClass)
MongoConverter
.
The query is specified as a Query
which can be created either using the BasicQuery
or the more
feature rich Query
.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 Mono
.<T> reactor.core.publisher.Mono<T> findAndRemove(Query query, Class<T> entityClass, String collectionName)
MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
will be used.
The query is specified as a Query
which can be created either using the BasicQuery
or the more
feature rich Query
.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 Mono
.collectionName
- name of the collection to retrieve the objects from.reactor.core.publisher.Mono<Long> count(Query query, Class<?> entityClass)
Query
by querying the collection of the given entity class.
offset
and limit
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.query
- the Query
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.reactor.core.publisher.Mono<Long> count(Query query, String collectionName)
Query
querying the given collection. The given Query
must solely consist of document field references as we lack type information to map potential property references
onto document fields. Use count(Query, Class, String)
to get full type specific support. offset
and limit
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.query
- the Query
class that specifies the criteria used to find documents.collectionName
- must not be null or empty.count(Query, Class, String)
reactor.core.publisher.Mono<Long> count(Query query, @Nullable Class<?> entityClass, String collectionName)
Query
by querying the given collection using the given entity
class to map the given Query
. offset
and limit
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.query
- the Query
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.default reactor.core.publisher.Mono<Long> estimatedCount(Class<?> entityClass)
identified by the given type
,
based on collection statistics.entityClass
- must not be null.Mono
emitting the estimated number of documents.reactor.core.publisher.Mono<Long> estimatedCount(String collectionName)
collectionName
- must not be null.Mono
emitting the estimated number of documents.<T> reactor.core.publisher.Mono<T> insert(T objectToSave)
MongoConverter
.
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.
Insert is used to initially store the object into the database. To update an existing object use the save method.objectToSave
- the object to store in the collection. Must not be null.<T> reactor.core.publisher.Mono<T> insert(T objectToSave, String collectionName)
MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
will be used.
Insert is used to initially store the object into the database. To update an existing object use the save method.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.<T> reactor.core.publisher.Flux<T> insert(Collection<? extends T> batchToSave, Class<?> entityClass)
batchToSave
- the batch of objects to save. Must not be null.entityClass
- class that determines the collection to use. Must not be null.<T> reactor.core.publisher.Flux<T> insert(Collection<? extends T> batchToSave, String collectionName)
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.<T> reactor.core.publisher.Flux<T> insertAll(Collection<? extends T> objectsToSave)
objectsToSave
- the list of objects to save. Must not be null.<T> reactor.core.publisher.Mono<T> insert(reactor.core.publisher.Mono<? extends T> objectToSave)
MongoConverter
.
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.
Insert is used to initially store the object into the database. To update an existing object use the save method.objectToSave
- the object to store in the collection. Must not be null.<T> reactor.core.publisher.Flux<T> insertAll(reactor.core.publisher.Mono<? extends Collection<? extends T>> batchToSave, Class<?> entityClass)
batchToSave
- the publisher which provides objects to save. Must not be null.entityClass
- class that determines the collection to use. Must not be null.<T> reactor.core.publisher.Flux<T> insertAll(reactor.core.publisher.Mono<? extends Collection<? extends T>> batchToSave, String collectionName)
batchToSave
- the publisher which provides objects to save. Must not be null.collectionName
- name of the collection to store the object in. Must not be null.<T> reactor.core.publisher.Flux<T> insertAll(reactor.core.publisher.Mono<? extends Collection<? extends T>> objectsToSave)
objectsToSave
- the publisher which provides objects to save. Must not be null.<T> reactor.core.publisher.Mono<T> save(T objectToSave)
MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
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.objectToSave
- the object to store in the collection. Must not be null.<T> reactor.core.publisher.Mono<T> save(T objectToSave, String collectionName)
MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
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.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.<T> reactor.core.publisher.Mono<T> save(reactor.core.publisher.Mono<? extends T> objectToSave)
MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
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.objectToSave
- the object to store in the collection. Must not be null.<T> reactor.core.publisher.Mono<T> save(reactor.core.publisher.Mono<? extends T> objectToSave, String collectionName)
MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
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.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.reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> upsert(Query query, UpdateDefinition update, Class<?> entityClass)
sorting
is not supported by db.collection.updateOne
.
Use findAndModify(Query, UpdateDefinition, Class)
instead.query
- the query document that specifies the criteria used to select a record to be upserted. Must not be
null.update
- the UpdateDefinition
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.UpdateResult
which lets you access the results of the previous write.Update
,
AggregationUpdate
reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> upsert(Query query, UpdateDefinition update, String collectionName)
upsert(Query, UpdateDefinition, Class, String)
to get full type specific
support.query
- the query document that specifies the criteria used to select a record to be upserted. Must not be
null.update
- the UpdateDefinition
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.UpdateResult
which lets you access the results of the previous write.Update
,
AggregationUpdate
reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> upsert(Query query, UpdateDefinition update, Class<?> entityClass, String collectionName)
query
- the query document that specifies the criteria used to select a record to be upserted. Must not be
null.update
- the UpdateDefinition
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.UpdateResult
which lets you access the results of the previous write.Update
,
AggregationUpdate
reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> updateFirst(Query query, UpdateDefinition update, Class<?> entityClass)
sorting
is not supported by db.collection.updateOne
.
Use findAndModify(Query, UpdateDefinition, Class)
instead.query
- the query document that specifies the criteria used to select a record to be updated. Must not be
null.update
- the UpdateDefinition
that contains the updated object or $
operators to manipulate
the existing. Must not be null.entityClass
- class that determines the collection to use.UpdateResult
which lets you access the results of the previous write.Update
,
AggregationUpdate
reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> updateFirst(Query query, UpdateDefinition update, String collectionName)
updateFirst(Query, UpdateDefinition, Class, String)
to get full type specific
support. sorting
is not supported by db.collection.updateOne
.
Use findAndModify(Query, UpdateDefinition, Class, String)
instead.query
- the query document that specifies the criteria used to select a record to be updated. Must not be
null.update
- the UpdateDefinition
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.UpdateResult
which lets you access the results of the previous write.Update
,
AggregationUpdate
reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> updateFirst(Query query, UpdateDefinition update, Class<?> entityClass, String collectionName)
query
- the query document that specifies the criteria used to select a record to be updated. Must not be
null.update
- the UpdateDefinition
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.UpdateResult
which lets you access the results of the previous write.Update
,
AggregationUpdate
reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> updateMulti(Query query, UpdateDefinition update, Class<?> entityClass)
query
- the query document that specifies the criteria used to select a record to be updated. Must not be
null.update
- the UpdateDefinition
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.UpdateResult
which lets you access the results of the previous write.Update
,
AggregationUpdate
reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> updateMulti(Query query, UpdateDefinition update, String collectionName)
updateMulti(Query, UpdateDefinition, Class, String)
to get full type specific
support.query
- the query document that specifies the criteria used to select a record to be updated. Must not be
null.update
- the UpdateDefinition
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.UpdateResult
which lets you access the results of the previous write.Update
,
AggregationUpdate
reactor.core.publisher.Mono<com.mongodb.client.result.UpdateResult> updateMulti(Query query, UpdateDefinition update, Class<?> entityClass, String collectionName)
query
- the query document that specifies the criteria used to select a record to be updated. Must not be
null.update
- the UpdateDefinition
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.UpdateResult
which lets you access the results of the previous write.Update
,
AggregationUpdate
reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> remove(Object object)
object
- must not be null.DeleteResult
which lets you access the results of the previous delete.reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> remove(Object object, String collectionName)
object
- must not be null.collectionName
- name of the collection where the objects will removed, must not be null or empty.DeleteResult
which lets you access the results of the previous delete.reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> remove(reactor.core.publisher.Mono<? extends Object> objectToRemove)
objectToRemove
- must not be null.DeleteResult
which lets you access the results of the previous delete.reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> remove(reactor.core.publisher.Mono<? extends Object> objectToRemove, String collectionName)
objectToRemove
- must not be null.collectionName
- name of the collection where the objects will removed, must not be null or empty.DeleteResult
which lets you access the results of the previous delete.reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> remove(Query query, Class<?> entityClass)
query
- the query document that specifies the criteria used to remove a record.entityClass
- class that determines the collection to use.DeleteResult
which lets you access the results of the previous delete.reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> remove(Query query, @Nullable Class<?> entityClass, String collectionName)
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.DeleteResult
which lets you access the results of the previous delete.reactor.core.publisher.Mono<com.mongodb.client.result.DeleteResult> remove(Query query, String collectionName)
remove(Query, Class, String)
to get full type specific support.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.DeleteResult
which lets you access the results of the previous delete.<T> reactor.core.publisher.Flux<T> findAllAndRemove(Query query, String collectionName)
findAllAndRemove(Query, Class, String)
to get full type specific support.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.Flux
converted objects deleted by this operation.<T> reactor.core.publisher.Flux<T> findAllAndRemove(Query query, Class<T> entityClass)
query
- the query document that specifies the criteria used to find and remove documents.entityClass
- class of the pojo to be operated on.Flux
converted objects deleted by this operation.<T> reactor.core.publisher.Flux<T> findAllAndRemove(Query query, Class<T> entityClass, String collectionName)
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.Flux
converted objects deleted by this operation.<T> reactor.core.publisher.Flux<T> tail(Query query, Class<T> entityClass)
tailable
cursor that may be an infinite
stream. The stream will not be completed unless the Subscription
is
canceled
.
The object is converted from the MongoDB native representation using an instance of MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
will be used.
The query is specified as a Query
which can be created either using the BasicQuery
or the more
feature rich Query
.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 Flux
.Flux
of converted objects.<T> reactor.core.publisher.Flux<T> tail(Query query, Class<T> entityClass, String collectionName)
tailable
cursor that may be an infinite
stream. The stream will not be completed unless the Subscription
is
canceled
.
The object is converted from the MongoDB native representation using an instance of MongoConverter
. Unless
configured otherwise, an instance of MappingMongoConverter
will be used.
The query is specified as a Query
which can be created either using the BasicQuery
or the more
feature rich Query
.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 Flux
.collectionName
- name of the collection to retrieve the objects from.Flux
of converted objects.default <T> reactor.core.publisher.Flux<ChangeStreamEvent<T>> changeStream(ChangeStreamOptions options, Class<T> targetType)
Aggregation
to
filter events. The stream will not be completed unless the Subscription
is
canceled
.
The ChangeStreamEvent.getBody()
is mapped to the resultType while the
ChangeStreamEvent.getRaw()
contains the unmodified payload.
Use ChangeStreamOptions
to set arguments like the resumseToken
for resuming change streams.T
- options
- must not be null. Use ChangeStreamOptions.empty()
.targetType
- the result type to use.Flux
emitting events
as they arrive.ReactiveMongoDatabaseFactory.getMongoDatabase()
,
ChangeStreamOptions.getFilter()
default <T> reactor.core.publisher.Flux<ChangeStreamEvent<T>> changeStream(@Nullable String collectionName, ChangeStreamOptions options, Class<T> targetType)
Aggregation
to filter
events. The stream will not be completed unless the Subscription
is
canceled
.
The ChangeStreamEvent.getBody()
is mapped to the resultType while the
ChangeStreamEvent.getRaw()
contains the unmodified payload.
Use ChangeStreamOptions
to set arguments like the resumseToken
for resuming change streams.T
- collectionName
- the collection to watch. Can be null to watch all collections.options
- must not be null. Use ChangeStreamOptions.empty()
.targetType
- the result type to use.Flux
emitting events
as they arrive.ChangeStreamOptions.getFilter()
<T> reactor.core.publisher.Flux<ChangeStreamEvent<T>> changeStream(@Nullable String database, @Nullable String collectionName, ChangeStreamOptions options, Class<T> targetType)
Aggregation
to filter events. The stream will not be completed
unless the Subscription
is canceled
.
The ChangeStreamEvent.getBody()
is mapped to the resultType while the
ChangeStreamEvent.getRaw()
contains the unmodified payload.
Use ChangeStreamOptions
to set arguments like the resumseToken
for resuming change streams.T
- database
- the database to watch. Can be null, uses configured default if so.collectionName
- the collection to watch. Can be null, watches all collections if so.options
- must not be null. Use ChangeStreamOptions.empty()
.targetType
- the result type to use.Flux
emitting events
as they arrive.ChangeStreamOptions.getFilter()
<T> reactor.core.publisher.Flux<T> mapReduce(Query filterQuery, Class<?> domainType, Class<T> resultType, String mapFunction, String reduceFunction, MapReduceOptions options)
MapReduceOptions
to optionally specify an output collection and other
args.filterQuery
- the selection criteria for the documents going input to the map function. Must not be
null.domainType
- source type used to determine the input collection name and map the filter Query
against.
Must not be null.resultType
- the mapping target of the operations result documents. Must not be null.mapFunction
- the JavaScript map function. Must not be null.reduceFunction
- the JavaScript reduce function. Must not be null.options
- additional options like output collection. Must not be null.Flux
emitting the result document sequence. Never null.<T> reactor.core.publisher.Flux<T> mapReduce(Query filterQuery, Class<?> domainType, String inputCollectionName, Class<T> resultType, String mapFunction, String reduceFunction, MapReduceOptions options)
MapReduceOptions
to optionally specify an output collection and other
args.filterQuery
- the selection criteria for the documents going input to the map function. Must not be
null.domainType
- source type used to map the filter Query
against. Must not be null.inputCollectionName
- the input collection.resultType
- the mapping target of the operations result documents. Must not be null.mapFunction
- the JavaScript map function. Must not be null.reduceFunction
- the JavaScript reduce function. Must not be null.options
- additional options like output collection. Must not be null.Flux
emitting the result document sequence. Never null.MongoConverter getConverter()
MongoConverter
.Copyright © 2011–2021 Pivotal Software, Inc.. All rights reserved.