MongoCollection (mongodb-async-driver 1.2.2 API)

All Known Implementing Classes:

AbstractMongoCollection, MongoCollectionImpl
```
public interface MongoCollection
```
Interface for interacting with a MongoDB collection.

API Notice:

This interface is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class MongoCollection.ValidateMode
ValidateMode provides an enumeration of the validation modes.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`MongoCollection.ValidateMode` ValidateMode provides an enumeration of the validation modes.

Field Summary

Fields
Modifier and Type Field and Description

static Document ALL
An (empty) query document to find all documents.

Fields
Modifier and Type	Field and Description
`static Document`	`ALL` An (empty) query document to find all documents.

Method Summary

Methods
Modifier and Type	Method and Description
`List<Document>`	`aggregate(Aggregate.Builder command)` Invokes a aggregate command on the server.
`List<Document>`	`aggregate(Aggregate command)` Invokes a aggregate command on the server.
`Future<List<Document>>`	`aggregateAsync(Aggregate.Builder command)` Invokes a aggregate command on the server.
`Future<List<Document>>`	`aggregateAsync(Aggregate command)` Invokes a aggregate command on the server.
`void`	`aggregateAsync(Callback<List<Document>> results, Aggregate.Builder command)` Invokes a aggregate command on the server.
`void`	`aggregateAsync(Callback<List<Document>> results, Aggregate command)` Invokes a aggregate command on the server.
`long`	`count()` Counts the set of documents in the collection.
`long`	`count(DocumentAssignable query)` Counts the set of documents matching the query document in the collection.
`long`	`count(DocumentAssignable query, ReadPreference readPreference)` Counts the set of documents matching the query document in the collection.
`long`	`count(ReadPreference readPreference)` Counts the set of documents in the collection.
`Future<Long>`	`countAsync()` Counts the set of documents in the collection.
`void`	`countAsync(Callback<Long> results)` Counts the set of documents in the collection.
`void`	`countAsync(Callback<Long> results, DocumentAssignable query)` Counts the set of documents matching the query document in the collection.
`void`	`countAsync(Callback<Long> results, DocumentAssignable query, ReadPreference readPreference)` Counts the set of documents matching the query document in the collection.
`void`	`countAsync(Callback<Long> results, ReadPreference readPreference)` Counts the set of documents in the collection.
`Future<Long>`	`countAsync(DocumentAssignable query)` Counts the set of documents matching the query document in the collection.
`Future<Long>`	`countAsync(DocumentAssignable query, ReadPreference readPreference)` Counts the set of documents matching the query document in the collection.
`Future<Long>`	`countAsync(ReadPreference readPreference)` Counts the set of documents in the collection.
`void`	`createIndex(boolean unique, Element... keys)` Creates an index with a generated name, across the keys specified and if `unique` is true ensuring entries are unique.
`void`	`createIndex(DocumentAssignable options, Element... keys)` Creates an index with a generated name, across the keys specified allowing duplicate entries.
`void`	`createIndex(Element... keys)` Creates an index with a generated name, across the keys specified allowing duplicate entries.
`void`	`createIndex(String name, boolean unique, Element... keys)` Creates an index with the specified name, across the keys specified and if `unique` is true ensuring entries are unique.
`void`	`createIndex(String name, DocumentAssignable options, Element... keys)` Creates an index with a generated name, across the keys specified allowing duplicate entries.
`long`	`delete(DocumentAssignable query)` Deletes a set of documents matching a query from the collection.
`long`	`delete(DocumentAssignable query, boolean singleDelete)` Deletes a set of documents matching a query from the collection.
`long`	`delete(DocumentAssignable query, boolean singleDelete, Durability durability)` Deletes a set of documents matching a query from the collection.
`long`	`delete(DocumentAssignable query, Durability durability)` Deletes a set of documents matching a query from the collection.
`void`	`deleteAsync(Callback<Long> results, DocumentAssignable query)` Deletes a set of documents matching a query from the collection.
`void`	`deleteAsync(Callback<Long> results, DocumentAssignable query, boolean singleDelete)` Deletes a set of documents matching a query from the collection.
`void`	`deleteAsync(Callback<Long> results, DocumentAssignable query, boolean singleDelete, Durability durability)` Deletes a set of documents matching a query from the collection.
`void`	`deleteAsync(Callback<Long> results, DocumentAssignable query, Durability durability)` Deletes a set of documents matching a query from the collection.
`Future<Long>`	`deleteAsync(DocumentAssignable query)` Deletes a set of documents matching a query from the collection.
`Future<Long>`	`deleteAsync(DocumentAssignable query, boolean singleDelete)` Deletes a set of documents matching a query from the collection.
`Future<Long>`	`deleteAsync(DocumentAssignable query, boolean singleDelete, Durability durability)` Deletes a set of documents matching a query from the collection.
`Future<Long>`	`deleteAsync(DocumentAssignable query, Durability durability)` Deletes a set of documents matching a query from the collection.
`ArrayElement`	`distinct(Distinct.Builder command)` Invokes a distinct command on the server.
`ArrayElement`	`distinct(Distinct command)` Invokes a distinct command on the server.
`void`	`distinctAsync(Callback<ArrayElement> results, Distinct.Builder command)` Invokes a distinct command on the server.
`void`	`distinctAsync(Callback<ArrayElement> results, Distinct command)` Invokes a distinct command on the server.
`Future<ArrayElement>`	`distinctAsync(Distinct.Builder command)` Invokes a distinct command on the server.
`Future<ArrayElement>`	`distinctAsync(Distinct command)` Invokes a distinct command on the server.
`boolean`	`drop()` Drops the collection from the database.
`boolean`	`dropIndex(IntegerElement... keys)` Deletes the indexes matching the keys specified.
`boolean`	`dropIndex(String name)` Deletes the indexes with the provided name.
`Document`	`explain(DocumentAssignable query)` Explains the way that the document will be performed.
`Document`	`explain(Find.Builder query)` Explains the way that the document will be performed.
`Document`	`explain(Find query)` Explains the way that the document will be performed.
`void`	`explainAsync(Callback<Document> results, Find.Builder query)` Explains the way that the document will be performed.
`void`	`explainAsync(Callback<Document> results, Find query)` Explains the way that the document will be performed.
`Future<Document>`	`explainAsync(Find.Builder query)` Explains the way that the document will be performed.
`Future<Document>`	`explainAsync(Find query)` Explains the way that the document will be performed.
`MongoIterator<Document>`	`find(DocumentAssignable query)` Finds the set of documents matching the query document in the collection.
`MongoIterator<Document>`	`find(Find.Builder query)` Finds the set of documents matching the query in the collection.
`MongoIterator<Document>`	`find(Find query)` Finds the set of documents matching the query in the collection.
`Document`	`findAndModify(FindAndModify.Builder command)` Invokes a findAndModify command on the server.
`Document`	`findAndModify(FindAndModify command)` Invokes a findAndModify command on the server.
`void`	`findAndModifyAsync(Callback<Document> results, FindAndModify.Builder command)` Invokes a findAndModify command on the server.
`void`	`findAndModifyAsync(Callback<Document> results, FindAndModify command)` Invokes a findAndModify command on the server.
`Future<Document>`	`findAndModifyAsync(FindAndModify.Builder command)` Invokes a findAndModify command on the server.
`Future<Document>`	`findAndModifyAsync(FindAndModify command)` Invokes a findAndModify command on the server.
`void`	`findAsync(Callback<MongoIterator<Document>> results, DocumentAssignable query)` Finds the set of documents matching the query document in the collection.
`void`	`findAsync(Callback<MongoIterator<Document>> results, Find.Builder query)` Finds the set of documents matching the query in the collection.
`void`	`findAsync(Callback<MongoIterator<Document>> results, Find query)` Finds the set of documents matching the query in the collection.
`Future<MongoIterator<Document>>`	`findAsync(DocumentAssignable query)` Finds the set of documents matching the query document in the collection.
`Future<MongoIterator<Document>>`	`findAsync(Find.Builder query)` Finds the set of documents matching the query in the collection.
`Future<MongoIterator<Document>>`	`findAsync(Find query)` Finds the set of documents matching the query in the collection.
`Document`	`findOne(DocumentAssignable query)` Finds a single matching document in the collection.
`Document`	`findOne(Find.Builder query)` Finds a single matching document in the collection.
`Document`	`findOne(Find query)` Finds a single matching document in the collection.
`void`	`findOneAsync(Callback<Document> results, DocumentAssignable query)` Finds a single matching document in the collection.
`void`	`findOneAsync(Callback<Document> results, Find.Builder query)` Finds a single matching document in the collection.
`void`	`findOneAsync(Callback<Document> results, Find query)` Finds a single matching document in the collection.
`Future<Document>`	`findOneAsync(DocumentAssignable query)` Finds a single matching document in the collection.
`Future<Document>`	`findOneAsync(Find.Builder query)` Finds a single matching document in the collection.
`Future<Document>`	`findOneAsync(Find query)` Finds a single matching document in the collection.
`String`	`getDatabaseName()` Returns the name of the database.
`Durability`	`getDurability()` Returns the durability for write operations sent to the server from this `MongoCollection` instance.
`String`	`getName()` Returns the name of the collection.
`ReadPreference`	`getReadPreference()` Returns the read preference for queries from this `MongoCollection` instance.
`ArrayElement`	`groupBy(GroupBy.Builder command)` Invokes a group command on the server.
`ArrayElement`	`groupBy(GroupBy command)` Invokes a group command on the server.
`void`	`groupByAsync(Callback<ArrayElement> results, GroupBy.Builder command)` Invokes a group command on the server.
`void`	`groupByAsync(Callback<ArrayElement> results, GroupBy command)` Invokes a group command on the server.
`Future<ArrayElement>`	`groupByAsync(GroupBy.Builder command)` Invokes a group command on the server.
`Future<ArrayElement>`	`groupByAsync(GroupBy command)` Invokes a group command on the server.
`int`	`insert(boolean continueOnError, DocumentAssignable... documents)` Inserts a set of documents into the collection.
`int`	`insert(boolean continueOnError, Durability durability, DocumentAssignable... documents)` Inserts a set of documents into the collection.
`int`	`insert(DocumentAssignable... documents)` Inserts a set of documents into the collection.
`int`	`insert(Durability durability, DocumentAssignable... documents)` Inserts a set of documents into the collection.
`Future<Integer>`	`insertAsync(boolean continueOnError, DocumentAssignable... documents)` Inserts a set of documents into the collection.
`Future<Integer>`	`insertAsync(boolean continueOnError, Durability durability, DocumentAssignable... documents)` Inserts a set of documents into the collection.
`void`	`insertAsync(Callback<Integer> results, boolean continueOnError, DocumentAssignable... documents)` Inserts a set of documents into the collection.
`void`	`insertAsync(Callback<Integer> results, boolean continueOnError, Durability durability, DocumentAssignable... documents)` Inserts a set of documents into the collection.
`void`	`insertAsync(Callback<Integer> results, DocumentAssignable... documents)` Inserts a set of documents into the collection.
`void`	`insertAsync(Callback<Integer> results, Durability durability, DocumentAssignable... documents)` Inserts a set of documents into the collection.
`Future<Integer>`	`insertAsync(DocumentAssignable... documents)` Inserts a set of documents into the collection.
`Future<Integer>`	`insertAsync(Durability durability, DocumentAssignable... documents)` Inserts a set of documents into the collection.
`boolean`	`isCapped()` Returns true if the collection `statistics` indicate that the collection is a capped collection.
`List<Document>`	`mapReduce(MapReduce.Builder command)` Invokes a mapReduce command on the server.
`List<Document>`	`mapReduce(MapReduce command)` Invokes a mapReduce command on the server.
`void`	`mapReduceAsync(Callback<List<Document>> results, MapReduce.Builder command)` Invokes a mapReduce command on the server.
`void`	`mapReduceAsync(Callback<List<Document>> results, MapReduce command)` Invokes a mapReduce command on the server.
`Future<List<Document>>`	`mapReduceAsync(MapReduce.Builder command)` Invokes a mapReduce command on the server.
`Future<List<Document>>`	`mapReduceAsync(MapReduce command)` Invokes a mapReduce command on the server.
`int`	`save(DocumentAssignable document)` Saves the `document` to the collection.
`int`	`save(DocumentAssignable document, Durability durability)` Saves the `document` to the collection.
`void`	`saveAsync(Callback<Integer> results, DocumentAssignable document)` Saves the `document` to the collection.
`void`	`saveAsync(Callback<Integer> results, DocumentAssignable document, Durability durability)` Saves the `document` to the collection.
`Future<Integer>`	`saveAsync(DocumentAssignable document)` Saves the `document` to the collection.
`Future<Integer>`	`saveAsync(DocumentAssignable document, Durability durability)` Saves the `document` to the collection.
`void`	`setDurability(Durability durability)` Sets the durability for write operations from this `MongoCollection` instance.
`void`	`setReadPreference(ReadPreference readPreference)` Sets the value of the read preference for a queries from this `MongoCollection` instance.
`Document`	`stats()` Returns the statistics for the collection.
`MongoCursorControl`	`streamingFind(Callback<Document> results, DocumentAssignable query)` Deprecated. Use the `streamingFind(StreamCallback, DocumentAssignable)` method instead. This method will be removed after the 1.3.0 release.
`MongoCursorControl`	`streamingFind(Callback<Document> results, Find query)` Deprecated. Use the `streamingFind(StreamCallback, Find)` method instead. This method will be removed after the 1.3.0 release.
`MongoCursorControl`	`streamingFind(StreamCallback<Document> results, DocumentAssignable query)` Finds the set of documents matching the query document in the collection and streams them to the provided callback one at a time.
`MongoCursorControl`	`streamingFind(StreamCallback<Document> results, Find.Builder query)` Finds the set of documents matching the query in the collection and streams them to the provided callback one at a time.
`MongoCursorControl`	`streamingFind(StreamCallback<Document> results, Find query)` Finds the set of documents matching the query in the collection and streams them to the provided callback one at a time.
`List<TextResult>`	`textSearch(Text.Builder command)` Invokes a `text` command on the server.
`List<TextResult>`	`textSearch(Text command)` Invokes a `text` command on the server.
`void`	`textSearchAsync(Callback<List<TextResult>> results, Text.Builder command)` Invokes a `text` command on the server.
`void`	`textSearchAsync(Callback<List<TextResult>> results, Text command)` Invokes a `text` command on the server.
`Future<List<TextResult>>`	`textSearchAsync(Text.Builder command)` Invokes a `text` command on the server.
`Future<List<TextResult>>`	`textSearchAsync(Text command)` Invokes a `text` command on the server.
`long`	`update(DocumentAssignable query, DocumentAssignable update)` Applies updates to a set of documents within the collection.
`long`	`update(DocumentAssignable query, DocumentAssignable update, boolean multiUpdate, boolean upsert)` Applies updates to a set of documents within the collection.
`long`	`update(DocumentAssignable query, DocumentAssignable update, boolean multiUpdate, boolean upsert, Durability durability)` Applies updates to a set of documents within the collection.
`long`	`update(DocumentAssignable query, DocumentAssignable update, Durability durability)` Applies updates to a set of documents within the collection.
`void`	`updateAsync(Callback<Long> results, DocumentAssignable query, DocumentAssignable update)` Applies updates to a set of documents within the collection.
`void`	`updateAsync(Callback<Long> results, DocumentAssignable query, DocumentAssignable update, boolean multiUpdate, boolean upsert)` Applies updates to a set of documents within the collection.
`void`	`updateAsync(Callback<Long> results, DocumentAssignable query, DocumentAssignable update, boolean multiUpdate, boolean upsert, Durability durability)` Applies updates to a set of documents within the collection.
`void`	`updateAsync(Callback<Long> results, DocumentAssignable query, DocumentAssignable update, Durability durability)` Applies updates to a set of documents within the collection.
`Future<Long>`	`updateAsync(DocumentAssignable query, DocumentAssignable update)` Applies updates to a set of documents within the collection.
`Future<Long>`	`updateAsync(DocumentAssignable query, DocumentAssignable update, boolean multiUpdate, boolean upsert)` Applies updates to a set of documents within the collection.
`Future<Long>`	`updateAsync(DocumentAssignable query, DocumentAssignable update, boolean multiUpdate, boolean upsert, Durability durability)` Applies updates to a set of documents within the collection.
`Future<Long>`	`updateAsync(DocumentAssignable query, DocumentAssignable update, Durability durability)` Applies updates to a set of documents within the collection.
`Document`	`updateOptions(DocumentAssignable options)` Updates the collection's options or flags using the `collMod` command.
`Document`	`validate(MongoCollection.ValidateMode mode)` Validates the collections contents.

