io.vertx.ext.mongo

Interface MongoService

All Superinterfaces:

MongoClient

public interface MongoService
extends MongoClient

Author:

Tim Fox

Field Summary

Fields inherited from interface io.vertx.ext.mongo.MongoClient

DEFAULT_DB_NAME, DEFAULT_POOL_NAME

Method Summary

Modifier and Type	Method and Description
MongoService	bulkWrite(String collection, List<BulkOperation> operations, Handler<AsyncResult<MongoClientBulkWriteResult>> resultHandler)
MongoService	bulkWriteWithOptions(String collection, List<BulkOperation> operations, BulkWriteOptions bulkWriteOptions, Handler<AsyncResult<MongoClientBulkWriteResult>> resultHandler)
void	close()
MongoService	count(String collection, JsonObject query, Handler<AsyncResult<Long>> resultHandler)
MongoService	createCollection(String collectionName, Handler<AsyncResult<Void>> resultHandler)
static MongoService	createEventBusProxy(Vertx vertx, String address) Create a proxy to a service that is deployed somewhere on the event bus
MongoService	createIndex(String collection, JsonObject key, Handler<AsyncResult<Void>> resultHandler)
MongoService	createIndexWithOptions(String collection, JsonObject key, IndexOptions options, Handler<AsyncResult<Void>> resultHandler)
MongoService	distinct(String collection, String fieldName, String resultClassname, Handler<AsyncResult<JsonArray>> resultHandler)
default ReadStream<JsonObject>	distinctBatch(String collection, String fieldName, String resultClassname)
default ReadStream<JsonObject>	distinctBatchWithQuery(String collection, String fieldName, String resultClassname, JsonObject query)
default ReadStream<JsonObject>	distinctBatchWithQuery(String collection, String fieldName, String resultClassname, JsonObject query, int batchSize)
MongoService	distinctWithQuery(String collection, String fieldName, String resultClassname, JsonObject query, Handler<AsyncResult<JsonArray>> resultHandler)
MongoService	dropCollection(String collection, Handler<AsyncResult<Void>> resultHandler)
MongoService	dropIndex(String collection, String indexName, Handler<AsyncResult<Void>> resultHandler)
MongoService	find(String collection, JsonObject query, Handler<AsyncResult<List<JsonObject>>> resultHandler)
default ReadStream<JsonObject>	findBatch(String collection, JsonObject query)
default ReadStream<JsonObject>	findBatchWithOptions(String collection, JsonObject query, FindOptions options)
MongoService	findOne(String collection, JsonObject query, JsonObject fields, Handler<AsyncResult<JsonObject>> resultHandler)
MongoService	findOneAndDelete(String collection, JsonObject query, Handler<AsyncResult<JsonObject>> resultHandler)
MongoService	findOneAndDeleteWithOptions(String collection, JsonObject query, FindOptions findOptions, Handler<AsyncResult<JsonObject>> resultHandler)
MongoService	findOneAndReplace(String collection, JsonObject query, JsonObject replace, Handler<AsyncResult<JsonObject>> resultHandler)
MongoService	findOneAndReplaceWithOptions(String collection, JsonObject query, JsonObject update, FindOptions findOptions, UpdateOptions updateOptions, Handler<AsyncResult<JsonObject>> resultHandler)
MongoService	findOneAndUpdate(String collection, JsonObject query, JsonObject update, Handler<AsyncResult<JsonObject>> resultHandler)
MongoService	findOneAndUpdateWithOptions(String collection, JsonObject query, JsonObject update, FindOptions findOptions, UpdateOptions updateOptions, Handler<AsyncResult<JsonObject>> resultHandler)
MongoService	findWithOptions(String collection, JsonObject query, FindOptions options, Handler<AsyncResult<List<JsonObject>>> resultHandler)
MongoService	getCollections(Handler<AsyncResult<List<String>>> resultHandler)
MongoService	insert(String collection, JsonObject document, Handler<AsyncResult<String>> resultHandler)
MongoService	insertWithOptions(String collection, JsonObject document, WriteOption writeOption, Handler<AsyncResult<String>> resultHandler)
MongoService	listIndexes(String collection, Handler<AsyncResult<JsonArray>> resultHandler)
MongoService	remove(String collection, JsonObject query, Handler<AsyncResult<Void>> resultHandler) Deprecated.
MongoService	removeDocument(String collection, JsonObject query, Handler<AsyncResult<MongoClientDeleteResult>> resultHandler)
MongoService	removeDocuments(String collection, JsonObject query, Handler<AsyncResult<MongoClientDeleteResult>> resultHandler)
MongoService	removeDocumentsWithOptions(String collection, JsonObject query, WriteOption writeOption, Handler<AsyncResult<MongoClientDeleteResult>> resultHandler)
MongoService	removeDocumentWithOptions(String collection, JsonObject query, WriteOption writeOption, Handler<AsyncResult<MongoClientDeleteResult>> resultHandler)
MongoService	removeOne(String collection, JsonObject query, Handler<AsyncResult<Void>> resultHandler) Deprecated.
MongoService	removeOneWithOptions(String collection, JsonObject query, WriteOption writeOption, Handler<AsyncResult<Void>> resultHandler) Deprecated.
MongoService	removeWithOptions(String collection, JsonObject query, WriteOption writeOption, Handler<AsyncResult<Void>> resultHandler) Deprecated.
MongoService	replace(String collection, JsonObject query, JsonObject replace, Handler<AsyncResult<Void>> resultHandler) Deprecated.
MongoService	replaceDocuments(String collection, JsonObject query, JsonObject replace, Handler<AsyncResult<MongoClientUpdateResult>> resultHandler)
MongoService	replaceDocumentsWithOptions(String collection, JsonObject query, JsonObject replace, UpdateOptions options, Handler<AsyncResult<MongoClientUpdateResult>> resultHandler)
MongoService	replaceWithOptions(String collection, JsonObject query, JsonObject replace, UpdateOptions options, Handler<AsyncResult<Void>> resultHandler) Deprecated.
MongoService	runCommand(String commandName, JsonObject command, Handler<AsyncResult<JsonObject>> resultHandler)
MongoService	save(String collection, JsonObject document, Handler<AsyncResult<String>> resultHandler)
MongoService	saveWithOptions(String collection, JsonObject document, WriteOption writeOption, Handler<AsyncResult<String>> resultHandler)
MongoService	update(String collection, JsonObject query, JsonObject update, Handler<AsyncResult<Void>> resultHandler) Deprecated.
MongoService	updateCollection(String collection, JsonObject query, JsonObject update, Handler<AsyncResult<MongoClientUpdateResult>> resultHandler)
MongoService	updateCollectionWithOptions(String collection, JsonObject query, JsonObject update, UpdateOptions options, Handler<AsyncResult<MongoClientUpdateResult>> resultHandler)
MongoService	updateWithOptions(String collection, JsonObject query, JsonObject update, UpdateOptions options, Handler<AsyncResult<Void>> resultHandler) Deprecated.

