Class MongoCollection

Atlas Device SDKs are deprecated. Refer to the deprecation page for details.

io.realm.mongodb.mongo

java.lang.Object

io.realm.mongodb.mongo.MongoCollection

The MongoCollection interface provides read and write access to documents.Use MongoDatabase.getCollection to get a collection instance.

Before any access is possible, there must be an active, logged-in user.

Tip

Method Summary

Modifier and Type	Method and Description
public AggregateIterable	aggregate <ResultT >( java.util.List<? extends Bson> pipeline, java.lang.Class<ResultT> resultClass ) Aggregates documents according to the specified aggregation pipeline specifying an output class.
public AggregateIterable	aggregate ( java.util.List<? extends Bson> pipeline ) Aggregates documents according to the specified aggregation pipeline.
public RealmResultTask	count ( Bson filter, CountOptions options ) Counts the number of documents in the collection according to the given options.
public RealmResultTask	count ( Bson filter ) Counts the number of documents in the collection according to the given options.
public RealmResultTask	count () Counts the number of documents in the collection.
public RealmResultTask	deleteMany ( Bson filter ) Removes all documents from the collection that match the given query filter.
public RealmResultTask	deleteOne ( Bson filter ) Removes at most one document from the collection that matches the given filter.
public FindIterable	find <ResultT >( Bson filter, java.lang.Class<ResultT> resultClass, FindOptions options ) Finds all documents in the collection that match the given filter specifying an output class and also using FindOptions to build the query.
public FindIterable	find <ResultT >( Bson filter, java.lang.Class<ResultT> resultClass ) Finds all documents in the collection that match the given filter specifying an output class.
public FindIterable	find ( Bson filter, FindOptions options ) Finds all documents in the collection that match the given filter using FindOptions to build the query.
public FindIterable	find ( Bson filter ) Finds all documents in the collection that match the given filter.
public FindIterable	find <ResultT >( java.lang.Class<ResultT> resultClass, FindOptions options ) Finds all documents in the collection specifying an output class and also using FindOptions to build the query.
public FindIterable	find <ResultT >( java.lang.Class<ResultT> resultClass ) Finds all documents in the collection specifying an output class.
public FindIterable	find ( FindOptions options ) Finds all documents in the collection using FindOptions to build the query.
public FindIterable	find () Finds all documents in the collection.
public RealmResultTask	findOne <ResultT >( Bson filter, FindOptions options, java.lang.Class<ResultT> resultClass ) Finds a document in the collection.
public RealmResultTask	findOne ( Bson filter, FindOptions options ) Finds a document in the collection.
public RealmResultTask	findOne <ResultT >( Bson filter, java.lang.Class<ResultT> resultClass ) Finds a document in the collection.
public RealmResultTask	findOne ( Bson filter ) Finds a document in the collection.
public RealmResultTask	findOne <ResultT >( java.lang.Class<ResultT> resultClass ) Finds a document in the collection.
public RealmResultTask	findOne () Finds a document in the collection.
public RealmResultTask	findOneAndDelete <ResultT >( Bson filter, FindOneAndModifyOptions options, java.lang.Class<ResultT> resultClass ) Finds a document in the collection and delete it.
public RealmResultTask	findOneAndDelete ( Bson filter, FindOneAndModifyOptions options ) Finds a document in the collection and delete it.
public RealmResultTask	findOneAndDelete <ResultT >( Bson filter, java.lang.Class<ResultT> resultClass ) Finds a document in the collection and delete it.
public RealmResultTask	findOneAndDelete ( Bson filter ) Finds a document in the collection and delete it.
public RealmResultTask	findOneAndReplace <ResultT >( Bson filter, Bson replacement, FindOneAndModifyOptions options, java.lang.Class<ResultT> resultClass ) Finds a document in the collection and replaces it with the given document.
public RealmResultTask	findOneAndReplace ( Bson filter, Bson replacement, FindOneAndModifyOptions options ) Finds a document in the collection and replaces it with the given document.
public RealmResultTask	findOneAndReplace <ResultT >( Bson filter, Bson replacement, java.lang.Class<ResultT> resultClass ) Finds a document in the collection and replaces it with the given document.
public RealmResultTask	findOneAndReplace ( Bson filter, Bson replacement ) Finds a document in the collection and replaces it with the given document.
public RealmResultTask	findOneAndUpdate <ResultT >( Bson filter, Bson update, FindOneAndModifyOptions options, java.lang.Class<ResultT> resultClass ) Finds a document in the collection and performs the given update.
public RealmResultTask	findOneAndUpdate ( Bson filter, Bson update, FindOneAndModifyOptions options ) Finds a document in the collection and performs the given update.
public RealmResultTask	findOneAndUpdate <ResultT >( Bson filter, Bson update, java.lang.Class<ResultT> resultClass ) Finds a document in the collection and performs the given update.
public RealmResultTask	findOneAndUpdate ( Bson filter, Bson update ) Finds a document in the collection and performs the given update.
public CodecRegistry	getCodecRegistry () Gets the codec registry for the MongoCollection.
public Class	getDocumentClass () Gets the class of documents stored in this collection.
public String	getName () Gets the name of this collection
public MongoNamespace	getNamespace () Gets the namespace of this collection, i.e.
public RealmResultTask	insertMany ( java.util.List<? extends DocumentT> documents ) Inserts one or more documents.
public RealmResultTask	insertOne ( DocumentT document ) Inserts the provided document.
public RealmResultTask	updateMany ( Bson filter, Bson update, UpdateOptions updateOptions ) Update all documents in the collection according to the specified arguments.
public RealmResultTask	updateMany ( Bson filter, Bson update ) Update all documents in the collection according to the specified arguments.
public RealmResultTask	updateOne ( Bson filter, Bson update, UpdateOptions updateOptions ) Update a single document in the collection according to the specified arguments.
public RealmResultTask	updateOne ( Bson filter, Bson update ) Update a single document in the collection according to the specified arguments.
public RealmEventStreamTask	watch ( ObjectId[] ids ) Watches specified IDs in a collection.
public RealmEventStreamTask	watch ( BsonValue[] ids ) Watches specified IDs in a collection.
public RealmEventStreamTask	watch () Watches a collection.
public RealmEventStreamAsyncTask	watchAsync ( ObjectId[] ids ) Watches specified IDs in a collection asynchronously.
public RealmEventStreamAsyncTask	watchAsync ( BsonValue[] ids ) Watches specified IDs in a collection asynchronously.
public RealmEventStreamAsyncTask	watchAsync () Watches a collection asynchronously.
public RealmEventStreamTask	watchWithFilter ( BsonDocument matchFilter ) Watches a collection.
public RealmEventStreamTask	watchWithFilter ( Document matchFilter ) Watches a collection.
public RealmEventStreamAsyncTask	watchWithFilterAsync ( BsonDocument matchFilter ) Watches a collection asynchronously.
public RealmEventStreamAsyncTask	watchWithFilterAsync ( Document matchFilter ) Watches a collection asynchronously.
public MongoCollection	withCodecRegistry ( CodecRegistry codecRegistry ) Creates a new MongoCollection instance with a different codec registry.
public MongoCollection	withDocumentClass <NewDocumentT >( java.lang.Class<NewDocumentT> clazz ) Creates a new MongoCollection instance with a different default class to cast any documents returned from the database into.