- Field Detail
  - ALL
```
static final Document ALL
```
    An (empty) query document to find all documents.
- Method Detail
  - aggregate
```
List<Document> aggregate(Aggregate command)
                         throws MongoDbException
```
    Invokes a aggregate command on the server.
    
    Parameters:
    command - The details of the aggregation request.
    
    Returns:
    The aggregation results returned.
    
    Throws:
    
    MongoDbException - On an error executing the aggregate command.
  - aggregate
```
List<Document> aggregate(Aggregate.Builder command)
                         throws MongoDbException
```
    Invokes a aggregate command on the server.
    
    Parameters:
    command - The details of the aggregation request.
    
    Returns:
    The aggregation results returned.
    
    Throws:
    
    MongoDbException - On an error executing the aggregate command.
  - aggregateAsync
```
Future<List<Document>> aggregateAsync(Aggregate command)
                                      throws MongoDbException
```
    Invokes a aggregate command on the server.
    
    Parameters:
    command - The details of the aggregation request.
    
    Returns:
    Future for the aggregation results returned.
    
    Throws:
    
    MongoDbException - On an error executing the aggregate command.
  - aggregateAsync
```
Future<List<Document>> aggregateAsync(Aggregate.Builder command)
                                      throws MongoDbException
```
    Invokes a aggregate command on the server.
    
    Parameters:
    command - The details of the aggregation request.
    
    Returns:
    Future for the aggregation results returned.
    
    Throws:
    
    MongoDbException - On an error executing the aggregate command.
  - aggregateAsync
