com.mongodb.async.client

Interface MongoCollection<TDocument>

Type Parameters:

TDocument - The type that this collection will encode documents from and decode documents to.

@ThreadSafe
public interface MongoCollection<TDocument>

The MongoCollection interface.

Note: Additions to this interface will not be considered to break binary compatibility.

MongoCollection is generic allowing for different types to represent documents. Any custom classes must have a Codec registered in the CodecRegistry. The default CodecRegistry includes built-in support for: BsonDocument and Document.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
AggregateIterable<TDocument>	aggregate(List<? extends Bson> pipeline) Aggregates documents according to the specified aggregation pipeline.
<TResult> AggregateIterable<TResult>	aggregate(List<? extends Bson> pipeline, Class<TResult> resultClass) Aggregates documents according to the specified aggregation pipeline.
void	bulkWrite(List<? extends WriteModel<? extends TDocument>> requests, BulkWriteOptions options, SingleResultCallback<BulkWriteResult> callback) Executes a mix of inserts, updates, replaces, and deletes.
void	bulkWrite(List<? extends WriteModel<? extends TDocument>> requests, SingleResultCallback<BulkWriteResult> callback) Executes a mix of inserts, updates, replaces, and deletes.
void	count(Bson filter, CountOptions options, SingleResultCallback<Long> callback) Counts the number of documents in the collection according to the given options.
void	count(Bson filter, SingleResultCallback<Long> callback) Counts the number of documents in the collection according to the given options.
void	count(SingleResultCallback<Long> callback) Counts the number of documents in the collection.
void	createIndex(Bson key, IndexOptions options, SingleResultCallback<String> callback) Creates an index.
void	createIndex(Bson key, SingleResultCallback<String> callback) Creates an index.
void	createIndexes(List<IndexModel> indexes, SingleResultCallback<List<String>> callback) Create multiple indexes.
void	deleteMany(Bson filter, DeleteOptions options, SingleResultCallback<DeleteResult> callback) Removes all documents from the collection that match the given query filter.
void	deleteMany(Bson filter, SingleResultCallback<DeleteResult> callback) Removes all documents from the collection that match the given query filter.
void	deleteOne(Bson filter, DeleteOptions options, SingleResultCallback<DeleteResult> callback) Removes at most one document from the collection that matches the given filter.
void	deleteOne(Bson filter, SingleResultCallback<DeleteResult> callback) Removes at most one document from the collection that matches the given filter.
<TResult> DistinctIterable<TResult>	distinct(String fieldName, Bson filter, Class<TResult> resultClass) Gets the distinct values of the specified field name.
<TResult> DistinctIterable<TResult>	distinct(String fieldName, Class<TResult> resultClass) Gets the distinct values of the specified field name.
void	drop(SingleResultCallback<Void> callback) Drops this collection from the Database.
void	dropIndex(Bson keys, SingleResultCallback<Void> callback) Drops the index given the keys used to create it.
void	dropIndex(String indexName, SingleResultCallback<Void> callback) Drops the index given its name.
void	dropIndexes(SingleResultCallback<Void> callback) Drop all the indexes on this collection, except for the default on _id.
FindIterable<TDocument>	find() Finds all documents in the collection.
FindIterable<TDocument>	find(Bson filter) Finds all documents in the collection.
<TResult> FindIterable<TResult>	find(Bson filter, Class<TResult> resultClass) Finds all documents in the collection.
<TResult> FindIterable<TResult>	find(Class<TResult> resultClass) Finds all documents in the collection.
void	findOneAndDelete(Bson filter, FindOneAndDeleteOptions options, SingleResultCallback<TDocument> callback) Atomically find a document and remove it.
void	findOneAndDelete(Bson filter, SingleResultCallback<TDocument> callback) Atomically find a document and remove it.
void	findOneAndReplace(Bson filter, TDocument replacement, FindOneAndReplaceOptions options, SingleResultCallback<TDocument> callback) Atomically find a document and replace it.
void	findOneAndReplace(Bson filter, TDocument replacement, SingleResultCallback<TDocument> callback) Atomically find a document and replace it.
void	findOneAndUpdate(Bson filter, Bson update, FindOneAndUpdateOptions options, SingleResultCallback<TDocument> callback) Atomically find a document and update it.
void	findOneAndUpdate(Bson filter, Bson update, SingleResultCallback<TDocument> callback) Atomically find a document and update it.
CodecRegistry	getCodecRegistry() Get the codec registry for the MongoCollection.
Class<TDocument>	getDocumentClass() Get the class of documents stored in this collection.
MongoNamespace	getNamespace() Gets the namespace of this collection.
ReadConcern	getReadConcern() Get the read concern for the MongoCollection.
ReadPreference	getReadPreference() Get the read preference for the MongoCollection.
WriteConcern	getWriteConcern() Get the write concern for the MongoCollection.
void	insertMany(List<? extends TDocument> documents, InsertManyOptions options, SingleResultCallback<Void> callback) Inserts one or more documents.
void	insertMany(List<? extends TDocument> documents, SingleResultCallback<Void> callback) Inserts one or more documents.
void	insertOne(TDocument document, InsertOneOptions options, SingleResultCallback<Void> callback) Inserts the provided document.
void	insertOne(TDocument document, SingleResultCallback<Void> callback) Inserts the provided document.
ListIndexesIterable<Document>	listIndexes() Get all the indexes in this collection.
<TResult> ListIndexesIterable<TResult>	listIndexes(Class<TResult> resultClass) Get all the indexes in this collection.
MapReduceIterable<TDocument>	mapReduce(String mapFunction, String reduceFunction) Aggregates documents according to the specified map-reduce function.
<TResult> MapReduceIterable<TResult>	mapReduce(String mapFunction, String reduceFunction, Class<TResult> resultClass) Aggregates documents according to the specified map-reduce function.
void	renameCollection(MongoNamespace newCollectionNamespace, RenameCollectionOptions options, SingleResultCallback<Void> callback) Rename the collection with oldCollectionName to the newCollectionName.
void	renameCollection(MongoNamespace newCollectionNamespace, SingleResultCallback<Void> callback) Rename the collection with oldCollectionName to the newCollectionName.
void	replaceOne(Bson filter, TDocument replacement, SingleResultCallback<UpdateResult> callback) Replace a document in the collection according to the specified arguments.
void	replaceOne(Bson filter, TDocument replacement, UpdateOptions options, SingleResultCallback<UpdateResult> callback) Replace a document in the collection according to the specified arguments.
void	updateMany(Bson filter, Bson update, SingleResultCallback<UpdateResult> callback) Update all documents in the collection according to the specified arguments.
void	updateMany(Bson filter, Bson update, UpdateOptions options, SingleResultCallback<UpdateResult> callback) Update all documents in the collection according to the specified arguments.
void	updateOne(Bson filter, Bson update, SingleResultCallback<UpdateResult> callback) Update a single document in the collection according to the specified arguments.
void	updateOne(Bson filter, Bson update, UpdateOptions options, SingleResultCallback<UpdateResult> callback) Update a single document in the collection according to the specified arguments.
MongoCollection<TDocument>	withCodecRegistry(CodecRegistry codecRegistry) Create a new MongoCollection instance with a different codec registry.
<NewTDocument> MongoCollection<NewTDocument>	withDocumentClass(Class<NewTDocument> newDocumentClass) Create a new MongoCollection instance with a different default class to cast any documents returned from the database into..
MongoCollection<TDocument>	withReadConcern(ReadConcern readConcern) Create a new MongoCollection instance with a different read concern.
MongoCollection<TDocument>	withReadPreference(ReadPreference readPreference) Create a new MongoCollection instance with a different read preference.
MongoCollection<TDocument>	withWriteConcern(WriteConcern writeConcern) Create a new MongoCollection instance with a different write concern.