Inherited Methods

Methods inherited from class java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

Method Detail

aggregate

public AggregateIterable aggregate <ResultT >(

java.util.List<? extends Bson> pipeline,

java.lang.Class<ResultT> resultClass

)

Aggregates documents according to the specified aggregation pipeline specifying an output class.All documents will be delivered in the form of an AggregateIterable from which individual elements can be extracted.

Type Parameters

ResultT - the target document type of the iterable.

Parameters

pipeline - the aggregation pipeline
resultClass - the class to decode each document into

Returns

an AggregateIterable from which the results can be extracted

public AggregateIterable aggregate ( java.util.List<? extends Bson> pipeline )
Aggregates documents according to the specified aggregation pipeline.All documents will be delivered in the form of an AggregateIterable from which individual elements can be extracted. Parameters `pipeline` - the aggregation pipeline Returns an AggregateIterable from which the results can be extracted

count

public RealmResultTask count ( Bson filter, CountOptions options )
Counts the number of documents in the collection according to the given options. Parameters `filter` - the query filter `options` - the options describing the count Returns a task containing the number of documents in the collection

public RealmResultTask count ( Bson filter )
Counts the number of documents in the collection according to the given options. Parameters `filter` - the query filter Returns a task containing the number of documents in the collection

public RealmResultTask count ()
Counts the number of documents in the collection. Returns a task containing the number of documents in the collection