```
void aggregateAsync(Callback<List<Document>> results,
                  Aggregate command)
                    throws MongoDbException
```
    Invokes a aggregate command on the server.
    
    Parameters:
    results - Callback for the aggregation results returned.
    command - The details of the aggregation request.
    
    Throws:
    
    MongoDbException - On an error executing the aggregate command.
  - aggregateAsync
```
void aggregateAsync(Callback<List<Document>> results,
                  Aggregate.Builder command)
                    throws MongoDbException
```
    Invokes a aggregate command on the server.
    
    Parameters:
    results - Callback for the aggregation results returned.
    command - The details of the aggregation request.
    
    Throws:
    
    MongoDbException - On an error executing the aggregate command.
  - count
```
long count()
           throws MongoDbException
```
    Counts the set of documents in the collection.
    This is equivalent to calling countAsync().get()
    
    Returns:
    The number of documents in the collection.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - count
```
long count(DocumentAssignable query)
           throws MongoDbException
```
    Counts the set of documents matching the query document in the collection.
    This is equivalent to calling countAsync(...).get()
    
    Parameters:
    query - The query document.
    
    Returns:
    The number of matching documents.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - count
```
long count(DocumentAssignable query,
         ReadPreference readPreference)
           throws MongoDbException
```
    Counts the set of documents matching the query document in the collection.
    
    Parameters:
    query - The query document.
    readPreference - The preference for which servers to use to retrieve the results.
    
    Returns:
    The number of matching documents.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - count
```
long count(ReadPreference readPreference)
           throws MongoDbException
```
    Counts the set of documents in the collection.
    This is equivalent to calling countAsync().get()
    
    Parameters:
    readPreference - The preference for which servers to use to retrieve the results.
    
    Returns:
    The number of documents in the collection.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - countAsync
```
Future<Long> countAsync()
                        throws MongoDbException
```
    Counts the set of documents in the collection.
    This is equivalent to calling countAsync().get()
    
    Returns:
    The number of documents in the collection.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - countAsync
```
void countAsync(Callback<Long> results)
                throws MongoDbException
```
    Counts the set of documents in the collection.
    This is equivalent to calling countAsync(results, BuilderFactory.start())
    
    Parameters:
    results - The callback to notify of the results.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - countAsync
```
void countAsync(Callback<Long> results,
              DocumentAssignable query)
                throws MongoDbException
```
    Counts the set of documents matching the query document in the collection.
    
    Parameters:
    results - The callback to notify of the results.
    query - The query document.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - countAsync
```
void countAsync(Callback<Long> results,
              DocumentAssignable query,
              ReadPreference readPreference)
                throws MongoDbException
```
    Counts the set of documents matching the query document in the collection.
    
    Parameters:
    results - The callback to notify of the results.
    query - The query document.
    readPreference - The preference for which servers to use to retrieve the results.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - countAsync
```
void countAsync(Callback<Long> results,
              ReadPreference readPreference)
                throws MongoDbException
```
    Counts the set of documents in the collection.
    This is equivalent to calling countAsync(results, BuilderFactory.start(), readPreference)
    
    Parameters:
    results - The callback to notify of the results.
    readPreference - The preference for which servers to use to retrieve the results.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - countAsync
```
Future<Long> countAsync(DocumentAssignable query)
                        throws MongoDbException
```
    Counts the set of documents matching the query document in the collection.
    
    Parameters:
    query - The query document.
    
    Returns:
    A future that will be updated with the number of matching documents.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - countAsync
```
Future<Long> countAsync(DocumentAssignable query,
                      ReadPreference readPreference)
                        throws MongoDbException
```
    Counts the set of documents matching the query document in the collection.
    
    Parameters:
    query - The query document.
    readPreference - The preference for which servers to use to retrieve the results.
    
    Returns:
    A future that will be updated with the number of matching documents.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - countAsync
```
Future<Long> countAsync(ReadPreference readPreference)
                        throws MongoDbException
```
    Counts the set of documents in the collection.
    This is equivalent to calling countAsync().get()
    
    Parameters:
    readPreference - The preference for which servers to use to retrieve the results.
    
    Returns:
    The number of documents in the collection.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - createIndex
```
void createIndex(boolean unique,
               Element... keys)
                 throws MongoDbException
```
    Creates an index with a generated name, across the keys specified and if unique is true ensuring entries are unique.
    This method is intended to be used with the Index class's static methods:
    import static com.allanbank.mongodb.builder.Index.asc; import static com.allanbank.mongodb.builder.Index.desc; MongoCollection collection = ...; collection.createIndex( true, asc("f"), desc("g") ); ...
    Parameters:
    unique - If true then the index created will enforce entries are unique.
    keys - The keys to use for the index.
    
    Throws:
    
    MongoDbException - On a failure building the index.
  - createIndex
```
void createIndex(DocumentAssignable options,
               Element... keys)
                 throws MongoDbException
```
    Creates an index with a generated name, across the keys specified allowing duplicate entries.
    This method is intended to be used with the Index class's static methods:
    import static com.allanbank.mongodb.bson.builder.BuilderFactory.start; import static com.allanbank.mongodb.builder.Index.asc; import static com.allanbank.mongodb.builder.Index.desc; MongoCollection collection = ...; collection.createIndex(start().add("sparse", true), asc("f") ); ...
    Parameters:
    options - The options for the index.
    keys - The keys to use for the index.
    
    Throws:
    
    MongoDbException - On a failure building the index.
    See Also:
    Index Options Documentation
  - createIndex
```
void createIndex(Element... keys)
                 throws MongoDbException
```
    Creates an index with a generated name, across the keys specified allowing duplicate entries.
    This method is intended to be used with the Index class's static methods:
    import static com.allanbank.mongodb.builder.Index.asc; import static com.allanbank.mongodb.builder.Index.desc; MongoCollection collection = ...; collection.createIndex( asc("f"), desc("g") ); ...
    Parameters:
    keys - The keys to use for the index.
    
    Throws:
    
    MongoDbException - On a failure building the index.
  - createIndex
```
void createIndex(String name,
               boolean unique,
               Element... keys)
                 throws MongoDbException
```
    Creates an index with the specified name, across the keys specified and if unique is true ensuring entries are unique.
    This method is intended to be used with the Index class's static methods:
    import static com.allanbank.mongodb.builder.Index.asc; import static com.allanbank.mongodb.builder.Index.desc; MongoCollection collection = ...; collection.createIndex( "f_and_g", false, asc("f"), desc("g") ); ...
    Parameters:
    name - The name of the index. If null then a name is generated based on the keys.
    keys - The keys to use for the index.
    unique - If true then the index created will enforce entries are unique.
    
    Throws:
    
    MongoDbException - On a failure building the index.
  - createIndex
```
void createIndex(String name,
               DocumentAssignable options,
               Element... keys)
                 throws MongoDbException
```
    Creates an index with a generated name, across the keys specified allowing duplicate entries.
    This method is intended to be used with the Index class's static methods:
    import static com.allanbank.mongodb.bson.builder.BuilderFactory.start; import static com.allanbank.mongodb.builder.Index.asc; import static com.allanbank.mongodb.builder.Index.desc; MongoCollection collection = ...; collection.createIndex("sparse_f", start().add("sparse", true), asc("f") ); ...
    Parameters:
    name - The name of the index. If null then a name is generated based on the keys.
    options - The options for the index.
    keys - The keys to use for the index.
    
    Throws:
    
    MongoDbException - On a failure building the index.
    See Also:
    Index Options Documentation
  - delete
```
long delete(DocumentAssignable query)
            throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    query - Query to locate the documents to be deleted.
    
    Returns:
    The results of the delete. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - delete
```
long delete(DocumentAssignable query,
          boolean singleDelete)
            throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    query - Query to locate the documents to be deleted.
    singleDelete - If true then only a single document will be deleted. If running in a sharded environment then this field must be false or the query must contain the shard key.
    
    Returns:
    The results of the delete. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - delete