Methods inherited from interface io.vertx.ext.mongo.MongoClient

createNonShared, createShared, createShared

Method Detail

createEventBusProxy

static MongoService createEventBusProxy(Vertx vertx,
                                        String address)

Create a proxy to a service that is deployed somewhere on the event bus

Parameters:

vertx - the Vert.x instance

address - the address the service is listening on on the event bus

Returns:

the service

save

MongoService save(String collection,
                  JsonObject document,
                  Handler<AsyncResult<String>> resultHandler)

Specified by:

save in interface MongoClient

saveWithOptions

MongoService saveWithOptions(String collection,
                             JsonObject document,
                             WriteOption writeOption,
                             Handler<AsyncResult<String>> resultHandler)

Specified by:

saveWithOptions in interface MongoClient

insert

MongoService insert(String collection,
                    JsonObject document,
                    Handler<AsyncResult<String>> resultHandler)

Specified by:

insert in interface MongoClient

insertWithOptions

MongoService insertWithOptions(String collection,
                               JsonObject document,
                               WriteOption writeOption,
                               Handler<AsyncResult<String>> resultHandler)

Specified by:

insertWithOptions in interface MongoClient

update

@Deprecated
MongoService update(String collection,
                                JsonObject query,
                                JsonObject update,
                                Handler<AsyncResult<Void>> resultHandler)

Deprecated.

Specified by:

update in interface MongoClient

updateCollection

MongoService updateCollection(String collection,
                              JsonObject query,
                              JsonObject update,
                              Handler<AsyncResult<MongoClientUpdateResult>> resultHandler)

Specified by:

updateCollection in interface MongoClient

updateWithOptions

@Deprecated
MongoService updateWithOptions(String collection,
                                           JsonObject query,
                                           JsonObject update,
                                           UpdateOptions options,
                                           Handler<AsyncResult<Void>> resultHandler)

Deprecated.

Specified by:

updateWithOptions in interface MongoClient

updateCollectionWithOptions

MongoService updateCollectionWithOptions(String collection,
                                         JsonObject query,
                                         JsonObject update,
                                         UpdateOptions options,
                                         Handler<AsyncResult<MongoClientUpdateResult>> resultHandler)

Specified by:

updateCollectionWithOptions in interface MongoClient

replace