Method Detail

getNamespace

MongoNamespace getNamespace()

Gets the namespace of this collection.

Returns:

the namespace

getDocumentClass

Class<TDocument> getDocumentClass()

Get the class of documents stored in this collection.

Returns:

the class

getCodecRegistry

CodecRegistry getCodecRegistry()

Get the codec registry for the MongoCollection.

Returns:

the CodecRegistry

getReadPreference

ReadPreference getReadPreference()

Get the read preference for the MongoCollection.

Returns:

the ReadPreference

getWriteConcern

WriteConcern getWriteConcern()

Get the write concern for the MongoCollection.

Returns:

the WriteConcern

getReadConcern

ReadConcern getReadConcern()

Get the read concern for the MongoCollection.

Returns:

the ReadConcern

Since:

3.2

MongoDB documentation

Read Concern

Since server release

3.2

withDocumentClass

<NewTDocument> MongoCollection<NewTDocument> withDocumentClass(Class<NewTDocument> newDocumentClass)

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

Type Parameters:

NewTDocument - the type that the new collection will encode documents from and decode documents to

Parameters:

newDocumentClass - the default class to cast any documents returned from the database into.

Returns:

a new MongoCollection instance with the different default class

withCodecRegistry

MongoCollection<TDocument> withCodecRegistry(CodecRegistry codecRegistry)