```
long delete(DocumentAssignable query,
          boolean singleDelete,
          Durability durability)
            throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    query - Query to locate the documents to be deleted.
    singleDelete - If true then only a single document will be deleted. If running in a sharded environment then this field must be false or the query must contain the shard key.
    durability - The durability for the delete.
    
    Returns:
    The results of the delete. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - delete
```
long delete(DocumentAssignable query,
          Durability durability)
            throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    query - Query to locate the documents to be deleted.
    durability - The durability for the delete.
    
    Returns:
    The results of the delete. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - deleteAsync
```
void deleteAsync(Callback<Long> results,
               DocumentAssignable query)
                 throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    results - Callback that will be notified of the results of the query. If the durability of the operation is NONE then this will be -1.
    query - Query to locate the documents to be deleted.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - deleteAsync
```
void deleteAsync(Callback<Long> results,
               DocumentAssignable query,
               boolean singleDelete)
                 throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    results - Callback that will be notified of the results of the query. If the durability of the operation is NONE then this will be -1.
    query - Query to locate the documents to be deleted.
    singleDelete - If true then only a single document will be deleted. If running in a sharded environment then this field must be false or the query must contain the shard key.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - deleteAsync
```
void deleteAsync(Callback<Long> results,
               DocumentAssignable query,
               boolean singleDelete,
               Durability durability)
                 throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    results - Callback that will be notified of the results of the query. If the durability of the operation is NONE then this will be -1.
    query - Query to locate the documents to be deleted.
    singleDelete - If true then only a single document will be deleted. If running in a sharded environment then this field must be false or the query must contain the shard key.
    durability - The durability for the delete.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - deleteAsync
```
void deleteAsync(Callback<Long> results,
               DocumentAssignable query,
               Durability durability)
                 throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    results - Callback that will be notified of the results of the query. If the durability of the operation is NONE then this will be -1.
    query - Query to locate the documents to be deleted.
    durability - The durability for the delete.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - deleteAsync
```
Future<Long> deleteAsync(DocumentAssignable query)
                         throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    query - Query to locate the documents to be deleted.
    
    Returns:
    Future that will be updated with the results of the delete. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - deleteAsync
```
Future<Long> deleteAsync(DocumentAssignable query,
                       boolean singleDelete)
                         throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    query - Query to locate the documents to be deleted.
    singleDelete - If true then only a single document will be deleted. If running in a sharded environment then this field must be false or the query must contain the shard key.
    
    Returns:
    Future that will be updated with the results of the delete. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - deleteAsync
```
Future<Long> deleteAsync(DocumentAssignable query,
                       boolean singleDelete,
                       Durability durability)
                         throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    query - Query to locate the documents to be deleted.
    singleDelete - If true then only a single document will be deleted. If running in a sharded environment then this field must be false or the query must contain the shard key.
    durability - The durability for the delete.
    
    Returns:
    Future that will be updated with the results of the delete. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - deleteAsync
```
Future<Long> deleteAsync(DocumentAssignable query,
                       Durability durability)
                         throws MongoDbException
```
    Deletes a set of documents matching a query from the collection.
    
    Parameters:
    query - Query to locate the documents to be deleted.
    durability - The durability for the delete.
    
    Returns:
    Future that will be updated with the results of the delete. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error deleting the documents.
  - distinct
```
ArrayElement distinct(Distinct command)
                      throws MongoDbException
```
    Invokes a distinct command on the server.
    
    Parameters:
    command - The details of the distinct request.
    
    Returns:
    The distinct results returned.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - distinct
```
ArrayElement distinct(Distinct.Builder command)
                      throws MongoDbException
```
    Invokes a distinct command on the server.
    
    Parameters:
    command - The details of the distinct request.
    
    Returns:
    The distinct results returned.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - distinctAsync
```
void distinctAsync(Callback<ArrayElement> results,
                 Distinct command)
                   throws MongoDbException
```
    Invokes a distinct command on the server.
    
    Parameters:
    results - Callback for the distinct results returned.
    command - The details of the distinct request.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - distinctAsync
```
void distinctAsync(Callback<ArrayElement> results,
                 Distinct.Builder command)
                   throws MongoDbException
```
    Invokes a distinct command on the server.
    
    Parameters:
    results - Callback for the distinct results returned.
    command - The details of the distinct request.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - distinctAsync
```
Future<ArrayElement> distinctAsync(Distinct command)
                                   throws MongoDbException
```
    Invokes a distinct command on the server.
    
    Parameters:
    command - The details of the distinct request.
    
    Returns:
    Future for the distinct results returned.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - distinctAsync
```
Future<ArrayElement> distinctAsync(Distinct.Builder command)
                                   throws MongoDbException
```
    Invokes a distinct command on the server.
    
    Parameters:
    command - The details of the distinct request.
    
    Returns:
    Future for the distinct results returned.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - drop
```
boolean drop()
             throws MongoDbException
```
    Drops the collection from the database.
    
    Returns:
    True if the collection was successfully dropped.
    
    Throws:
    
    MongoDbException - On an error dropping the collection.
  - dropIndex
```
boolean dropIndex(IntegerElement... keys)
                  throws MongoDbException
```
    Deletes the indexes matching the keys specified.
    This method is intended to be used with the Index class's static methods:
    import static com.allanbank.mongodb.builder.Index.asc; import static com.allanbank.mongodb.builder.Index.desc; MongoCollection collection = ...; collection.dropIndex( asc("f"), desc("g") ); ...
    Parameters:
    keys - The keys for the index to be dropped.
    
    Returns:
    If any indexes were removed.
    
    Throws:
    
    MongoDbException - On an error deleting the indexes.
  - dropIndex
```
boolean dropIndex(String name)
                  throws MongoDbException
```
    Deletes the indexes with the provided name.
    
    Parameters:
    name - The name of the index.
    
    Returns:
    If any indexes were removed.
    
    Throws:
    
    MongoDbException - On an error deleting the indexes.
  - explain
```
Document explain(DocumentAssignable query)
                 throws MongoDbException
```
    Explains the way that the document will be performed.
    
    Parameters:
    query - The query document.
    
    Returns:
    The document describing the method used to execute the query.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - explain
```
Document explain(Find query)
                 throws MongoDbException
```
    Explains the way that the document will be performed.
    This is equivalent to calling explainAsync(...).get()
    
    Parameters:
    query - The query details.
    
    Returns:
    The document describing the method used to execute the query.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - explain
```
Document explain(Find.Builder query)
                 throws MongoDbException
```
    Explains the way that the document will be performed.
    This is equivalent to calling explainAsync(...).get()
    
    Parameters:
    query - The query details.
    
    Returns:
    The document describing the method used to execute the query.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - explainAsync
```
void explainAsync(Callback<Document> results,
                Find query)
                  throws MongoDbException
```
    Explains the way that the document will be performed.
    
    Parameters:
    query - The query details.
    results - Callback that will be notified of the results of the explain.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - explainAsync
```
void explainAsync(Callback<Document> results,
                Find.Builder query)
                  throws MongoDbException
```
    Explains the way that the document will be performed.
    
    Parameters:
    query - The query details.
    results - Callback that will be notified of the results of the explain.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - explainAsync
```
Future<Document> explainAsync(Find query)
                              throws MongoDbException
```
    Explains the way that the document will be performed.
    
    Parameters:
    query - The query details.
    
    Returns:
    The document describing the method used to execute the query.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - explainAsync
```
Future<Document> explainAsync(Find.Builder query)
                              throws MongoDbException
```
    Explains the way that the document will be performed.
    
    Parameters:
    query - The query details.
    
    Returns:
    The document describing the method used to execute the query.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - find
```
MongoIterator<Document> find(DocumentAssignable query)
                             throws MongoDbException
```
    Finds the set of documents matching the query document in the collection.
    This is equivalent to calling findAsync(...).get()
    
    Parameters:
    query - The query document.
    
    Returns:
    The MongoIterator over the documents.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - find
```
MongoIterator<Document> find(Find query)
                             throws MongoDbException
```
    Finds the set of documents matching the query in the collection.
    This is equivalent to calling findAsync(...).get()
    
    Parameters:
    query - The query details.
    
    Returns:
    The MongoIterator over the documents.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - find
```
MongoIterator<Document> find(Find.Builder query)
                             throws MongoDbException
```
    Finds the set of documents matching the query in the collection.
    This is equivalent to calling findAsync(...).get()
    
    Parameters:
    query - The query details.
    
    Returns:
    The MongoIterator over the documents.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAndModify
```
Document findAndModify(FindAndModify command)
                       throws MongoDbException
```
    Invokes a findAndModify command on the server. The query is used to locate a document to apply a set of updates to.
    
    Parameters:
    command - The details of the find and modify request.
    
    Returns:
    The found document.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAndModify
```
Document findAndModify(FindAndModify.Builder command)
                       throws MongoDbException