@Deprecated
MongoService replace(String collection,
                                 JsonObject query,
                                 JsonObject replace,
                                 Handler<AsyncResult<Void>> resultHandler)

Deprecated.

Specified by:

replace in interface MongoClient

replaceDocuments

MongoService replaceDocuments(String collection,
                              JsonObject query,
                              JsonObject replace,
                              Handler<AsyncResult<MongoClientUpdateResult>> resultHandler)

Specified by:

replaceDocuments in interface MongoClient

replaceWithOptions

@Deprecated
MongoService replaceWithOptions(String collection,
                                            JsonObject query,
                                            JsonObject replace,
                                            UpdateOptions options,
                                            Handler<AsyncResult<Void>> resultHandler)

Deprecated.

Specified by:

replaceWithOptions in interface MongoClient

replaceDocumentsWithOptions

MongoService replaceDocumentsWithOptions(String collection,
                                         JsonObject query,
                                         JsonObject replace,
                                         UpdateOptions options,
                                         Handler<AsyncResult<MongoClientUpdateResult>> resultHandler)

Specified by:

replaceDocumentsWithOptions in interface MongoClient

bulkWrite

MongoService bulkWrite(String collection,
                       List<BulkOperation> operations,
                       Handler<AsyncResult<MongoClientBulkWriteResult>> resultHandler)

Specified by:

bulkWrite in interface MongoClient

bulkWriteWithOptions

MongoService bulkWriteWithOptions(String collection,
                                  List<BulkOperation> operations,
                                  BulkWriteOptions bulkWriteOptions,
                                  Handler<AsyncResult<MongoClientBulkWriteResult>> resultHandler)

Specified by:

bulkWriteWithOptions in interface MongoClient

find

MongoService find(String collection,
                  JsonObject query,
                  Handler<AsyncResult<List<JsonObject>>> resultHandler)

Specified by:

find in interface MongoClient

findBatch

default ReadStream<JsonObject> findBatch(String collection,
                                         JsonObject query)

Specified by:

findBatch in interface MongoClient

findWithOptions

MongoService findWithOptions(String collection,
                             JsonObject query,
                             FindOptions options,
                             Handler<AsyncResult<List<JsonObject>>> resultHandler)

Specified by:

findWithOptions in interface MongoClient

findBatchWithOptions

default ReadStream<JsonObject> findBatchWithOptions(String collection,
                                                    JsonObject query,
                                                    FindOptions options)

Specified by:

findBatchWithOptions in interface MongoClient

findOne

MongoService findOne(String collection,
                     JsonObject query,
                     JsonObject fields,
                     Handler<AsyncResult<JsonObject>> resultHandler)

Specified by:

findOne in interface MongoClient

findOneAndUpdate

MongoService findOneAndUpdate(String collection,
                              JsonObject query,
                              JsonObject update,
                              Handler<AsyncResult<JsonObject>> resultHandler)

Specified by:

findOneAndUpdate in interface MongoClient

findOneAndUpdateWithOptions

MongoService findOneAndUpdateWithOptions(String collection,
                                         JsonObject query,
                                         JsonObject update,
                                         FindOptions findOptions,
                                         UpdateOptions updateOptions,
                                         Handler<AsyncResult<JsonObject>> resultHandler)

Specified by:

findOneAndUpdateWithOptions in interface MongoClient

findOneAndReplace

MongoService findOneAndReplace(String collection,
                               JsonObject query,
                               JsonObject replace,
                               Handler<AsyncResult<JsonObject>> resultHandler)

Specified by:

findOneAndReplace in interface MongoClient

findOneAndReplaceWithOptions

MongoService findOneAndReplaceWithOptions(String collection,
                                          JsonObject query,
                                          JsonObject update,
                                          FindOptions findOptions,
                                          UpdateOptions updateOptions,
                                          Handler<AsyncResult<JsonObject>> resultHandler)

Specified by:

findOneAndReplaceWithOptions in interface MongoClient

findOneAndDelete

MongoService findOneAndDelete(String collection,
                              JsonObject query,
                              Handler<AsyncResult<JsonObject>> resultHandler)

Specified by:

findOneAndDelete in interface MongoClient

findOneAndDeleteWithOptions

MongoService findOneAndDeleteWithOptions(String collection,
                                         JsonObject query,
                                         FindOptions findOptions,
                                         Handler<AsyncResult<JsonObject>> resultHandler)

Specified by:

findOneAndDeleteWithOptions in interface MongoClient

count

MongoService count(String collection,
                   JsonObject query,
                   Handler<AsyncResult<Long>> resultHandler)

Specified by:

count in interface MongoClient

remove

