com.allanbank.mongodb

Interface MongoCollection

All Superinterfaces:

AsyncMongoCollection

All Known Implementing Classes:

SynchronousMongoCollectionImpl

public interface MongoCollection
extends AsyncMongoCollection

Interface for interacting with a MongoDB collection.

The asynchronous methods for interacting with a collection are declared as part of the AsyncMongoCollection interface (which this interface extends. The separation of the interfaces is to support the ability to batch requests to the server. This will take advantage of the batched write commands if the driver is only connected to @link 2.6 or above servers otherwise batching is similar in function to the serialized client capability.

To use the batching capability you will need to call the startBatch() method and then ensure that the close() method is called to submit the batch of requests.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static Document	ALL An (empty) query document to find all documents.
static Document	NONE An (empty) update document to perform no actual modifications.

Method Summary

Methods

Modifier and Type	Method and Description
MongoIterator<Document>	aggregate(Aggregate.Builder command) Invokes a aggregate command on the server.
MongoIterator<Document>	aggregate(Aggregate command) Invokes a aggregate command on the server.
long	count() Counts the set of documents in the collection.
long	count(Count.Builder count) Counts the set of documents matching the query document in the collection.
long	count(Count count) Counts the set of documents matching the query document 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.
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.
MongoIterator<Element>	distinct(Distinct.Builder command) Invokes a distinct command on the server.
MongoIterator<Element>	distinct(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.
boolean	exists() Returns true if this collection already exists on the server.
Document	explain(Aggregate.Builder aggregation) Explains the way that the aggregation will be performed.
Document	explain(Aggregate aggregation) Explains the way that the aggregation will be performed.
Document	explain(DocumentAssignable query) Explains the way that the query will be performed.
Document	explain(Find.Builder query) Explains the way that the query will be performed.
Document	explain(Find query) Explains the way that the query 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.
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.
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.
MongoIterator<Element>	groupBy(GroupBy.Builder command) Invokes a group command on the server.
MongoIterator<Element>	groupBy(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.
boolean	isCapped() Returns true if the collection statistics indicate that the collection is a capped collection.
MongoIterator<Document>	mapReduce(MapReduce.Builder command) Invokes a mapReduce command on the server.
MongoIterator<Document>	mapReduce(MapReduce command) Invokes a mapReduce command on the server.
Collection<MongoIterator<Document>>	parallelScan(ParallelScan.Builder parallelScan) Uses the parallelCollectionScan command to open multiple iterators over the collection each configured to scan a distinct regions of the collection.
Collection<MongoIterator<Document>>	parallelScan(ParallelScan parallelScan) Uses the parallelCollectionScan command to open multiple iterators over the collection each configured to scan a distinct regions of the collection.
int	save(DocumentAssignable document) Saves the document to the collection.
int	save(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.
BatchedAsyncMongoCollection	startBatch() Starts a batch of requests to the server.
Document	stats() Returns the statistics for the collection.
MongoIterator<TextResult>	textSearch(Text.Builder command) Deprecated. Support for the text command was deprecated in the 2.6 version of MongoDB. Use the $text query operator instead. This method will not be removed until two releases after the MongoDB 2.6 release (e.g. 2.10 if the releases are 2.8 and 2.10).
MongoIterator<TextResult>	textSearch(Text command) Deprecated. Support for the text command was deprecated in the 2.6 version of MongoDB. Use the $text query operator instead. This method will not be removed until two releases after the MongoDB 2.6 release (e.g. 2.10 if the releases are 2.8 and 2.10).
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.
Document	updateOptions(DocumentAssignable options) Updates the collection's options or flags using the collMod command.
Document	validate(MongoCollection.ValidateMode mode) Validates the collections contents.
long	write(BatchedWrite.Builder write) Constructs the appropriate set of write commands to send to the server.
long	write(BatchedWrite write) Constructs the appropriate set of write commands to send to the server.

Methods inherited from interface com.allanbank.mongodb.AsyncMongoCollection

aggregateAsync, aggregateAsync, aggregateAsync, aggregateAsync, aggregateAsync, aggregateAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, distinctAsync, distinctAsync, distinctAsync, distinctAsync, distinctAsync, distinctAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, findAndModifyAsync, findAndModifyAsync, findAndModifyAsync, findAndModifyAsync, findAndModifyAsync, findAndModifyAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, groupByAsync, groupByAsync, groupByAsync, groupByAsync, groupByAsync, groupByAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, mapReduceAsync, mapReduceAsync, mapReduceAsync, mapReduceAsync, mapReduceAsync, mapReduceAsync, parallelScanAsync, parallelScanAsync, parallelScanAsync, parallelScanAsync, parallelScanAsync, parallelScanAsync, saveAsync, saveAsync, saveAsync, saveAsync, saveAsync, saveAsync, stream, stream, stream, stream, stream, stream, stream, stream, streamingFind, streamingFind, streamingFind, streamingFind, streamingFind, streamingFind, textSearchAsync, textSearchAsync, textSearchAsync, textSearchAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, writeAsync, writeAsync, writeAsync, writeAsync, writeAsync, writeAsync

Field Detail

ALL

static final Document ALL

An (empty) query document to find all documents.

NONE

static final Document NONE

An (empty) update document to perform no actual modifications.

Method Detail

aggregate

MongoIterator<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

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

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(Count count)
           throws MongoDbException

Counts the set of documents matching the query document in the collection.

Parameters:

count - The count command.

Returns:

The count of the documents.

Throws:

MongoDbException - On an error counting the documents.

count

long count(Count.Builder count)
           throws MongoDbException

Counts the set of documents matching the query document in the collection.

Parameters:

count - The count command.

Returns:

The count of the documents.

Throws:

MongoDbException - On an error counting 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.

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.

distinct

MongoIterator<Element> 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

MongoIterator<Element> 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.

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.

exists

boolean exists()
               throws MongoDbException

Returns true if this collection already exists on the server.

This method is simply a helper name to check if this collection's name appears in the parent database's list of collections.

Returns:

True if the parent database returns this collection's name in its list of collection names.

Throws:

MongoDbException - On an error retrieving the list of collections.

explain

Document explain(Aggregate aggregation)
                 throws MongoDbException

Explains the way that the aggregation will be performed.

This is equivalent to calling explainAsync(...).get()

Parameters:

aggregation - The aggregation details.

Returns:

The document describing the method used to execute the aggregation.

Throws:

MongoDbException - On an error finding the documents.

Since:

MongoDB 2.6

explain

Document explain(Aggregate.Builder aggregation)
                 throws MongoDbException

Explains the way that the aggregation will be performed.

This is equivalent to calling explainAsync(...).get()

Parameters:

aggregation - The aggregation details.

Returns:

The document describing the method used to execute the aggregation.

Throws:

MongoDbException - On an error finding the documents.

Since:

MongoDB 2.6

explain

Document explain(DocumentAssignable query)
                 throws MongoDbException

Explains the way that the query 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 query 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 query 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.

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.

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.

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

MongoIterator<Element> 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

MongoIterator<Element> 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.

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.

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

MongoIterator<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

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

parallelScan

Collection<MongoIterator<Document>> parallelScan(ParallelScan parallelScan)
                                                 throws MongoDbException

Uses the parallelCollectionScan command to open multiple iterators over the collection each configured to scan a distinct regions of the collection. You may then use a separate thread to scan each region of the collection in parallel.

Parameters:

parallelScan - The details on the scan.

Returns:

The collection of iterators.

Throws:

MongoDbException - On an error initializing the parallel scan.

See Also:

parallelCollectionScan Command

parallelScan

Collection<MongoIterator<Document>> parallelScan(ParallelScan.Builder parallelScan)
                                                 throws MongoDbException

Uses the parallelCollectionScan command to open multiple iterators over the collection each configured to scan a distinct regions of the collection. You may then use a separate thread to scan each region of the collection in parallel.

Parameters:

parallelScan - The details on the scan.

Returns:

The collection of iterators.

Throws:

MongoDbException - On an error initializing the parallel scan.

See Also:

parallelCollectionScan Command

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:

ListenableFuture 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:

ListenableFuture 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()

startBatch

BatchedAsyncMongoCollection startBatch()

Starts a batch of requests to the server. The returned object will not submit any requests to the server until the batch is closed.

Returns:

The interface for submitting batched requests. The BatchedAsyncMongoCollection.close() method must be called to submit the batch of requests.

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

textSearch

@Deprecated
MongoIterator<TextResult> textSearch(Text command)
                                     throws MongoDbException

Deprecated. Support for the text command was deprecated in the 2.6 version of MongoDB. Use the $text query operator instead. This method will not be removed until two releases after the MongoDB 2.6 release (e.g. 2.10 if the releases are 2.8 and 2.10).

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

@Deprecated
MongoIterator<TextResult> textSearch(Text.Builder command)
                                     throws MongoDbException

Deprecated. Support for the text command was deprecated in the 2.6 version of MongoDB. Use the $text query operator instead. This method will not be removed until two releases after the MongoDB 2.6 release (e.g. 2.10 if the releases are 2.8 and 2.10).

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

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.

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

write

long write(BatchedWrite write)
           throws MongoDbException

Constructs the appropriate set of write commands to send to the server.

If connected to a cluster where all servers can accept write commands then the operations will be sent to the server using the write commands. If the cluster does not support the write command then the operations will be converted to a series of native write operations.

Since this method may use the write commands a Durability of Durability.NONE will be changed to Durability.ACK.

Parameters:

write - The batched writes

Returns:

The results of the inserts, updates, and deletes. If this method falls back to the native write commands then the notice for the return for the insert(DocumentAssignable...) method applies.

Throws:

MongoDbException - On an error submitting the write operations.

Since:

MongoDB 2.6

See Also:

BatchedWrite.REQUIRED_VERSION

write

long write(BatchedWrite.Builder write)
           throws MongoDbException

Constructs the appropriate set of write commands to send to the server.

If connected to a cluster where all servers can accept write commands then the operations will be sent to the server using the write commands. If the cluster does not support the write command then the operations will be converted to a series of native write operations.

Since this method may use the write commands a Durability of Durability.NONE will be changed to Durability.ACK.

Parameters:

write - The batched writes

Returns:

The results of the inserts, updates, and deletes. If this method falls back to the native write commands then the notice for the return for the insert(DocumentAssignable...) method applies.

Throws:

MongoDbException - On an error submitting the write operations.

Since:

MongoDB 2.6

See Also:

BatchedWrite.REQUIRED_VERSION