Create 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

withReadPreference

MongoCollection<TDocument> withReadPreference(ReadPreference readPreference)

Create a new MongoCollection instance with a different read preference.

Parameters:

readPreference - the new ReadPreference for the collection

Returns:

a new MongoCollection instance with the different readPreference

withWriteConcern

MongoCollection<TDocument> withWriteConcern(WriteConcern writeConcern)

Create a new MongoCollection instance with a different write concern.

Parameters:

writeConcern - the new WriteConcern for the collection

Returns:

a new MongoCollection instance with the different writeConcern

withReadConcern

MongoCollection<TDocument> withReadConcern(ReadConcern readConcern)

Create a new MongoCollection instance with a different read concern.

Parameters:

readConcern - the new ReadConcern for the collection

Returns:

a new MongoCollection instance with the different ReadConcern

Since:

3.2

MongoDB documentation

Read Concern

Since server release

3.2

count

void count(SingleResultCallback<Long> callback)

Counts the number of documents in the collection.

Parameters:

callback - the callback passed the number of documents in the collection

count

void count(Bson filter,
           SingleResultCallback<Long> callback)

Counts the number of documents in the collection according to the given options.

Parameters:

filter - the query filter

callback - the callback passed the number of documents in the collection

count

void count(Bson filter,
           CountOptions options,
           SingleResultCallback<Long> callback)

Counts the number of documents in the collection according to the given options.

Parameters:

filter - the query filter

options - the options describing the count

callback - the callback passed the number of documents in the collection

distinct

<TResult> DistinctIterable<TResult> distinct(String fieldName,
                                             Class<TResult> resultClass)

Gets the distinct values of the specified field name.

Type Parameters:

TResult - the target type of the iterable.

Parameters:

fieldName - the field name

resultClass - the default class to cast any distinct items into.

Returns:

an iterable of distinct values

MongoDB documentation

Distinct

distinct

<TResult> DistinctIterable<TResult> distinct(String fieldName,
                                             Bson filter,
                                             Class<TResult> resultClass)

Gets the distinct values of the specified field name.

Type Parameters:

TResult - the target type of the iterable.

Parameters:

fieldName - the field name

filter - the query filter

resultClass - the default class to cast any distinct items into.

Returns:

an iterable of distinct values

MongoDB documentation

Distinct

find

FindIterable<TDocument> find()

Finds all documents in the collection.

Returns:

the find iterable interface

MongoDB documentation

Find

find

<TResult> FindIterable<TResult> find(Class<TResult> resultClass)

Finds all documents in the collection.

Type Parameters:

TResult - the target document type of the iterable.

Parameters:

resultClass - the class to decode each document into

Returns:

the find iterable interface

MongoDB documentation

Find

find

FindIterable<TDocument> find(Bson filter)

Finds all documents in the collection.

Parameters:

filter - the query filter

Returns:

the find iterable interface

MongoDB documentation

Find

find

<TResult> FindIterable<TResult> find(Bson filter,
                                     Class<TResult> resultClass)

Finds all documents in the collection.

Type Parameters:

TResult - the target document type of the iterable.

Parameters:

filter - the query filter

resultClass - the class to decode each document into

Returns:

the find iterable interface

MongoDB documentation

Find

aggregate

AggregateIterable<TDocument> aggregate(List<? extends Bson> pipeline)

Aggregates documents according to the specified aggregation pipeline. If the pipeline ends with a $out stage, the returned iterable will be a query of the collection that the aggregation was written to. Note that in this case the pipeline will be executed even if the iterable is never iterated.