@Deprecated
MongoService remove(String collection,
                                JsonObject query,
                                Handler<AsyncResult<Void>> resultHandler)

Deprecated.

Specified by:

remove in interface MongoClient

removeDocuments

MongoService removeDocuments(String collection,
                             JsonObject query,
                             Handler<AsyncResult<MongoClientDeleteResult>> resultHandler)

Specified by:

removeDocuments in interface MongoClient

removeWithOptions

@Deprecated
MongoService removeWithOptions(String collection,
                                           JsonObject query,
                                           WriteOption writeOption,
                                           Handler<AsyncResult<Void>> resultHandler)

Deprecated.

Specified by:

removeWithOptions in interface MongoClient

removeDocumentsWithOptions

MongoService removeDocumentsWithOptions(String collection,
                                        JsonObject query,
                                        WriteOption writeOption,
                                        Handler<AsyncResult<MongoClientDeleteResult>> resultHandler)

Specified by:

removeDocumentsWithOptions in interface MongoClient

removeOne

@Deprecated
MongoService removeOne(String collection,
                                   JsonObject query,
                                   Handler<AsyncResult<Void>> resultHandler)

Deprecated.

Specified by:

removeOne in interface MongoClient

removeDocument

MongoService removeDocument(String collection,
                            JsonObject query,
                            Handler<AsyncResult<MongoClientDeleteResult>> resultHandler)

Specified by:

removeDocument in interface MongoClient

removeOneWithOptions

@Deprecated
MongoService removeOneWithOptions(String collection,
                                              JsonObject query,
                                              WriteOption writeOption,
                                              Handler<AsyncResult<Void>> resultHandler)

Deprecated.

Specified by:

removeOneWithOptions in interface MongoClient

removeDocumentWithOptions

MongoService removeDocumentWithOptions(String collection,
                                       JsonObject query,
                                       WriteOption writeOption,
                                       Handler<AsyncResult<MongoClientDeleteResult>> resultHandler)

Specified by:

removeDocumentWithOptions in interface MongoClient

createCollection

MongoService createCollection(String collectionName,
                              Handler<AsyncResult<Void>> resultHandler)

Specified by:

createCollection in interface MongoClient

getCollections

MongoService getCollections(Handler<AsyncResult<List<String>>> resultHandler)

Specified by:

getCollections in interface MongoClient

dropCollection

MongoService dropCollection(String collection,
                            Handler<AsyncResult<Void>> resultHandler)

Specified by:

dropCollection in interface MongoClient

createIndex

MongoService createIndex(String collection,
                         JsonObject key,
                         Handler<AsyncResult<Void>> resultHandler)

Specified by:

createIndex in interface MongoClient

createIndexWithOptions

MongoService createIndexWithOptions(String collection,
                                    JsonObject key,
                                    IndexOptions options,
                                    Handler<AsyncResult<Void>> resultHandler)

Specified by:

createIndexWithOptions in interface MongoClient

listIndexes

MongoService listIndexes(String collection,
                         Handler<AsyncResult<JsonArray>> resultHandler)

Specified by:

listIndexes in interface MongoClient

dropIndex

MongoService dropIndex(String collection,
                       String indexName,
                       Handler<AsyncResult<Void>> resultHandler)

Specified by:

dropIndex in interface MongoClient

runCommand

MongoService runCommand(String commandName,
                        JsonObject command,
                        Handler<AsyncResult<JsonObject>> resultHandler)

Specified by:

runCommand in interface MongoClient

distinct

MongoService distinct(String collection,
                      String fieldName,
                      String resultClassname,
                      Handler<AsyncResult<JsonArray>> resultHandler)

Specified by:

distinct in interface MongoClient

distinctBatch

default ReadStream<JsonObject> distinctBatch(String collection,
                                             String fieldName,
                                             String resultClassname)

Specified by:

distinctBatch in interface MongoClient

distinctWithQuery

MongoService distinctWithQuery(String collection,
                               String fieldName,
                               String resultClassname,
                               JsonObject query,
                               Handler<AsyncResult<JsonArray>> resultHandler)

Specified by:

distinctWithQuery in interface MongoClient

distinctBatchWithQuery

default ReadStream<JsonObject> distinctBatchWithQuery(String collection,
                                                      String fieldName,
                                                      String resultClassname,
                                                      JsonObject query)

Specified by:

distinctBatchWithQuery in interface MongoClient

distinctBatchWithQuery

default ReadStream<JsonObject> distinctBatchWithQuery(String collection,
                                                      String fieldName,
                                                      String resultClassname,
                                                      JsonObject query,
                                                      int batchSize)

Specified by:

distinctBatchWithQuery in interface MongoClient

close

void close()

Specified by:

close in interface MongoClient