deleteMany

public RealmResultTask deleteMany ( Bson filter )
Removes all documents from the collection that match the given query filter. If no documents match, the collection is not modified. Parameters `filter` - the query filter to apply the the delete operation Returns a task containing the result of the remove many operation

deleteOne

public RealmResultTask deleteOne ( Bson filter )
Removes at most one document from the collection that matches the given filter. If no documents match, the collection is not modified. Parameters `filter` - the query filter to apply the the delete operation Returns a task containing the result of the remove one operation

find

public FindIterable find <ResultT >(

Bson filter,
java.lang.Class<ResultT>  resultClass,
FindOptions  options

)

Finds all documents in the collection that match the given filter specifying an output class and also using FindOptions to build the query.

All documents will be delivered in the form of a FindIterable from which individual elements can be extracted.

Type Parameters

ResultT - the target document type of the iterable.

Parameters

filter - the query filter
resultClass - the class to decode each document into
options - a FindOptions struct

Returns

an iterable containing the result of the find operation

public FindIterable find <ResultT >(

Bson filter,

java.lang.Class<ResultT> resultClass

)

Finds all documents in the collection that match the given filter specifying an output class.All documents will be delivered in the form of a FindIterable from which individual elements can be extracted.

Type Parameters

ResultT - the target document type of the iterable.

Parameters

filter - the query filter
resultClass - the class to decode each document into

Returns

an iterable containing the result of the find operation

public FindIterable find ( Bson filter, FindOptions options )
Finds all documents in the collection that match the given filter using FindOptions to build the query. All documents will be delivered in the form of a FindIterable from which individual elements can be extracted. Parameters `filter` - the query filter `options` - a FindOptions struct Returns an iterable containing the result of the find operation

public FindIterable find ( Bson filter )
Finds all documents in the collection that match the given filter.All documents will be delivered in the form of a FindIterable from which individual elements can be extracted. Parameters `filter` - the query filter Returns an iterable containing the result of the find operation

public FindIterable find <ResultT >(

java.lang.Class<ResultT> resultClass,

FindOptions options

)

Finds all documents in the collection specifying an output class and also using FindOptions to build the query.

All documents will be delivered in the form of a FindIterable from which individual elements can be extracted.

Type Parameters

ResultT - the target document type of the iterable.

Parameters

resultClass - the class to decode each document into
options - a FindOptions struct for building the query

Returns

an iterable containing the result of the find operation

public FindIterable find <ResultT >( java.lang.Class<ResultT> resultClass )
Finds all documents in the collection specifying an output class.All documents will be delivered in the form of a FindIterable from which individual elements can be extracted. Type Parameters `ResultT` - the target document type of the iterable. Parameters `resultClass` - the class to decode each document into Returns an iterable containing the result of the find operation

public FindIterable find ( FindOptions options )
Finds all documents in the collection using FindOptions to build the query. All documents will be delivered in the form of a FindIterable from which individual elements can be extracted. Parameters `options` - a FindOptions struct for building the query Returns an iterable containing the result of the find operation

public FindIterable find ()
Finds all documents in the collection.All documents will be delivered in the form of a FindIterable from which individual elements can be extracted. Returns an iterable containing the result of the find operation

findOne