Parameters:

pipeline - the aggregate pipeline

Returns:

an iterable containing the result of the aggregation operation

MongoDB documentation

Aggregation

aggregate

<TResult> AggregateIterable<TResult> aggregate(List<? extends Bson> pipeline,
                                               Class<TResult> resultClass)

Aggregates documents according to the specified aggregation pipeline. If the pipeline ends with a $out stage, the returned iterable will be a query of the collection that the aggregation was written to. Note that in this case the pipeline will be executed even if the iterable is never iterated.

Type Parameters:

TResult - the target document type of the iterable.

Parameters:

pipeline - the aggregate pipeline

resultClass - the class to decode each document into

Returns:

an iterable containing the result of the aggregation operation

MongoDB documentation

Aggregation

mapReduce

MapReduceIterable<TDocument> mapReduce(String mapFunction,
                                       String reduceFunction)

Aggregates documents according to the specified map-reduce function.

Parameters:

mapFunction - A JavaScript function that associates or "maps" a value with a key and emits the key and value pair.

reduceFunction - A JavaScript function that "reduces" to a single object all the values associated with a particular key.

Returns:

an iterable containing the result of the map-reduce operation

MongoDB documentation

map-reduce

mapReduce

<TResult> MapReduceIterable<TResult> mapReduce(String mapFunction,
                                               String reduceFunction,
                                               Class<TResult> resultClass)

Aggregates documents according to the specified map-reduce function.

Type Parameters:

TResult - the target document type of the iterable.

Parameters:

mapFunction - A JavaScript function that associates or "maps" a value with a key and emits the key and value pair.

reduceFunction - A JavaScript function that "reduces" to a single object all the values associated with a particular key.

resultClass - the class to decode each resulting document into.

Returns:

an iterable containing the result of the map-reduce operation

MongoDB documentation

map-reduce

bulkWrite

void bulkWrite(List<? extends WriteModel<? extends TDocument>> requests,
               SingleResultCallback<BulkWriteResult> callback)

Executes a mix of inserts, updates, replaces, and deletes.

Parameters:

requests - the writes to execute

callback - the callback passed the result of the bulk write

bulkWrite

void bulkWrite(List<? extends WriteModel<? extends TDocument>> requests,
               BulkWriteOptions options,
               SingleResultCallback<BulkWriteResult> callback)

Executes a mix of inserts, updates, replaces, and deletes.

Parameters:

requests - the writes to execute

options - the options to apply to the bulk write operation

callback - the callback passed the result of the bulk write

insertOne

void insertOne(TDocument document,
               SingleResultCallback<Void> callback)

Inserts the provided document. If the document is missing an identifier, the driver should generate one.

Parameters:

document - the document to insert

callback - the callback that is completed once the insert has completed

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoException - returned via the callback

insertOne

void insertOne(TDocument document,
               InsertOneOptions options,
               SingleResultCallback<Void> callback)

Inserts the provided document. If the document is missing an identifier, the driver should generate one.

Parameters:

document - the document to insert

options - the options to apply to the operation

callback - the callback that is completed once the insert has completed

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoCommandException - returned via the callback

MongoException - returned via the callback

Since:

3.2

insertMany

void insertMany(List<? extends TDocument> documents,
                SingleResultCallback<Void> callback)

Inserts one or more documents. A call to this method is equivalent to a call to the bulkWrite method

Parameters:

documents - the documents to insert

callback - the callback that is completed once the insert has completed

Throws:

MongoBulkWriteException - if there's an exception in the bulk write operation

MongoException - if the write failed due some other failure

See Also:

bulkWrite(java.util.List<? extends com.mongodb.client.model.WriteModel<? extends TDocument>>, com.mongodb.async.SingleResultCallback<com.mongodb.bulk.BulkWriteResult>)

insertMany

void insertMany(List<? extends TDocument> documents,
                InsertManyOptions options,
                SingleResultCallback<Void> callback)

Inserts one or more documents. A call to this method is equivalent to a call to the bulkWrite method

Parameters:

documents - the documents to insert

options - the options to apply to the operation

callback - the callback that is completed once the insert has completed

Throws:

MongoBulkWriteException - if there's an exception in the bulk write operation

MongoException - if the write failed due some other failure

