Package | Description |
---|---|
com.allanbank.mongodb |
Provides a Java driver for the MongoDB document store that allows asynchronous invocation of requests.
|
com.allanbank.mongodb.builder |
Provides domain classes and builders for queries and the common MongoDB commands.
|
com.allanbank.mongodb.client |
Provides implementations of the main client interfaces and classes to translate the
Reply (s) from the server. |
Modifier and Type | Method and Description |
---|---|
Document |
MongoCollection.explain(Find.Builder query)
Explains the way that the query will be performed.
|
void |
AsyncMongoCollection.explainAsync(Callback<Document> results,
Find.Builder query)
Explains the way that the query will be performed.
|
ListenableFuture<Document> |
AsyncMongoCollection.explainAsync(Find.Builder query)
Explains the way that the document will be performed.
|
void |
AsyncMongoCollection.explainAsync(LambdaCallback<Document> results,
Find.Builder query)
Explains the way that the query will be performed.
|
MongoIterator<Document> |
MongoCollection.find(Find.Builder query)
Finds the set of documents matching the query in the collection.
|
void |
AsyncMongoCollection.findAsync(Callback<MongoIterator<Document>> results,
Find.Builder query)
Finds the set of documents matching the query in the collection.
|
ListenableFuture<MongoIterator<Document>> |
AsyncMongoCollection.findAsync(Find.Builder query)
Finds the set of documents matching the query in the collection.
|
void |
AsyncMongoCollection.findAsync(LambdaCallback<MongoIterator<Document>> results,
Find.Builder query)
Finds the set of documents matching the query in the collection.
|
Document |
MongoCollection.findOne(Find.Builder query)
Finds a single matching document in the collection.
|
void |
AsyncMongoCollection.findOneAsync(Callback<Document> results,
Find.Builder query)
Finds a single matching document in the collection.
|
ListenableFuture<Document> |
AsyncMongoCollection.findOneAsync(Find.Builder query)
Finds a single matching document in the collection.
|
void |
AsyncMongoCollection.findOneAsync(LambdaCallback<Document> results,
Find.Builder query)
Finds a single matching document in the collection.
|
MongoCursorControl |
AsyncMongoCollection.stream(LambdaCallback<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 |
AsyncMongoCollection.stream(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 |
AsyncMongoCollection.streamingFind(StreamCallback<Document> results,
Find.Builder query)
Deprecated.
Use the
AsyncMongoCollection.stream(StreamCallback, Find.Builder) method
instead. This method will be removed after the 1.4.0 release. |
Modifier and Type | Method and Description |
---|---|
Find.Builder |
Find.Builder.batchSize(int batchSize)
Sets the value of the number of documents to be returned in each
batch.
|
static Find.Builder |
Find.builder()
Creates a new builder for a
Find . |
Find.Builder |
Find.Builder.hint(DocumentAssignable indexFields)
Sets the value of hint as to which index should be used to execute
the query.
|
Find.Builder |
Find.Builder.hint(Element... indexFields)
Sets the value of hint as to which index should be used to execute
the query.
|
Find.Builder |
Find.Builder.hint(String indexName)
Sets the value of hint as to which index should be used to execute
the query.
|
Find.Builder |
Find.Builder.immortalCursor()
Sets the cursor returned from the query to never timeout or die
automatically, e.g., immortal.
|
Find.Builder |
Find.Builder.immortalCursor(boolean immortal)
If set to true the cursor returned from the query will not timeout or
die automatically, e.g., immortal.
|
Find.Builder |
Find.Builder.limit(int limit)
Sets the value of the total number of documents to be returned.
|
Find.Builder |
Find.Builder.max(DocumentAssignable maximumRange)
Sets the value of maximum range for the index used to the new value.
|
Find.Builder |
Find.Builder.maximumTime(long timeLimit,
TimeUnit timeLimitUnits)
Sets the maximum number of milliseconds to allow the query to run
before aborting the request on the server.
|
Find.Builder |
Find.Builder.maxScan(long maximumDocumentsToScan)
Sets the value of maximum number of documents that will be scanned
for results to the new value.
|
Find.Builder |
Find.Builder.min(DocumentAssignable minimumRange)
Sets the value of minimum range for the index used to the new value.
|
Find.Builder |
Find.Builder.partialOk()
Sets that if there is an error then the query should return any
partial results.
|
Find.Builder |
Find.Builder.partialOk(boolean partialOk)
Sets the value of partial okay to the new value.
|
Find.Builder |
Find.Builder.projection(DocumentAssignable projection)
Sets the value of the fields to be projected from the matching
documents to the new value.
|
Find.Builder |
Find.Builder.projection(String... fieldNames)
Sets the value of the fields to be returned from the matching
documents to the new value.
|
Find.Builder |
Find.Builder.query(DocumentAssignable query)
Sets the value of the query document to the new value.
|
Find.Builder |
Find.Builder.readPreference(ReadPreference readPreference)
Sets the preference for the set of servers to retrieve the results
from.
|
Find.Builder |
Find.Builder.reset()
Resets the builder back to its initial state for reuse.
|
Find.Builder |
Find.Builder.returnFields(DocumentAssignable returnFields)
Deprecated.
Replaced with the MongoDB standardized name:
projection . This
method will be removed on or after the 1.4 release. |
Find.Builder |
Find.Builder.returnFields(String... fieldNames)
Deprecated.
Replaced with the MongoDB standardized name:
projection . This method
will be removed on or after the 1.4 release. |
Find.Builder |
Find.Builder.returnKey()
Sets that only index keys should be returned.
|
Find.Builder |
Find.Builder.returnKey(boolean returnIndexKeysOnly)
Sets the value for if only index keys should be returned to the new
value.
|
Find.Builder |
Find.Builder.setAwaitData(boolean awaitData)
If set to true requests for data will block, waiting for data.
|
Find.Builder |
Find.Builder.setBatchSize(int batchSize)
Sets the value of the number of documents to be returned in each
batch.
|
Find.Builder |
Find.Builder.setHint(DocumentAssignable indexFields)
Sets the value of hint as to which index should be used to execute
the query.
|
Find.Builder |
Find.Builder.setHint(Element... indexFields)
Sets the value of hint as to which index should be used to execute
the query.
|
Find.Builder |
Find.Builder.setHint(String indexName)
Sets the value of hint as to which index should be used to execute
the query.
|
Find.Builder |
Find.Builder.setImmortalCursor(boolean immortal)
If set to true the cursor returned from the query will not timeout or
die automatically, e.g., immortal.
|
Find.Builder |
Find.Builder.setLimit(int limit)
Sets the value of the total number of documents to be returned.
|
Find.Builder |
Find.Builder.setMaximumDocumentsToScan(long maximumDocumentsToScan)
Sets the value of maximum number of documents that will be scanned
for results to the new value.
|
Find.Builder |
Find.Builder.setMaximumRange(DocumentAssignable maximumRange)
Sets the value of maximum range for the index used to the new value.
|
Find.Builder |
Find.Builder.setMaximumTimeMilliseconds(long maximumTimeMilliseconds)
Sets the maximum number of milliseconds to allow the query to run
before aborting the request on the server.
|
Find.Builder |
Find.Builder.setMinimumRange(DocumentAssignable minimumRange)
Sets the value of minimum range for the index used to the new value.
|
Find.Builder |
Find.Builder.setNumberToSkip(int numberToSkip)
Sets the value of the number of documents to skip before returning
the first document to the new value.
|
Find.Builder |
Find.Builder.setPartialOk(boolean partialOk)
Sets the value of partial okay to the new value.
|
Find.Builder |
Find.Builder.setProjection(DocumentAssignable projection)
Sets the value of the fields to be projected or returned from the
matching documents to the new value.
|
Find.Builder |
Find.Builder.setQuery(DocumentAssignable query)
Sets the value of the query document to the new value.
|
Find.Builder |
Find.Builder.setReadPreference(ReadPreference readPreference)
Sets the preference for the set of servers to retrieve the results
from.
|
Find.Builder |
Find.Builder.setReturnFields(DocumentAssignable returnFields)
Deprecated.
Replaced with the MongoDB standardized name:
projection . This method will be
removed on or after the 1.4 release. |
Find.Builder |
Find.Builder.setReturnIndexKeysOnly(boolean returnIndexKeysOnly)
Sets the value for if only index keys should be returned to the new
value.
|
Find.Builder |
Find.Builder.setShowDiskLocation(boolean showDiskLocation)
Sets the value if the disk location for each document should be
returned to the new value.
|
Find.Builder |
Find.Builder.setSnapshot(boolean snapshot)
Sets the value of snapshot to the new value.
|
Find.Builder |
Find.Builder.setSort(DocumentAssignable sortFields)
Sets the value of the fields to to sort matching documents by.
|
Find.Builder |
Find.Builder.setSort(IntegerElement... sortFields)
Sets the value of the fields to to sort matching documents by.
|
Find.Builder |
Find.Builder.setTailable(boolean tailable)
If set to true the cursor returned from the query will be tailable.
|
Find.Builder |
Find.Builder.showDiskLoc()
Sets that the disk location for each document should be returned.
|
Find.Builder |
Find.Builder.showDiskLoc(boolean showDiskLocation)
Sets the value if the disk location for each document should be
returned to the new value.
|
Find.Builder |
Find.Builder.skip(int numberToSkip)
Sets the value of the number of documents to skip before returning
the first document to the new value.
|
Find.Builder |
Find.Builder.snapshot()
Sets that the query should ensure that documents are only returned
once.
|
Find.Builder |
Find.Builder.snapshot(boolean snapshot)
Sets the value of snapshot to the new value.
|
Find.Builder |
Find.Builder.sort(DocumentAssignable sortFields)
Sets the value of the fields to to sort matching documents by.
|
Find.Builder |
Find.Builder.sort(IntegerElement... sortFields)
Sets the value of the fields to to sort matching documents by.
|
Find.Builder |
Find.Builder.tailable()
Sets the the cursor returned from the query to be
setTailable(true) and
setAwaitData(true) . |
Constructor and Description |
---|
Find(Find.Builder builder)
Creates a new Find.
|
Modifier and Type | Method and Description |
---|---|
Document |
SynchronousMongoCollectionImpl.explain(Find.Builder query)
Explains the way that the query will be performed.
|
void |
AbstractAsyncMongoCollection.explainAsync(Callback<Document> results,
Find.Builder query)
Explains the way that the query will be performed.
|
ListenableFuture<Document> |
AbstractAsyncMongoCollection.explainAsync(Find.Builder query)
Explains the way that the document will be performed.
|
void |
AbstractAsyncMongoCollection.explainAsync(LambdaCallback<Document> results,
Find.Builder query)
Explains the way that the query will be performed.
|
MongoIterator<Document> |
SynchronousMongoCollectionImpl.find(Find.Builder query)
Finds the set of documents matching the query in the collection.
|
void |
AbstractAsyncMongoCollection.findAsync(Callback<MongoIterator<Document>> results,
Find.Builder query)
Finds the set of documents matching the query in the collection.
|
ListenableFuture<MongoIterator<Document>> |
AbstractAsyncMongoCollection.findAsync(Find.Builder query)
Finds the set of documents matching the query in the collection.
|
void |
AbstractAsyncMongoCollection.findAsync(LambdaCallback<MongoIterator<Document>> results,
Find.Builder query)
Finds the set of documents matching the query in the collection.
|
Document |
SynchronousMongoCollectionImpl.findOne(Find.Builder query)
Finds a single matching document in the collection.
|
void |
AbstractAsyncMongoCollection.findOneAsync(Callback<Document> results,
Find.Builder query)
Finds a single matching document in the collection.
|
ListenableFuture<Document> |
AbstractAsyncMongoCollection.findOneAsync(Find.Builder query)
Finds a single matching document in the collection.
|
void |
AbstractAsyncMongoCollection.findOneAsync(LambdaCallback<Document> results,
Find.Builder query)
Finds a single matching document in the collection.
|
MongoCursorControl |
AbstractAsyncMongoCollection.stream(LambdaCallback<Document> results,
Find.Builder aggregation)
Finds the set of documents matching the query in the collection and
streams them to the provided callback one at a time.
|
MongoCursorControl |
AbstractAsyncMongoCollection.stream(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 |
AbstractAsyncMongoCollection.streamingFind(StreamCallback<Document> results,
Find.Builder query)
Deprecated.
|
Copyright © 2011–2014 Allanbank Consulting, Inc.. All rights reserved.