public RealmResultTask findOne <ResultT >( Bson filter, FindOptions options, java.lang.Class<ResultT> resultClass )
Finds a document in the collection. Type Parameters `ResultT` - the target document type of the iterable. Parameters `filter` - the query filter `options` - a FindOptions struct `resultClass` - the class to decode each document into Returns a task containing the result of the find one operation

public RealmResultTask findOne ( Bson filter, FindOptions options )
Finds a document in the collection. Parameters `filter` - the query filter `options` - a FindOptions struct Returns a task containing the result of the find one operation

public RealmResultTask findOne <ResultT >( Bson filter, java.lang.Class<ResultT> resultClass )
Finds a document in the collection. Type Parameters `ResultT` - the target document type of the iterable. Parameters `filter` - the query filter `resultClass` - the class to decode each document into Returns a task containing the result of the find one operation

public RealmResultTask findOne ( Bson filter )
Finds a document in the collection. Parameters `filter` - the query filter Returns a task containing the result of the find one operation

public RealmResultTask findOne <ResultT >( java.lang.Class<ResultT> resultClass )
Finds a document in the collection. Type Parameters `ResultT` - the target document type Parameters `resultClass` - the class to decode each document into Returns a task containing the result of the find one operation

public RealmResultTask findOne ()
Finds a document in the collection. Returns a task containing the result of the find one operation

findOneAndDelete

public RealmResultTask findOneAndDelete <ResultT >( Bson filter, FindOneAndModifyOptions options, java.lang.Class<ResultT> resultClass )
Finds a document in the collection and delete it. Type Parameters `ResultT` - the target document type of the iterable. Parameters `filter` - the query filter `options` - a FindOneAndModifyOptions struct `resultClass` - the class to decode each document into Returns a task containing the resulting document

public RealmResultTask findOneAndDelete ( Bson filter, FindOneAndModifyOptions options )
Finds a document in the collection and delete it. Parameters `filter` - the query filter `options` - a FindOneAndModifyOptions struct Returns a task containing the resulting document

public RealmResultTask findOneAndDelete <ResultT >( Bson filter, java.lang.Class<ResultT> resultClass )
Finds a document in the collection and delete it. Type Parameters `ResultT` - the target document type of the iterable. Parameters `filter` - the query filter `resultClass` - the class to decode each document into Returns a task containing the resulting document

public RealmResultTask findOneAndDelete ( Bson filter )
Finds a document in the collection and delete it. Parameters `filter` - the query filter Returns a task containing the resulting document

findOneAndReplace

public RealmResultTask findOneAndReplace <ResultT >(

Bson filter,
Bson replacement,
FindOneAndModifyOptions  options,
java.lang.Class<ResultT>  resultClass

)

Finds a document in the collection and replaces it with the given document.

Type Parameters

ResultT - the target document type of the iterable.

Parameters

filter - the query filter
replacement - the document to replace the matched document with
options - a FindOneAndModifyOptions struct
resultClass - the class to decode each document into

Returns

a task containing the resulting document

public RealmResultTask findOneAndReplace ( Bson filter, Bson replacement, FindOneAndModifyOptions options )
Finds a document in the collection and replaces it with the given document. Parameters `filter` - the query filter `replacement` - the document to replace the matched document with `options` - a FindOneAndModifyOptions struct Returns a task containing the resulting document

public RealmResultTask findOneAndReplace <ResultT >( Bson filter, Bson replacement, java.lang.Class<ResultT> resultClass )
Finds a document in the collection and replaces it with the given document. Type Parameters `ResultT` - the target document type of the iterable. Parameters `filter` - the query filter `replacement` - the document to replace the matched document with `resultClass` - the class to decode each document into Returns a task containing the resulting document

public RealmResultTask findOneAndReplace ( Bson filter, Bson replacement )
Finds a document in the collection and replaces it with the given document. Parameters `filter` - the query filter `replacement` - the document to replace the matched document with Returns a task containing the resulting document

findOneAndUpdate