See Also:

bulkWrite(java.util.List<? extends com.mongodb.client.model.WriteModel<? extends TDocument>>, com.mongodb.async.SingleResultCallback<com.mongodb.bulk.BulkWriteResult>)

deleteOne

void deleteOne(Bson filter,
               SingleResultCallback<DeleteResult> callback)

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

callback - the callback passed the result of the remove one operation

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoException - returned via the callback

deleteOne

void deleteOne(Bson filter,
               DeleteOptions options,
               SingleResultCallback<DeleteResult> callback)

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

options - the options to apply to the delete operation

callback - the callback passed the result of the remove one operation

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoException - returned via the callback

deleteMany

void deleteMany(Bson filter,
                SingleResultCallback<DeleteResult> callback)

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

callback - the callback passed the result of the remove many operation

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoException - returned via the callback

deleteMany

void deleteMany(Bson filter,
                DeleteOptions options,
                SingleResultCallback<DeleteResult> callback)

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

options - the options to apply to the delete operation

callback - the callback passed the result of the remove many operation

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoException - returned via the callback

replaceOne

void replaceOne(Bson filter,
                TDocument replacement,
                SingleResultCallback<UpdateResult> callback)

Replace a document in the collection according to the specified arguments.

Parameters:

filter - the query filter to apply the the replace operation

replacement - the replacement document

callback - the callback passed the result of the replace one operation

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoException - returned via the callback

MongoDB documentation

Replace

replaceOne

void replaceOne(Bson filter,
                TDocument replacement,
                UpdateOptions options,
                SingleResultCallback<UpdateResult> callback)

Replace a document in the collection according to the specified arguments.

Parameters:

filter - the query filter to apply the the replace operation

replacement - the replacement document

options - the options to apply to the replace operation

callback - the callback passed the result of the replace one operation

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoException - returned via the callback

MongoDB documentation

Replace

updateOne

void updateOne(Bson filter,
               Bson update,
               SingleResultCallback<UpdateResult> callback)

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.

callback - the callback passed the result of the update one operation

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoException - returned via the callback

MongoDB documentation

Updates

Update Operators

updateOne

void updateOne(Bson filter,
               Bson update,
               UpdateOptions options,
               SingleResultCallback<UpdateResult> callback)

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.

options - the options to apply to the update operation

callback - the callback passed the result of the update one operation

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoException - returned via the callback

MongoDB documentation

Updates

Update Operators

updateMany

void updateMany(Bson filter,
                Bson update,
                SingleResultCallback<UpdateResult> callback)

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. T

callback - the callback passed the result of the update many operation

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoException - returned via the callback

MongoDB documentation

Updates

Update Operators

updateMany

void updateMany(Bson filter,
                Bson update,
                UpdateOptions options,
                SingleResultCallback<UpdateResult> callback)

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.

options - the options to apply to the update operation

callback - the callback passed the result of the update many operation

Throws:

MongoWriteException - returned via the callback

MongoWriteConcernException - returned via the callback

MongoException - returned via the callback

MongoDB documentation

Updates

Update Operators

findOneAndDelete

void findOneAndDelete(Bson filter,
                      SingleResultCallback<TDocument> callback)

Atomically find a document and remove it.

Parameters:

filter - the query filter to find the document with

callback - the callback passed the document that was removed. If no documents matched the query filter, then null will be returned

findOneAndDelete

void findOneAndDelete(Bson filter,
                      FindOneAndDeleteOptions options,
                      SingleResultCallback<TDocument> callback)

Atomically find a document and remove it.

Parameters:

filter - the query filter to find the document with

options - the options to apply to the operation

callback - the callback passed the document that was removed. If no documents matched the query filter, then null will be returned

findOneAndReplace

void findOneAndReplace(Bson filter,
                       TDocument replacement,
                       SingleResultCallback<TDocument> callback)

Atomically find a document and replace it.

Parameters:

filter - the query filter to apply the the replace operation

replacement - the replacement document

callback - the callback passed the document that was replaced. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

findOneAndReplace

void findOneAndReplace(Bson filter,
                       TDocument replacement,
                       FindOneAndReplaceOptions options,
                       SingleResultCallback<TDocument> callback)

Atomically find a document and replace it.

Parameters:

filter - the query filter to apply the the replace operation

replacement - the replacement document

options - the options to apply to the operation

callback - the callback passed the document that was replaced. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

findOneAndUpdate

void findOneAndUpdate(Bson filter,
                      Bson update,
                      SingleResultCallback<TDocument> callback)

Atomically find a document and update it.

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.

callback - the callback passed the document that was updated before the update was applied. If no documents matched the query filter, then null will be returned

findOneAndUpdate

void findOneAndUpdate(Bson filter,
                      Bson update,
                      FindOneAndUpdateOptions options,
                      SingleResultCallback<TDocument> callback)

Atomically find a document and update it.

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.

options - the options to apply to the operation

callback - the callback passed the document that was updated. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

drop

void drop(SingleResultCallback<Void> callback)

Drops this collection from the Database.

Parameters:

callback - the callback that is completed once the collection has been dropped

MongoDB documentation

Drop Collection

createIndex

void createIndex(Bson key,
                 SingleResultCallback<String> callback)

Creates an index. If successful, the callback will be executed with the name of the created index as the result.

Parameters:

key - an object describing the index key(s), which may not be null.

callback - the callback that is completed once the index has been created

MongoDB documentation

Create indexes

createIndex

void createIndex(Bson key,
                 IndexOptions options,
                 SingleResultCallback<String> callback)

Creates an index. If successful, the callback will be executed with the name of the created index as the result.

Parameters:

key - an object describing the index key(s), which may not be null.

options - the options for the index

callback - the callback that is completed once the index has been created

MongoDB documentation

Create indexes

createIndexes

void createIndexes(List<IndexModel> indexes,
                   SingleResultCallback<List<String>> callback)

Create multiple indexes. If successful, the callback will be executed with a list of the namess of the created index as the result.

Parameters:

indexes - the list of indexes

callback - the callback that is completed once the indexes has been created

MongoDB documentation

Create indexes

Since server release

2.6

listIndexes

ListIndexesIterable<Document> listIndexes()

Get all the indexes in this collection.

Returns:

the list indexes iterable interface

MongoDB documentation

List indexes

listIndexes

<TResult> ListIndexesIterable<TResult> listIndexes(Class<TResult> resultClass)

Get all the indexes in this collection.

Type Parameters:

TResult - the target document type of the iterable.

Parameters:

resultClass - the class to decode each document into

Returns:

the list indexes iterable interface

MongoDB documentation

List indexes

dropIndex

void dropIndex(String indexName,
               SingleResultCallback<Void> callback)

Drops the index given its name.

Parameters:

indexName - the name of the index to remove

callback - the callback that is completed once the index has been dropped

MongoDB documentation

Drop indexes

dropIndex

void dropIndex(Bson keys,
               SingleResultCallback<Void> callback)

Drops the index given the keys used to create it.

Parameters:

keys - the keys of the index to remove

callback - the callback that is completed once the index has been dropped

MongoDB documentation

Drop indexes

dropIndexes

void dropIndexes(SingleResultCallback<Void> callback)

Drop all the indexes on this collection, except for the default on _id.

Parameters:

callback - the callback that is completed once all the indexes have been dropped

MongoDB documentation

Drop indexes

renameCollection

void renameCollection(MongoNamespace newCollectionNamespace,
                      SingleResultCallback<Void> callback)

Rename the collection with oldCollectionName to the newCollectionName.

Parameters:

newCollectionNamespace - the namespace the collection will be renamed to

callback - the callback that is completed once the collection has been renamed

Throws:

MongoServerException - if you provide a newCollectionName that is the name of an existing collection, or if the oldCollectionName is the name of a collection that doesn't exist

MongoDB documentation

Rename collection

renameCollection

void renameCollection(MongoNamespace newCollectionNamespace,
                      RenameCollectionOptions options,
                      SingleResultCallback<Void> callback)

Rename the collection with oldCollectionName to the newCollectionName.

Parameters:

newCollectionNamespace - the name the collection will be renamed to

options - the options for renaming a collection

callback - the callback that is completed once the collection has been renamed

Throws:

MongoServerException - if you provide a newCollectionName that is the name of an existing collection and dropTarget is false, or if the oldCollectionName is the name of a collection that doesn't exist

MongoDB documentation

Rename collection