```
    Invokes a findAndModify command on the server. The query is used to locate a document to apply a set of updates to.
    
    Parameters:
    command - The details of the find and modify request.
    
    Returns:
    The found document.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAndModifyAsync
```
void findAndModifyAsync(Callback<Document> results,
                      FindAndModify command)
                        throws MongoDbException
```
    Invokes a findAndModify command on the server. The query is used to locate a document to apply a set of updates to.
    
    Parameters:
    results - Callback for the the found document.
    command - The details of the find and modify request.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAndModifyAsync
```
void findAndModifyAsync(Callback<Document> results,
                      FindAndModify.Builder command)
                        throws MongoDbException
```
    Invokes a findAndModify command on the server. The query is used to locate a document to apply a set of updates to.
    
    Parameters:
    results - Callback for the the found document.
    command - The details of the find and modify request.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAndModifyAsync
```
Future<Document> findAndModifyAsync(FindAndModify command)
                                    throws MongoDbException
```
    Invokes a findAndModify command on the server. The query is used to locate a document to apply a set of updates to.
    
    Parameters:
    command - The details of the find and modify request.
    
    Returns:
    Future for the found document.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAndModifyAsync
```
Future<Document> findAndModifyAsync(FindAndModify.Builder command)
                                    throws MongoDbException
```
    Invokes a findAndModify command on the server. The query is used to locate a document to apply a set of updates to.
    
    Parameters:
    command - The details of the find and modify request.
    
    Returns:
    Future for the found document.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAsync
```
void findAsync(Callback<MongoIterator<Document>> results,
             DocumentAssignable query)
               throws MongoDbException
```
    Finds the set of documents matching the query document in the collection.
    
    Parameters:
    results - Callback that will be notified of the results of the query.
    query - The query document.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAsync
```
void findAsync(Callback<MongoIterator<Document>> results,
             Find query)
               throws MongoDbException
```
    Finds the set of documents matching the query in the collection.
    
    Parameters:
    results - Callback that will be notified of the results of the query.
    query - The query details.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAsync
```
void findAsync(Callback<MongoIterator<Document>> results,
             Find.Builder query)
               throws MongoDbException
```
    Finds the set of documents matching the query in the collection.
    
    Parameters:
    results - Callback that will be notified of the results of the query.
    query - The query details.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAsync
```
Future<MongoIterator<Document>> findAsync(DocumentAssignable query)
                                          throws MongoDbException
```
    Finds the set of documents matching the query document in the collection.
    
    Parameters:
    query - The query document.
    
    Returns:
    A future for the MongoIterator over the documents.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAsync
```
Future<MongoIterator<Document>> findAsync(Find query)
                                          throws MongoDbException
```
    Finds the set of documents matching the query in the collection.
    
    Parameters:
    query - The query details.
    
    Returns:
    A future for the MongoIterator over the documents.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findAsync
```
Future<MongoIterator<Document>> findAsync(Find.Builder query)
                                          throws MongoDbException
```
    Finds the set of documents matching the query in the collection.
    
    Parameters:
    query - The query details.
    
    Returns:
    A future for the MongoIterator over the documents.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - findOne
```
Document findOne(DocumentAssignable query)
                 throws MongoDbException
```
    Finds a single matching document in the collection.
    
    Parameters:
    query - The query document.
    
    Returns:
    The first found document.
    
    Throws:
    
    MongoDbException - On an error finding the document.
  - findOne
```
Document findOne(Find query)
                 throws MongoDbException
```
    Finds a single matching document in the collection.
    Note that following options in the Find class do not make sense and are silently ignored by this method.
    - Batch Size - Automatically set to 1.
    - Limit - Automatically set to 1.
    - Tailable - This method only returns 1 document.
    Parameters:
    query - The query details.
    
    Returns:
    The first found document.
    
    Throws:
    
    MongoDbException - On an error finding the document.
  - findOne
```
Document findOne(Find.Builder query)
                 throws MongoDbException
```
    Finds a single matching document in the collection.
    Note that following options in the Find class do not make sense and are silently ignored by this method.
    - Batch Size - Automatically set to 1.
    - Limit - Automatically set to 1.
    - Tailable - This method only returns 1 document.
    Parameters:
    query - The query details.
    
    Returns:
    The first found document.
    
    Throws:
    
    MongoDbException - On an error finding the document.
  - findOneAsync
```
void findOneAsync(Callback<Document> results,
                DocumentAssignable query)
                  throws MongoDbException
```
    Finds a single matching document in the collection.
    
    Parameters:
    results - Callback that will be notified of the results of the query.
    query - The query document.
    
    Throws:
    
    MongoDbException - On an error finding the document.
  - findOneAsync
```
void findOneAsync(Callback<Document> results,
                Find query)
                  throws MongoDbException
```
    Finds a single matching document in the collection.
    Note that following options in the Find class do not make sense and are silently ignored by this method.
    - Batch Size - Automatically set to 1.
    - Limit - Automatically set to 1.
    - Tailable - This method only returns 1 document.
    Parameters:
    results - Callback that will be notified of the results of the query.
    query - The query details.
    
    Throws:
    
    MongoDbException - On an error finding the document.
  - findOneAsync
```
void findOneAsync(Callback<Document> results,
                Find.Builder query)
                  throws MongoDbException
```
    Finds a single matching document in the collection.
    Note that following options in the Find class do not make sense and are silently ignored by this method.
    - Batch Size - Automatically set to 1.
    - Limit - Automatically set to 1.
    - Tailable - This method only returns 1 document.
    Parameters:
    results - Callback that will be notified of the results of the query.
    query - The query details.
    
    Throws:
    
    MongoDbException - On an error finding the document.
  - findOneAsync
```
Future<Document> findOneAsync(DocumentAssignable query)
                              throws MongoDbException
```
    Finds a single matching document in the collection.
    
    Parameters:
    query - The query document.
    
    Returns:
    The first found document.
    
    Throws:
    
    MongoDbException - On an error finding the document.
  - findOneAsync
```
Future<Document> findOneAsync(Find query)
                              throws MongoDbException
```
    Finds a single matching document in the collection.
    Note that following options in the Find class do not make sense and are silently ignored by this method.
    - Batch Size - Automatically set to 1.
    - Limit - Automatically set to 1.
    - Tailable - This method only returns 1 document.
    Parameters:
    query - The query details.
    
    Returns:
    The first found document.
    
    Throws:
    
    MongoDbException - On an error finding the document.
  - findOneAsync
```
Future<Document> findOneAsync(Find.Builder query)
                              throws MongoDbException
```
    Finds a single matching document in the collection.
    Note that following options in the Find class do not make sense and are silently ignored by this method.
    - Batch Size - Automatically set to 1.
    - Limit - Automatically set to 1.
    - Tailable - This method only returns 1 document.
    Parameters:
    query - The query details.
    
    Returns:
    The first found document.
    
    Throws:
    
    MongoDbException - On an error finding the document.
  - getDatabaseName
```
String getDatabaseName()
```
    Returns the name of the database.
    
    Returns:
    The name of the database.
  - getDurability
```
Durability getDurability()
```
    Returns the durability for write operations sent to the server from this MongoCollection instance.
    Defaults to the Durability from the parent MongoDatabase instance.
    
    Returns:
    The durability for write operations on the server.
    See Also:
    MongoDatabase.getDurability()
  - getName
```
String getName()
```
    Returns the name of the collection.
    
    Returns:
    The name of the collection.
  - getReadPreference
```
ReadPreference getReadPreference()
```
    Returns the read preference for queries from this MongoCollection instance.
    Defaults to ReadPreference from the parent MongoDatabase instance.
    
    Returns:
    The default read preference for a query.
    See Also:
    MongoDatabase.getReadPreference()
  - groupBy
```
ArrayElement groupBy(GroupBy command)
                     throws MongoDbException
```
    Invokes a group command on the server.
    
    Parameters:
    command - The details of the group request.
    
    Returns:
    The group results returned.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - groupBy
```
ArrayElement groupBy(GroupBy.Builder command)
                     throws MongoDbException
```
    Invokes a group command on the server.
    
    Parameters:
    command - The details of the group request.
    
    Returns:
    The group results returned.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - groupByAsync
```
void groupByAsync(Callback<ArrayElement> results,
                GroupBy command)
                  throws MongoDbException
```
    Invokes a group command on the server.
    
    Parameters:
    results - Callback for the group results returned.
    command - The details of the group request.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - groupByAsync
```
void groupByAsync(Callback<ArrayElement> results,
                GroupBy.Builder command)
                  throws MongoDbException
```
    Invokes a group command on the server.
    
    Parameters:
    results - Callback for the group results returned.
    command - The details of the group request.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - groupByAsync
```
Future<ArrayElement> groupByAsync(GroupBy command)
                                  throws MongoDbException
