public interface MongoClient
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_DB_NAME
The name of the default database
|
static String |
DEFAULT_POOL_NAME
The name of the default pool
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the client and release its resources
|
MongoClient |
count(String collection,
JsonObject query,
Handler<AsyncResult<Long>> resultHandler)
Count matching documents in a collection.
|
MongoClient |
createCollection(String collectionName,
Handler<AsyncResult<Void>> resultHandler)
Create a new collection
|
static MongoClient |
createNonShared(Vertx vertx,
JsonObject config)
Create a Mongo client which maintains its own data source.
|
static MongoClient |
createShared(Vertx vertx,
JsonObject config)
Like
createShared(io.vertx.core.Vertx, JsonObject, String) but with the default data source name |
static MongoClient |
createShared(Vertx vertx,
JsonObject config,
String dataSourceName)
Create a Mongo client which shares its data source with any other Mongo clients created with the same
data source name
|
MongoClient |
dropCollection(String collection,
Handler<AsyncResult<Void>> resultHandler)
Drop a collection
|
MongoClient |
find(String collection,
JsonObject query,
Handler<AsyncResult<List<JsonObject>>> resultHandler)
Find matching documents in the specified collection
|
MongoClient |
findOne(String collection,
JsonObject query,
JsonObject fields,
Handler<AsyncResult<JsonObject>> resultHandler)
Find a single matching document in the specified collection
|
MongoClient |
findWithOptions(String collection,
JsonObject query,
FindOptions options,
Handler<AsyncResult<List<JsonObject>>> resultHandler)
Find matching documents in the specified collection, specifying options
|
MongoClient |
getCollections(Handler<AsyncResult<List<String>>> resultHandler)
Get a list of all collections in the database.
|
MongoClient |
insert(String collection,
JsonObject document,
Handler<AsyncResult<String>> resultHandler)
Insert a document in the specified collection
|
MongoClient |
insertWithOptions(String collection,
JsonObject document,
WriteOption writeOption,
Handler<AsyncResult<String>> resultHandler)
Insert a document in the specified collection with the specified write option
|
MongoClient |
remove(String collection,
JsonObject query,
Handler<AsyncResult<Void>> resultHandler)
Remove matching documents from a collection
|
MongoClient |
removeOne(String collection,
JsonObject query,
Handler<AsyncResult<Void>> resultHandler)
Remove a single matching document from a collection
|
MongoClient |
removeOneWithOptions(String collection,
JsonObject query,
WriteOption writeOption,
Handler<AsyncResult<Void>> resultHandler)
Remove a single matching document from a collection with the specified write option
|
MongoClient |
removeWithOptions(String collection,
JsonObject query,
WriteOption writeOption,
Handler<AsyncResult<Void>> resultHandler)
Remove matching documents from a collection with the specified write option
|
MongoClient |
replace(String collection,
JsonObject query,
JsonObject replace,
Handler<AsyncResult<Void>> resultHandler)
Replace matching documents in the specified collection
|
MongoClient |
replaceWithOptions(String collection,
JsonObject query,
JsonObject replace,
UpdateOptions options,
Handler<AsyncResult<Void>> resultHandler)
Replace matching documents in the specified collection, specifying options
|
MongoClient |
runCommand(String commandName,
JsonObject command,
Handler<AsyncResult<JsonObject>> resultHandler)
Run an arbitrary MongoDB command.
|
MongoClient |
save(String collection,
JsonObject document,
Handler<AsyncResult<String>> resultHandler)
Save a document in the specified collection
|
MongoClient |
saveWithOptions(String collection,
JsonObject document,
WriteOption writeOption,
Handler<AsyncResult<String>> resultHandler)
Save a document in the specified collection with the specified write option
|
MongoClient |
update(String collection,
JsonObject query,
JsonObject update,
Handler<AsyncResult<Void>> resultHandler)
Update matching documents in the specified collection
|
MongoClient |
updateWithOptions(String collection,
JsonObject query,
JsonObject update,
UpdateOptions options,
Handler<AsyncResult<Void>> resultHandler)
Update matching documents in the specified collection, specifying options
|
static final String DEFAULT_POOL_NAME
static final String DEFAULT_DB_NAME
static MongoClient createNonShared(Vertx vertx, JsonObject config)
vertx
- the Vert.x instanceconfig
- the configurationstatic MongoClient createShared(Vertx vertx, JsonObject config, String dataSourceName)
vertx
- the Vert.x instanceconfig
- the configurationdataSourceName
- the data source namestatic MongoClient createShared(Vertx vertx, JsonObject config)
createShared(io.vertx.core.Vertx, JsonObject, String)
but with the default data source namevertx
- the Vert.x instanceconfig
- the configurationMongoClient save(String collection, JsonObject document, Handler<AsyncResult<String>> resultHandler)
collection
- the collectiondocument
- the documentresultHandler
- result handler will be provided with the id if document didn't already have oneMongoClient saveWithOptions(String collection, JsonObject document, WriteOption writeOption, Handler<AsyncResult<String>> resultHandler)
collection
- the collectiondocument
- the documentwriteOption
- the write option to useresultHandler
- result handler will be provided with the id if document didn't already have oneMongoClient insert(String collection, JsonObject document, Handler<AsyncResult<String>> resultHandler)
collection
- the collectiondocument
- the documentresultHandler
- result handler will be provided with the id if document didn't already have oneMongoClient insertWithOptions(String collection, JsonObject document, WriteOption writeOption, Handler<AsyncResult<String>> resultHandler)
collection
- the collectiondocument
- the documentwriteOption
- the write option to useresultHandler
- result handler will be provided with the id if document didn't already have oneMongoClient update(String collection, JsonObject query, JsonObject update, Handler<AsyncResult<Void>> resultHandler)
collection
- the collectionquery
- query used to match the documentsupdate
- used to describe how the documents will be updatedresultHandler
- will be called when completeMongoClient updateWithOptions(String collection, JsonObject query, JsonObject update, UpdateOptions options, Handler<AsyncResult<Void>> resultHandler)
collection
- the collectionquery
- query used to match the documentsupdate
- used to describe how the documents will be updatedoptions
- options to configure the updateresultHandler
- will be called when completeMongoClient replace(String collection, JsonObject query, JsonObject replace, Handler<AsyncResult<Void>> resultHandler)
collection
- the collectionquery
- query used to match the documentsreplace
- all matching documents will be replaced with thisresultHandler
- will be called when completeMongoClient replaceWithOptions(String collection, JsonObject query, JsonObject replace, UpdateOptions options, Handler<AsyncResult<Void>> resultHandler)
collection
- the collectionquery
- query used to match the documentsreplace
- all matching documents will be replaced with thisoptions
- options to configure the replaceresultHandler
- will be called when completeMongoClient find(String collection, JsonObject query, Handler<AsyncResult<List<JsonObject>>> resultHandler)
collection
- the collectionquery
- query used to match documentsresultHandler
- will be provided with list of documentsMongoClient findWithOptions(String collection, JsonObject query, FindOptions options, Handler<AsyncResult<List<JsonObject>>> resultHandler)
collection
- the collectionquery
- query used to match documentsoptions
- options to configure the findresultHandler
- will be provided with list of documentsMongoClient findOne(String collection, JsonObject query, JsonObject fields, Handler<AsyncResult<JsonObject>> resultHandler)
collection
- the collectionquery
- the query used to match the documentfields
- the fieldsresultHandler
- will be provided with the document, if anyMongoClient count(String collection, JsonObject query, Handler<AsyncResult<Long>> resultHandler)
collection
- the collectionquery
- query used to match documentsresultHandler
- will be provided with the number of matching documentsMongoClient remove(String collection, JsonObject query, Handler<AsyncResult<Void>> resultHandler)
collection
- the collectionquery
- query used to match documentsresultHandler
- will be called when completeMongoClient removeWithOptions(String collection, JsonObject query, WriteOption writeOption, Handler<AsyncResult<Void>> resultHandler)
collection
- the collectionquery
- query used to match documentswriteOption
- the write option to useresultHandler
- will be called when completeMongoClient removeOne(String collection, JsonObject query, Handler<AsyncResult<Void>> resultHandler)
collection
- the collectionquery
- query used to match documentresultHandler
- will be called when completeMongoClient removeOneWithOptions(String collection, JsonObject query, WriteOption writeOption, Handler<AsyncResult<Void>> resultHandler)
collection
- the collectionquery
- query used to match documentwriteOption
- the write option to useresultHandler
- will be called when completeMongoClient createCollection(String collectionName, Handler<AsyncResult<Void>> resultHandler)
collectionName
- the name of the collectionresultHandler
- will be called when completeMongoClient getCollections(Handler<AsyncResult<List<String>>> resultHandler)
resultHandler
- will be called with a list of collections.MongoClient dropCollection(String collection, Handler<AsyncResult<Void>> resultHandler)
collection
- the collectionresultHandler
- will be called when completeMongoClient runCommand(String commandName, JsonObject command, Handler<AsyncResult<JsonObject>> resultHandler)
commandName
- the name of the commandcommand
- the commandresultHandler
- will be called with the result.void close()
Copyright © 2015. All Rights Reserved.