public RealmResultTask findOneAndUpdate <ResultT >( Bson filter, Bson update, FindOneAndModifyOptions options, java.lang.Class<ResultT> resultClass )
Finds a document in the collection and performs the given update. Type Parameters `ResultT` - the target document type of the iterable. Parameters `filter` - the query filter `update` - the update document `options` - a FindOneAndModifyOptions struct `resultClass` - the class to decode each document into Returns a task containing the resulting document

public RealmResultTask findOneAndUpdate ( Bson filter, Bson update, FindOneAndModifyOptions options )
Finds a document in the collection and performs the given update. Parameters `filter` - the query filter `update` - the update document `options` - a FindOneAndModifyOptions struct Returns a task containing the resulting document

public RealmResultTask findOneAndUpdate <ResultT >( Bson filter, Bson update, java.lang.Class<ResultT> resultClass )
Finds a document in the collection and performs the given update. Type Parameters `ResultT` - the target document type of the iterable. Parameters `filter` - the query filter `update` - the update document `resultClass` - the class to decode each document into Returns a task containing the resulting document

public RealmResultTask findOneAndUpdate ( Bson filter, Bson update )
Finds a document in the collection and performs the given update. Parameters `filter` - the query filter `update` - the update document Returns a task containing the resulting document

getCodecRegistry

public CodecRegistry getCodecRegistry ()
Gets the codec registry for the MongoCollection. Returns the CodecRegistry for this collection

getDocumentClass

public Class getDocumentClass ()
Gets the class of documents stored in this collection.If you used the simple MongoDatabase.getCollection(String) to get this collection, this is org.bson.Document . Returns the class of documents in this collection

getName

public String getName ()
Gets the name of this collection Returns the name

getNamespace

public MongoNamespace getNamespace ()
Gets the namespace of this collection, i.e. the database and collection names together. Returns the namespace

insertMany

public RealmResultTask insertMany ( java.util.List<? extends DocumentT> documents )
Inserts one or more documents. Parameters `documents` - the documents to insert Returns a task containing the result of the insert many operation

insertOne

public RealmResultTask insertOne ( DocumentT document )
Inserts the provided document. If the document is missing an identifier, the client should generate one. Parameters `document` - the document to insert Returns a task containing the result of the insert one operation

updateMany

public RealmResultTask updateMany (

Bson filter,
Bson update,
UpdateOptions  updateOptions

)

Update all documents in the collection according to the specified arguments.

Parameters

filter - a document describing the query filter, which may not be null.
update - a document describing the update, which may not be null. The update to apply must include only update operators.
updateOptions - the options to apply to the update operation

Returns

a task containing the result of the update many operation

public RealmResultTask updateMany ( Bson filter, Bson update )
Update all documents in the collection according to the specified arguments. Parameters `filter` - a document describing the query filter, which may not be null. `update` - a document describing the update, which may not be null. The update to apply must include only update operators. Returns a task containing the result of the update many operation

updateOne

public RealmResultTask updateOne (

Bson filter,
Bson update,
UpdateOptions  updateOptions

)

Update a single document in the collection according to the specified arguments.

Parameters

filter - a document describing the query filter, which may not be null.
update - a document describing the update, which may not be null. The update to apply must include only update operators.
updateOptions - the options to apply to the update operation

Returns

a task containing the result of the update one operation

public RealmResultTask updateOne ( Bson filter, Bson update )
Update a single document in the collection according to the specified arguments. Parameters `filter` - a document describing the query filter, which may not be null. `update` - a document describing the update, which may not be null. The update to apply must include only update operators. Returns a task containing the result of the update one operation

watch

public RealmEventStreamTask watch ( ObjectId[] ids )
Watches specified IDs in a collection. This convenience overload supports the use case of non-BsonValue instances of ObjectId by wrapping them in BsonObjectId instances for the user. Parameters `ids` - unique object identifiers of the IDs to watch. Returns a task that provides access to the stream of change events.

public RealmEventStreamTask watch ( BsonValue[] ids )
Watches specified IDs in a collection. Parameters `ids` - the ids to watch. Returns a task that provides access to the stream of change events.