```
    Invokes a group command on the server.
    
    Parameters:
    command - The details of the group request.
    
    Returns:
    Future for the group results returned.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - groupByAsync
```
Future<ArrayElement> groupByAsync(GroupBy.Builder command)
                                  throws MongoDbException
```
    Invokes a group command on the server.
    
    Parameters:
    command - The details of the group request.
    
    Returns:
    Future for the group results returned.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - insert
```
int insert(boolean continueOnError,
         DocumentAssignable... documents)
           throws MongoDbException
```
    Inserts a set of documents into the collection.
    This is equivalent to calling insertAsync(...).get()
    
    Parameters:
    continueOnError - If the insert should continue if one of the documents causes an error.
    documents - The documents to add to the collection.
    
    Returns:
    Currently, returns zero. Once SERVER-4381 is fixed then expected to return the number of documents inserted. If the durability is NONE then returns -1.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - insert
```
int insert(boolean continueOnError,
         Durability durability,
         DocumentAssignable... documents)
           throws MongoDbException
```
    Inserts a set of documents into the collection.
    This is equivalent to calling insertAsync(...).get()
    
    Parameters:
    continueOnError - If the insert should continue if one of the documents causes an error.
    durability - The durability for the insert.
    documents - The documents to add to the collection.
    
    Returns:
    Currently, returns zero. Once SERVER-4381 is fixed then expected to return the number of documents inserted. If the durability is NONE then returns -1.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - insert
```
int insert(DocumentAssignable... documents)
           throws MongoDbException
```
    Inserts a set of documents into the collection.
    This is equivalent to calling insertAsync(...).get()
    
    Parameters:
    documents - The documents to add to the collection.
    
    Returns:
    Currently, returns zero. Once SERVER-4381 is fixed then expected to return the number of documents inserted. If the durability is NONE then returns -1.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - insert
```
int insert(Durability durability,
         DocumentAssignable... documents)
           throws MongoDbException
```
    Inserts a set of documents into the collection.
    This is equivalent to calling insertAsync(...).get()
    
    Parameters:
    durability - The durability for the insert.
    documents - The documents to add to the collection.
    
    Returns:
    Currently, returns zero. Once SERVER-4381 is fixed then expected to return the number of documents inserted. If the durability is NONE then returns -1.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - insertAsync
```
Future<Integer> insertAsync(boolean continueOnError,
                          DocumentAssignable... documents)
                            throws MongoDbException
```
    Inserts a set of documents into the collection.
    
    Parameters:
    continueOnError - If the insert should continue if one of the documents causes an error.
    documents - The documents to add to the collection.
    
    Returns:
    Future that will be updated with the results of the insert. Currently, the value is always zero. Once SERVER-4381 is fixed then expected to be the number of documents inserted. If the durability is NONE then returns -1.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - insertAsync
```
Future<Integer> insertAsync(boolean continueOnError,
                          Durability durability,
                          DocumentAssignable... documents)
                            throws MongoDbException
```
    Inserts a set of documents into the collection.
    
    Parameters:
    continueOnError - If the insert should continue if one of the documents causes an error.
    durability - The durability for the insert.
    documents - The documents to add to the collection.
    
    Returns:
    Future that will be updated with the results of the insert. Currently, the value is always zero. Once SERVER-4381 is fixed then expected to be the number of documents inserted. If the durability is NONE then returns -1.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - insertAsync
```
void insertAsync(Callback<Integer> results,
               boolean continueOnError,
               DocumentAssignable... documents)
                 throws MongoDbException
```
    Inserts a set of documents into the collection.
    
    Parameters:
    results - Callback that will be notified with the results of the insert. Currently, the value is always zero. Once SERVER-4381 is fixed then expected to be the number of documents inserted. If the durability is NONE then returns -1.
    continueOnError - If the insert should continue if one of the documents causes an error.
    documents - The documents to add to the collection.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - insertAsync
```
void insertAsync(Callback<Integer> results,
               boolean continueOnError,
               Durability durability,
               DocumentAssignable... documents)
                 throws MongoDbException
```
    Inserts a set of documents into the collection.
    
    Parameters:
    results - Callback that will be notified with the results of the insert. Currently, the value is always zero. Once SERVER-4381 is fixed then expected to be the number of documents inserted. If the durability is NONE then returns -1.
    continueOnError - If the insert should continue if one of the documents causes an error.
    durability - The durability for the insert.
    documents - The documents to add to the collection.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - insertAsync
```
void insertAsync(Callback<Integer> results,
               DocumentAssignable... documents)
                 throws MongoDbException
```
    Inserts a set of documents into the collection.
    
    Parameters:
    results - Callback that will be notified with the results of the insert. Currently, the value is always zero. Once SERVER-4381 is fixed then expected to be the number of documents inserted. If the durability is NONE then returns -1.
    documents - The documents to add to the collection.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - insertAsync
```
void insertAsync(Callback<Integer> results,
               Durability durability,
               DocumentAssignable... documents)
                 throws MongoDbException
```
    Inserts a set of documents into the collection.
    
    Parameters:
    results - Callback that will be notified with the results of the insert. Currently, the value is always zero. Once SERVER-4381 is fixed then expected to be the number of documents inserted. If the durability is NONE then returns -1.
    durability - The durability for the insert.
    documents - The documents to add to the collection.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - insertAsync
```
Future<Integer> insertAsync(DocumentAssignable... documents)
                            throws MongoDbException
```
    Inserts a set of documents into the collection.
    
    Parameters:
    documents - The documents to add to the collection.
    
    Returns:
    Future that will be updated with the results of the insert. Currently, the value is always zero. Once SERVER-4381 is fixed then expected to be the number of documents inserted. If the durability is NONE then returns -1.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - insertAsync
```
Future<Integer> insertAsync(Durability durability,
                          DocumentAssignable... documents)
                            throws MongoDbException
```
    Inserts a set of documents into the collection.
    
    Parameters:
    durability - The durability for the insert.
    documents - The documents to add to the collection.
    
    Returns:
    Future that will be updated with the results of the insert. Currently, the value is always zero. Once SERVER-4381 is fixed then expected to be the number of documents inserted. If the durability is NONE then returns -1.
    
    Throws:
    
    MongoDbException - On an error inserting the documents.
  - isCapped
```
boolean isCapped()
                 throws MongoDbException
```
    Returns true if the collection statistics indicate that the collection is a capped collection.
    
    Returns:
    True if the collection statistics indicate that the collection is a capped collection.
    
    Throws:
    
    MongoDbException - On an error collecting the collection statistics.
  - mapReduce
```
List<Document> mapReduce(MapReduce command)
                         throws MongoDbException
```
    Invokes a mapReduce command on the server.
    
    Parameters:
    command - The details of the map/reduce request.
    
    Returns:
    The map/reduce results returned. Note this might be empty if the output type is not inline.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - mapReduce
```
List<Document> mapReduce(MapReduce.Builder command)
                         throws MongoDbException
```
    Invokes a mapReduce command on the server.
    
    Parameters:
    command - The details of the map/reduce request.
    
    Returns:
    The map/reduce results returned. Note this might be empty if the output type is not inline.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - mapReduceAsync
```
void mapReduceAsync(Callback<List<Document>> results,
                  MapReduce command)
                    throws MongoDbException
```
    Invokes a mapReduce command on the server.
    
    Parameters:
    results - Callback for the map/reduce results returned. Note this might be empty if the output type is not inline.
    command - The details of the map/reduce request.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - mapReduceAsync
```
void mapReduceAsync(Callback<List<Document>> results,
                  MapReduce.Builder command)
                    throws MongoDbException
```
    Invokes a mapReduce command on the server.
    
    Parameters:
    results - Callback for the map/reduce results returned. Note this might be empty if the output type is not inline.
    command - The details of the map/reduce request.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - mapReduceAsync
```
Future<List<Document>> mapReduceAsync(MapReduce command)
                                      throws MongoDbException
```
    Invokes a mapReduce command on the server.
    
    Parameters:
    command - The details of the map/reduce request.
    
    Returns:
    Future for the map/reduce results returned. Note this might be empty if the output type is not inline.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - mapReduceAsync
```
Future<List<Document>> mapReduceAsync(MapReduce.Builder command)
                                      throws MongoDbException
```
    Invokes a mapReduce command on the server.
    
    Parameters:
    command - The details of the map/reduce request.
    
    Returns:
    Future for the map/reduce results returned. Note this might be empty if the output type is not inline.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - save
```
int save(DocumentAssignable document)
         throws MongoDbException
```
    Saves the document to the collection.
    If the document does not contain an _id field then this method is equivalent to: insert(document).
    
    If the document does contain an _id field then this method is equivalent to: update(BuilderFactory.start().add(document.get("_id")), document, false, true).
    
    Parameters:
    document - The document to save to the collection.
    
    Returns:
    Future that will be updated with the results of the save. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error saving the documents.
  - save
```
int save(DocumentAssignable document,
       Durability durability)
         throws MongoDbException
```
    Saves the document to the collection.
    If the document does not contain an _id field then this method is equivalent to: insert(durability, document).
    
    If the document does contain an _id field then this method is equivalent to: update(BuilderFactory.start().add(document.get("_id")), document, false, true, durability).
    
    Parameters:
    document - The document to save to the collection.
    durability - The durability for the save.
    
    Returns:
    Future that will be updated with the results of the save. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error saving the documents.
  - saveAsync
```
void saveAsync(Callback<Integer> results,
             DocumentAssignable document)
               throws MongoDbException
```
    Saves the document to the collection.
    If the document does not contain an _id field then this method is equivalent to: insertAsync(results, document).
    
    If the document does contain an _id field then this method is equivalent to: updateAsync(results, BuilderFactory.start().add(document.get("_id")), document, false, true).
    
    Parameters:
    results - Callback that will be notified with the results of the insert. If the durability of the operation is NONE then this will be -1.
    document - The document to save to the collection.
    
    Throws:
    
    MongoDbException - On an error saving the documents.
  - saveAsync
```
void saveAsync(Callback<Integer> results,
             DocumentAssignable document,
             Durability durability)
               throws MongoDbException
```
    Saves the document to the collection.
    If the document does not contain an _id field then this method is equivalent to: insertAsync(results, durability, document).
    
    If the document does contain an _id field then this method is equivalent to: updateAsync(results, BuilderFactory.start().add(document.get("_id")), document, false, true, durability).
    
    Parameters:
    results - Callback that will be notified with the results of the insert. If the durability of the operation is NONE then this will be -1.
    document - The document to save to the collection.
    durability - The durability for the save.
    
    Throws:
    
    MongoDbException - On an error saving the documents.
  - saveAsync
```
Future<Integer> saveAsync(DocumentAssignable document)
                          throws MongoDbException
```
    Saves the document to the collection.
    If the document does not contain an _id field then this method is equivalent to: insertAsync(document).
    
    If the document does contain an _id field then this method is equivalent to: updateAsync(BuilderFactory.start().add(document.get("_id")), document, false, true).
    
    Parameters:
    document - The document to save to the collection.
    
    Returns:
    Future that will be updated with the results of the save. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error saving the documents.
  - saveAsync
```
Future<Integer> saveAsync(DocumentAssignable document,
                        Durability durability)
                          throws MongoDbException
```
    Saves the document to the collection.
    If the document does not contain an _id field then this method is equivalent to: insertAsync(durability, document).
    
    If the document does contain an _id field then this method is equivalent to: updateAsync(BuilderFactory.start().add(document.get("_id")), document, false, true, durability).
    
    Parameters:
    document - The document to save to the collection.
    durability - The durability for the save.
    
    Returns:
    Future that will be updated with the results of the save. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error saving the documents.
  - setDurability
```
void setDurability(Durability durability)
```
    Sets the durability for write operations from this MongoCollection instance.
    Defaults to the Durability from the parent MongoDatabase instance if set to null.
    
    Parameters:
    durability - The durability for write operations on the server.
    See Also:
    MongoDatabase.getDurability()
  - setReadPreference
```
void setReadPreference(ReadPreference readPreference)
```
    Sets the value of the read preference for a queries from this MongoCollection instance.
    Defaults to the ReadPreference from the parent MongoDatabase instance if set to null.
    
    Parameters:
    readPreference - The read preference for a query.
    See Also:
    MongoDatabase.getReadPreference()
  - stats
```
Document stats()
               throws MongoDbException
```
    Returns the statistics for the collection.
    
    Returns:
    The results document with the collection statistics.
    
    Throws:
    
    MongoDbException - On an error collecting the collection statistics.
    See Also:
    collStats Command Reference
  - streamingFind
```
@Deprecated
MongoCursorControl streamingFind(Callback<Document> results,
                                          DocumentAssignable query)
                                 throws MongoDbException
```
    Deprecated. Use the streamingFind(StreamCallback, DocumentAssignable) method instead. This method will be removed after the 1.3.0 release.
    
    Finds the set of documents matching the query document in the collection and streams them to the provided callback one at a time.
    The sequence of callbacks will be terminated by either calling the results.callback(...) method with null or by calling the results.exception(...) method on an error.
    
    Applications can terminate the stream by throwing a RuntimeException from the Callback.callback(V) method (which will then call the Callback.exception(java.lang.Throwable) method).
    
    Only a single thread will invoke the callback at a time but that thread may change over time.
    
    If the callback processing requires any significant time (including I/O) it is recommended that an Executor be configured within the MongoClientConfiguration to off-load the processing from the receive thread.
    
    Parameters:
    results - Callback that will be notified of the results of the query.
    query - The query document.
    
    Returns:
    A MongoCursorControl to control the cursor streaming documents to the caller. This includes the ability to stop the cursor and persist its state.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - streamingFind
```
@Deprecated
MongoCursorControl streamingFind(Callback<Document> results,
                                          Find query)
                                 throws MongoDbException
```
    Deprecated. Use the streamingFind(StreamCallback, Find) method instead. This method will be removed after the 1.3.0 release.
    
    Finds the set of documents matching the query in the collection and streams them to the provided callback one at a time.
    The sequence of callbacks will be terminated by either calling the results.callback(...) method with null or by calling the results.exception(...) method on an error.
    
    Applications can terminate the stream by throwing a RuntimeException from the Callback.callback(V) method (which will then call the Callback.exception(java.lang.Throwable) method).
    
    Only a single thread will invoke the callback at a time but that thread may change over time.
    
    If the callback processing requires any significant time (including I/O) it is recommended that an Executor be configured within the MongoClientConfiguration to off-load the processing from the receive thread.
    
    Parameters:
    results - Callback that will be notified of the results of the query.
    query - The query details.
    
    Returns:
    A MongoCursorControl to control the cursor streaming documents to the caller. This includes the ability to stop the cursor and persist its state.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - streamingFind
```
MongoCursorControl streamingFind(StreamCallback<Document> results,
                               DocumentAssignable query)
                                 throws MongoDbException
```
    Finds the set of documents matching the query document in the collection and streams them to the provided callback one at a time.
    The sequence of callbacks will be terminated by either calling the results.done() method or by calling the results.exception(...) method (in the event of an error).
    
    Applications can terminate the stream by throwing a RuntimeException from the Callback.callback(V) method (which will then call the Callback.exception(java.lang.Throwable) method or by closing the MongoCursorControl returned from this method.
    
    Only a single thread will invoke the callback at a time but that thread may change over time.
    
    If the callback processing requires any significant time (including I/O) it is recommended that an Executor be configured within the MongoClientConfiguration to off-load the processing from the receive thread.
    
    Parameters:
    results - Callback that will be notified of the results of the query.
    query - The query document.
    
    Returns:
    A MongoCursorControl to control the cursor streaming documents to the caller. This includes the ability to stop the cursor and persist its state.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - streamingFind
```
MongoCursorControl streamingFind(StreamCallback<Document> results,
                               Find query)
                                 throws MongoDbException
```
    Finds the set of documents matching the query in the collection and streams them to the provided callback one at a time.
    The sequence of callbacks will be terminated by either calling the results.done() method or by calling the results.exception(...) method (in the event of an error).
    
    Applications can terminate the stream by throwing a RuntimeException from the Callback.callback(V) method (which will then call the Callback.exception(java.lang.Throwable) method or by closing the MongoCursorControl returned from this method.
    
    Only a single thread will invoke the callback at a time but that thread may change over time.
    
    If the callback processing requires any significant time (including I/O) it is recommended that an Executor be configured within the MongoClientConfiguration to off-load the processing from the receive thread.
    
    Parameters:
    results - Callback that will be notified of the results of the query.
    query - The query details.
    
    Returns:
    A MongoCursorControl to control the cursor streaming documents to the caller. This includes the ability to stop the cursor and persist its state.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - streamingFind
```
MongoCursorControl streamingFind(StreamCallback<Document> results,
                               Find.Builder query)
                                 throws MongoDbException
```
    Finds the set of documents matching the query in the collection and streams them to the provided callback one at a time.
    The sequence of callbacks will be terminated by either calling the results.done() method or by calling the results.exception(...) method (in the event of an error).
    
    Applications can terminate the stream by throwing a RuntimeException from the Callback.callback(V) method (which will then call the Callback.exception(java.lang.Throwable) method or by closing the MongoCursorControl returned from this method.
    
    Only a single thread will invoke the callback at a time but that thread may change over time.
    
    If the callback processing requires any significant time (including I/O) it is recommended that an Executor be configured within the MongoClientConfiguration to off-load the processing from the receive thread.
    
    Parameters:
    results - Callback that will be notified of the results of the query.
    query - The query details.
    
    Returns:
    A MongoCursorControl to control the cursor streaming documents to the caller. This includes the ability to stop the cursor and persist its state.
    
    Throws:
    
    MongoDbException - On an error finding the documents.
  - textSearch
```
List<TextResult> textSearch(Text command)
                            throws MongoDbException