public RealmEventStreamTask watch ()
Watches a collection. The resulting stream will be notified of all events on this collection that the active user is authorized to see based on the configured MongoDB Realm rules. Returns a task that provides access to the stream of change events.

watchAsync

public RealmEventStreamAsyncTask watchAsync ( ObjectId[] ids )
Watches specified IDs in a collection asynchronously. This convenience overload supports the use case of non-BsonValue instances of ObjectId by wrapping them in BsonObjectId instances for the user. Parameters `ids` - unique object identifiers of the IDs to watch. Returns a task that provides access to the stream of change events.

public RealmEventStreamAsyncTask watchAsync ( BsonValue[] ids )
Watches specified IDs in a collection asynchronously. Parameters `ids` - the ids to watch. Returns a task that provides access to the stream of change events.

public RealmEventStreamAsyncTask watchAsync ()
Watches a collection asynchronously. The resulting stream will be notified of all events on this collection that the active user is authorized to see based on the configured MongoDB Realm rules. Returns a task that provides access to the stream of change events.

watchWithFilter

public RealmEventStreamTask watchWithFilter (

BsonDocument matchFilter

)

Watches a collection. The provided BSON document will be used as a match expression filter on the change events coming from the stream.See how to define a match filter .

Defining the match expression to filter ChangeEvents is similar to how to define the match expression for triggers

Parameters

matchFilter - the $match filter to apply to incoming change events

Returns

a task that provides access to the stream of change events.

public RealmEventStreamTask watchWithFilter (

Document matchFilter

)

Watches a collection. The provided document will be used as a match expression filter on the change events coming from the stream. This convenience overload supports the use of non-BsonDocument instances for the user.

See how to define a match filter .

Defining the match expression to filter ChangeEvents is similar to how to define the match expression for triggers

Parameters

matchFilter - the $match filter to apply to incoming change events

Returns

a task that provides access to the stream of change events.

watchWithFilterAsync

public RealmEventStreamAsyncTask watchWithFilterAsync (

BsonDocument matchFilter

)

Watches a collection asynchronously. The provided BSON document will be used as a match expression filter on the change events coming from the stream.See how to define a match filter .

Defining the match expression to filter ChangeEvents is similar to how to define the match expression for triggers

Parameters

matchFilter - the $match filter to apply to incoming change events

Returns

a task that provides access to the stream of change events.

public RealmEventStreamAsyncTask watchWithFilterAsync (

Document matchFilter

)

Watches a collection asynchronously. The provided document will be used as a match expression filter on the change events coming from the stream. This convenience overload supports the use of non-BsonDocument instances for the user.

See how to define a match filter .

Defining the match expression to filter ChangeEvents is similar to how to define the match expression for triggers

Parameters

matchFilter - the $match filter to apply to incoming change events

Returns

a task that provides access to the stream of change events.

withCodecRegistry

public MongoCollection withCodecRegistry ( CodecRegistry codecRegistry )
Creates a new MongoCollection instance with a different codec registry. Parameters `codecRegistry` - the new CodecRegistry for the collection. Returns a new MongoCollection instance with the different codec registry

withDocumentClass

public MongoCollection withDocumentClass <NewDocumentT >(

java.lang.Class<NewDocumentT> clazz

)

Creates a new MongoCollection instance with a different default class to cast any documents returned from the database into.

Type Parameters

NewDocumentT - The type that the new collection will encode documents from and decode documents to.

Parameters

clazz - the default class to which any documents returned from the database will be cast.

Returns

a new MongoCollection instance with the different default class

Back

MongoClient

MongoDatabase

io.realm.mongodb.mongo

Tip

See also:

Method Summary

Inherited Methods

Method Detail

aggregate

count

deleteMany

deleteOne

find

findOne

findOneAndDelete

findOneAndReplace

findOneAndUpdate

getCodecRegistry

getDocumentClass

getName

getNamespace

insertMany

insertOne

updateMany

updateOne

watch

watchAsync

watchWithFilter

watchWithFilterAsync

withCodecRegistry

withDocumentClass