```
    Invokes a text command on the server.
    
    Parameters:
    command - The details of the text request.
    
    Returns:
    The text results returned.
    
    Throws:
    
    MongoDbException - On an error executing the text command.
    Since:
    
    MongoDB 2.4
    
    See Also:
    MongoDB Text Queries
  - textSearch
```
List<TextResult> textSearch(Text.Builder command)
                            throws MongoDbException
```
    Invokes a text command on the server.
    
    Parameters:
    command - The details of the text request.
    
    Returns:
    The text results returned.
    
    Throws:
    
    MongoDbException - On an error executing the text command.
    Since:
    
    MongoDB 2.4
    
    See Also:
    MongoDB Text Queries
  - textSearchAsync
```
void textSearchAsync(Callback<List<TextResult>> results,
                   Text command)
                     throws MongoDbException
```
    Invokes a text command on the server.
    
    Parameters:
    results - Callback for the text results returned.
    command - The details of the text request.
    
    Throws:
    
    MongoDbException - On an error executing the text command.
    Since:
    
    MongoDB 2.4
    
    See Also:
    MongoDB Text Queries
  - textSearchAsync
```
void textSearchAsync(Callback<List<TextResult>> results,
                   Text.Builder command)
                     throws MongoDbException
```
    Invokes a text command on the server.
    
    Parameters:
    results - Callback for the text results returned.
    command - The details of the text request.
    
    Throws:
    
    MongoDbException - On an error executing the text command.
  - textSearchAsync
```
Future<List<TextResult>> textSearchAsync(Text command)
                                         throws MongoDbException
```
    Invokes a text command on the server.
    
    Parameters:
    command - The details of the text request.
    
    Returns:
    Future for the text results returned.
    
    Throws:
    
    MongoDbException - On an error executing the text command.
    Since:
    
    MongoDB 2.4
    
    See Also:
    MongoDB Text Queries
  - textSearchAsync
```
Future<List<TextResult>> textSearchAsync(Text.Builder command)
                                         throws MongoDbException
```
    Invokes a text command on the server.
    
    Parameters:
    command - The details of the text request.
    
    Returns:
    Future for the text results returned.
    
    Throws:
    
    MongoDbException - On an error executing the text command.
    Since:
    
    MongoDB 2.4
    
    See Also:
    MongoDB Text Queries
  - update
```
long update(DocumentAssignable query,
          DocumentAssignable update)
            throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    
    Returns:
    The number of documents updated. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - update
```
long update(DocumentAssignable query,
          DocumentAssignable update,
          boolean multiUpdate,
          boolean upsert)
            throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    multiUpdate - If true then the update is applied to all of the matching documents, otherwise only the first document found is updated.
    upsert - If true then if no document is found then a new document is created and updated, otherwise no operation is performed.
    
    Returns:
    The number of documents updated. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - update
```
long update(DocumentAssignable query,
          DocumentAssignable update,
          boolean multiUpdate,
          boolean upsert,
          Durability durability)
            throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    multiUpdate - If true then the update is applied to all of the matching documents, otherwise only the first document found is updated.
    upsert - If true then if no document is found then a new document is created and updated, otherwise no operation is performed.
    durability - The durability for the insert.
    
    Returns:
    The number of documents updated. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - update
```
long update(DocumentAssignable query,
          DocumentAssignable update,
          Durability durability)
            throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    durability - The durability for the update.
    
    Returns:
    The number of documents updated. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - updateAsync
```
void updateAsync(Callback<Long> results,
               DocumentAssignable query,
               DocumentAssignable update)
                 throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    results - The Callback that will be notified of the number of documents updated. If the durability of the operation is NONE then this will be -1.
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - updateAsync
```
void updateAsync(Callback<Long> results,
               DocumentAssignable query,
               DocumentAssignable update,
               boolean multiUpdate,
               boolean upsert)
                 throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    results - The Callback that will be notified of the number of documents updated. If the durability of the operation is NONE then this will be -1.
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    multiUpdate - If true then the update is applied to all of the matching documents, otherwise only the first document found is updated.
    upsert - If true then if no document is found then a new document is created and updated, otherwise no operation is performed.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - updateAsync
```
void updateAsync(Callback<Long> results,
               DocumentAssignable query,
               DocumentAssignable update,
               boolean multiUpdate,
               boolean upsert,
               Durability durability)
                 throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    results - The Callback that will be notified of the number of documents updated. If the durability of the operation is NONE then this will be -1.
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    multiUpdate - If true then the update is applied to all of the matching documents, otherwise only the first document found is updated.
    upsert - If true then if no document is found then a new document is created and updated, otherwise no operation is performed.
    durability - The durability for the update.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - updateAsync
```
void updateAsync(Callback<Long> results,
               DocumentAssignable query,
               DocumentAssignable update,
               Durability durability)
                 throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    results - The Callback that will be notified of the number of documents updated. If the durability of the operation is NONE then this will be -1.
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    durability - The durability for the update.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - updateAsync
```
Future<Long> updateAsync(DocumentAssignable query,
                       DocumentAssignable update)
                         throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    
    Returns:
    A Future that will be updated with the number of documents updated. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - updateAsync
```
Future<Long> updateAsync(DocumentAssignable query,
                       DocumentAssignable update,
                       boolean multiUpdate,
                       boolean upsert)
                         throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    multiUpdate - If true then the update is applied to all of the matching documents, otherwise only the first document found is updated.
    upsert - If true then if no document is found then a new document is created and updated, otherwise no operation is performed.
    
    Returns:
    A Future that will be updated with the number of documents updated. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - updateAsync
```
Future<Long> updateAsync(DocumentAssignable query,
                       DocumentAssignable update,
                       boolean multiUpdate,
                       boolean upsert,
                       Durability durability)
                         throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    multiUpdate - If true then the update is applied to all of the matching documents, otherwise only the first document found is updated.
    upsert - If true then if no document is found then a new document is created and updated, otherwise no operation is performed.
    durability - The durability for the update.
    
    Returns:
    A Future that will be updated with the number of documents updated. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - updateAsync
```
Future<Long> updateAsync(DocumentAssignable query,
                       DocumentAssignable update,
                       Durability durability)
                         throws MongoDbException
```
    Applies updates to a set of documents within the collection. The documents to update are selected by the query and the updates are describe by the update document.
    
    Parameters:
    query - The query to select the documents to update.
    update - The updates to apply to the selected documents.
    durability - The durability for the update.
    
    Returns:
    A Future that will be updated with the number of documents updated. If the durability of the operation is NONE then this will be -1.
    
    Throws:
    
    MongoDbException - On an error updating the documents.
  - updateOptions
```
Document updateOptions(DocumentAssignable options)
                       throws MongoDbException
```
    Updates the collection's options or flags using the collMod command. The return value is the response from the MongoDB server and normally contains a <name>_old field for each successfully set option on the collection.
    MongoCollection collection = ...; collection.updateOptions( BuilderFactory.start().add( "usePowerOf2Sizes", true ) );
    Parameters:
    options - The collection options to be set.
    
    Returns:
    The results document from the database.
    
    Throws:
    
    MongoDbException - On an error validating the collection.
    See Also:
    collMod Command Reference
  - validate
```
Document validate(MongoCollection.ValidateMode mode)
                  throws MongoDbException
```
    Validates the collections contents.
    
    Parameters:
    mode - The validation mode to use.
    
    Returns:
    The results document from the database.
    
    Throws:
    
    MongoDbException - On an error validating the collection.
    See Also:
    validate Command Reference

Interface MongoCollection

Nested Class Summary

Field Summary

Method Summary

Field Detail

ALL

Method Detail

aggregate

aggregate

aggregateAsync

aggregateAsync

aggregateAsync

aggregateAsync

count

count

count

count

countAsync

countAsync

countAsync

countAsync

countAsync

countAsync

countAsync

countAsync

createIndex

createIndex

createIndex

createIndex

createIndex

delete

delete

delete

delete

deleteAsync

deleteAsync

deleteAsync

deleteAsync

deleteAsync

deleteAsync

deleteAsync

deleteAsync

distinct

distinct

distinctAsync

distinctAsync

distinctAsync

distinctAsync

drop

dropIndex

dropIndex

explain

explain

explain

explainAsync

explainAsync

explainAsync

explainAsync

find

find

find

findAndModify

findAndModify

findAndModifyAsync

findAndModifyAsync

findAndModifyAsync

findAndModifyAsync

findAsync

findAsync

findAsync

findAsync

findAsync

findAsync

findOne

findOne

findOne

findOneAsync

findOneAsync

findOneAsync

findOneAsync