io.vertx.rxjava3.ext.mongo

Class MongoClient

java.lang.Object

io.vertx.rxjava3.ext.mongo.MongoClient

public class MongoClient
extends Object

A Vert.x service used to interact with MongoDB server instances.

Some of the operations might change _id field of passed document.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.rx.TypeArg<MongoClient>	__TYPE_ARG
static String	DEFAULT_DB_NAME The name of the default database
static String	DEFAULT_POOL_NAME The name of the default pool

Constructor Summary

Constructors

Constructor and Description
MongoClient(MongoClient delegate)
MongoClient(Object delegate)

Method Summary

Modifier and Type	Method and Description
ReadStream<JsonObject>	aggregate(String collection, JsonArray pipeline) Run aggregate MongoDB command with default AggregateOptions.
ReadStream<JsonObject>	aggregateWithOptions(String collection, JsonArray pipeline, AggregateOptions options) Run aggregate MongoDB command.
Maybe<MongoClientBulkWriteResult>	bulkWrite(String collection, List<BulkOperation> operations) Execute a bulk operation.
Maybe<MongoClientBulkWriteResult>	bulkWriteWithOptions(String collection, List<BulkOperation> operations, BulkWriteOptions bulkWriteOptions) Execute a bulk operation with the specified write options.
Completable	close() Close the client and release its resources
Single<Long>	count(String collection, JsonObject query) Count matching documents in a collection.
Single<Long>	countWithOptions(String collection, JsonObject query, CountOptions countOptions) Count matching documents in a collection.
static MongoClient	create(Vertx vertx, JsonObject config) Create a Mongo client which maintains its own data source.
Completable	createCollection(String collectionName) Create a new collection
Completable	createCollectionWithOptions(String collectionName, CreateCollectionOptions collectionOptions) Create a new collection with options
Single<MongoGridFsClient>	createDefaultGridFsBucketService() Creates a MongoGridFsClient used to interact with Mongo GridFS.
Single<MongoGridFsClient>	createGridFsBucketService(String bucketName) Creates a MongoGridFsClient used to interact with Mongo GridFS.
Completable	createIndex(String collection, JsonObject key) Creates an index.
Completable	createIndexes(String collection, List<IndexModel> indexes) creates an indexes
Completable	createIndexWithOptions(String collection, JsonObject key, IndexOptions options) Creates an index.
static MongoClient	createShared(Vertx vertx, JsonObject config) Like createShared(io.vertx.rxjava3.core.Vertx, io.vertx.core.json.JsonObject, java.lang.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
Single<JsonArray>	distinct(String collection, String fieldName, String resultClassname) Gets the distinct values of the specified field name.
Single<JsonArray>	distinct(String collection, String fieldName, String resultClassname, DistinctOptions distinctOptions) Gets the distinct values of the specified field name.
ReadStream<JsonObject>	distinctBatch(String collection, String fieldName, String resultClassname) Gets the distinct values of the specified field name.
ReadStream<JsonObject>	distinctBatch(String collection, String fieldName, String resultClassname, DistinctOptions distinctOptions) Gets the distinct values of the specified field name.
ReadStream<JsonObject>	distinctBatchWithQuery(String collection, String fieldName, String resultClassname, JsonObject query) Gets the distinct values of the specified field name filtered by specified query.
ReadStream<JsonObject>	distinctBatchWithQuery(String collection, String fieldName, String resultClassname, JsonObject query, DistinctOptions distinctOptions) Gets the distinct values of the specified field name filtered by specified query.
ReadStream<JsonObject>	distinctBatchWithQuery(String collection, String fieldName, String resultClassname, JsonObject query, int batchSize) Gets the distinct values of the specified field name filtered by specified query.
ReadStream<JsonObject>	distinctBatchWithQuery(String collection, String fieldName, String resultClassname, JsonObject query, int batchSize, DistinctOptions distinctOptions) Gets the distinct values of the specified field name filtered by specified query.
Single<JsonArray>	distinctWithQuery(String collection, String fieldName, String resultClassname, JsonObject query) Gets the distinct values of the specified field name filtered by specified query.
Single<JsonArray>	distinctWithQuery(String collection, String fieldName, String resultClassname, JsonObject query, DistinctOptions distinctOptions) Gets the distinct values of the specified field name filtered by specified query.
Completable	dropCollection(String collection) Drop a collection
Completable	dropIndex(String collection, String indexName) Drops the index given its name.
boolean	equals(Object o)
Single<List<JsonObject>>	find(String collection, JsonObject query) Find matching documents in the specified collection
ReadStream<JsonObject>	findBatch(String collection, JsonObject query) Find matching documents in the specified collection.
ReadStream<JsonObject>	findBatchWithOptions(String collection, JsonObject query, FindOptions options) Find matching documents in the specified collection, specifying options.
Maybe<JsonObject>	findOne(String collection, JsonObject query, JsonObject fields) Find a single matching document in the specified collection
Maybe<JsonObject>	findOneAndDelete(String collection, JsonObject query) Find a single matching document in the specified collection and delete it.
Maybe<JsonObject>	findOneAndDeleteWithOptions(String collection, JsonObject query, FindOptions findOptions) Find a single matching document in the specified collection and delete it.
Maybe<JsonObject>	findOneAndReplace(String collection, JsonObject query, JsonObject replace) Find a single matching document in the specified collection and replace it.
Maybe<JsonObject>	findOneAndReplaceWithOptions(String collection, JsonObject query, JsonObject replace, FindOptions findOptions, UpdateOptions updateOptions) Find a single matching document in the specified collection and replace it.
Maybe<JsonObject>	findOneAndUpdate(String collection, JsonObject query, JsonObject update) Find a single matching document in the specified collection and update it.
Maybe<JsonObject>	findOneAndUpdateWithOptions(String collection, JsonObject query, JsonObject update, FindOptions findOptions, UpdateOptions updateOptions) Find a single matching document in the specified collection and update it.
Single<List<JsonObject>>	findWithOptions(String collection, JsonObject query, FindOptions options) Find matching documents in the specified collection, specifying options
Single<List<String>>	getCollections() Get a list of all collections in the database.
MongoClient	getDelegate()
int	hashCode()
Maybe<String>	insert(String collection, JsonObject document) Insert a document in the specified collection
Maybe<String>	insertWithOptions(String collection, JsonObject document, WriteOption writeOption) Insert a document in the specified collection with the specified write option
Single<JsonArray>	listIndexes(String collection) Get all the indexes in this collection.
static MongoClient	newInstance(MongoClient arg)
Maybe<MongoClientDeleteResult>	removeDocument(String collection, JsonObject query) Remove a single matching document from a collection and return the handler with MongoClientDeleteResult result
Maybe<MongoClientDeleteResult>	removeDocuments(String collection, JsonObject query) Remove matching documents from a collection and return the handler with MongoClientDeleteResult result
Maybe<MongoClientDeleteResult>	removeDocumentsWithOptions(String collection, JsonObject query, WriteOption writeOption) Remove matching documents from a collection with the specified write option and return the handler with MongoClientDeleteResult result
Maybe<MongoClientDeleteResult>	removeDocumentWithOptions(String collection, JsonObject query, WriteOption writeOption) Remove a single matching document from a collection with the specified write option and return the handler with MongoClientDeleteResult result
Maybe<MongoClientUpdateResult>	replaceDocuments(String collection, JsonObject query, JsonObject replace) Replace matching documents in the specified collection and return the handler with MongoClientUpdateResult result
Maybe<MongoClientUpdateResult>	replaceDocumentsWithOptions(String collection, JsonObject query, JsonObject replace, UpdateOptions options) Replace matching documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result
Maybe<JsonObject>	runCommand(String commandName, JsonObject command) Run an arbitrary MongoDB command.
Maybe<MongoClientBulkWriteResult>	rxBulkWrite(String collection, List<BulkOperation> operations) Execute a bulk operation.
Maybe<MongoClientBulkWriteResult>	rxBulkWriteWithOptions(String collection, List<BulkOperation> operations, BulkWriteOptions bulkWriteOptions) Execute a bulk operation with the specified write options.
Completable	rxClose() Close the client and release its resources
Single<Long>	rxCount(String collection, JsonObject query) Count matching documents in a collection.
Single<Long>	rxCountWithOptions(String collection, JsonObject query, CountOptions countOptions) Count matching documents in a collection.
Completable	rxCreateCollection(String collectionName) Create a new collection
Completable	rxCreateCollectionWithOptions(String collectionName, CreateCollectionOptions collectionOptions) Create a new collection with options
Single<MongoGridFsClient>	rxCreateDefaultGridFsBucketService() Creates a MongoGridFsClient used to interact with Mongo GridFS.
Single<MongoGridFsClient>	rxCreateGridFsBucketService(String bucketName) Creates a MongoGridFsClient used to interact with Mongo GridFS.
Completable	rxCreateIndex(String collection, JsonObject key) Creates an index.
Completable	rxCreateIndexes(String collection, List<IndexModel> indexes) creates an indexes
Completable	rxCreateIndexWithOptions(String collection, JsonObject key, IndexOptions options) Creates an index.
Single<JsonArray>	rxDistinct(String collection, String fieldName, String resultClassname) Gets the distinct values of the specified field name.
Single<JsonArray>	rxDistinct(String collection, String fieldName, String resultClassname, DistinctOptions distinctOptions) Gets the distinct values of the specified field name.
Single<JsonArray>	rxDistinctWithQuery(String collection, String fieldName, String resultClassname, JsonObject query) Gets the distinct values of the specified field name filtered by specified query.
Single<JsonArray>	rxDistinctWithQuery(String collection, String fieldName, String resultClassname, JsonObject query, DistinctOptions distinctOptions) Gets the distinct values of the specified field name filtered by specified query.
Completable	rxDropCollection(String collection) Drop a collection
Completable	rxDropIndex(String collection, String indexName) Drops the index given its name.
Single<List<JsonObject>>	rxFind(String collection, JsonObject query) Find matching documents in the specified collection
Maybe<JsonObject>	rxFindOne(String collection, JsonObject query, JsonObject fields) Find a single matching document in the specified collection
Maybe<JsonObject>	rxFindOneAndDelete(String collection, JsonObject query) Find a single matching document in the specified collection and delete it.
Maybe<JsonObject>	rxFindOneAndDeleteWithOptions(String collection, JsonObject query, FindOptions findOptions) Find a single matching document in the specified collection and delete it.
Maybe<JsonObject>	rxFindOneAndReplace(String collection, JsonObject query, JsonObject replace) Find a single matching document in the specified collection and replace it.
Maybe<JsonObject>	rxFindOneAndReplaceWithOptions(String collection, JsonObject query, JsonObject replace, FindOptions findOptions, UpdateOptions updateOptions) Find a single matching document in the specified collection and replace it.
Maybe<JsonObject>	rxFindOneAndUpdate(String collection, JsonObject query, JsonObject update) Find a single matching document in the specified collection and update it.
Maybe<JsonObject>	rxFindOneAndUpdateWithOptions(String collection, JsonObject query, JsonObject update, FindOptions findOptions, UpdateOptions updateOptions) Find a single matching document in the specified collection and update it.
Single<List<JsonObject>>	rxFindWithOptions(String collection, JsonObject query, FindOptions options) Find matching documents in the specified collection, specifying options
Single<List<String>>	rxGetCollections() Get a list of all collections in the database.
Maybe<String>	rxInsert(String collection, JsonObject document) Insert a document in the specified collection
Maybe<String>	rxInsertWithOptions(String collection, JsonObject document, WriteOption writeOption) Insert a document in the specified collection with the specified write option
Single<JsonArray>	rxListIndexes(String collection) Get all the indexes in this collection.
Maybe<MongoClientDeleteResult>	rxRemoveDocument(String collection, JsonObject query) Remove a single matching document from a collection and return the handler with MongoClientDeleteResult result
Maybe<MongoClientDeleteResult>	rxRemoveDocuments(String collection, JsonObject query) Remove matching documents from a collection and return the handler with MongoClientDeleteResult result
Maybe<MongoClientDeleteResult>	rxRemoveDocumentsWithOptions(String collection, JsonObject query, WriteOption writeOption) Remove matching documents from a collection with the specified write option and return the handler with MongoClientDeleteResult result
Maybe<MongoClientDeleteResult>	rxRemoveDocumentWithOptions(String collection, JsonObject query, WriteOption writeOption) Remove a single matching document from a collection with the specified write option and return the handler with MongoClientDeleteResult result
Maybe<MongoClientUpdateResult>	rxReplaceDocuments(String collection, JsonObject query, JsonObject replace) Replace matching documents in the specified collection and return the handler with MongoClientUpdateResult result
Maybe<MongoClientUpdateResult>	rxReplaceDocumentsWithOptions(String collection, JsonObject query, JsonObject replace, UpdateOptions options) Replace matching documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result
Maybe<JsonObject>	rxRunCommand(String commandName, JsonObject command) Run an arbitrary MongoDB command.
Maybe<String>	rxSave(String collection, JsonObject document) Save a document in the specified collection
Maybe<String>	rxSaveWithOptions(String collection, JsonObject document, WriteOption writeOption) Save a document in the specified collection with the specified write option
Maybe<MongoClientUpdateResult>	rxUpdateCollection(String collection, JsonObject query, JsonArray update) Use an aggregation pipeline to update documents in the specified collection and return the handler with MongoClientUpdateResult result
Maybe<MongoClientUpdateResult>	rxUpdateCollection(String collection, JsonObject query, JsonObject update) Update matching documents in the specified collection and return the handler with MongoClientUpdateResult result
Maybe<MongoClientUpdateResult>	rxUpdateCollectionWithOptions(String collection, JsonObject query, JsonArray update, UpdateOptions options) Use an aggregation pipeline to update documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result
Maybe<MongoClientUpdateResult>	rxUpdateCollectionWithOptions(String collection, JsonObject query, JsonObject update, UpdateOptions options) Update matching documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result
Maybe<String>	save(String collection, JsonObject document) Save a document in the specified collection
Maybe<String>	saveWithOptions(String collection, JsonObject document, WriteOption writeOption) Save a document in the specified collection with the specified write option
String	toString()
Maybe<MongoClientUpdateResult>	updateCollection(String collection, JsonObject query, JsonArray update) Use an aggregation pipeline to update documents in the specified collection and return the handler with MongoClientUpdateResult result
Maybe<MongoClientUpdateResult>	updateCollection(String collection, JsonObject query, JsonObject update) Update matching documents in the specified collection and return the handler with MongoClientUpdateResult result
Maybe<MongoClientUpdateResult>	updateCollectionWithOptions(String collection, JsonObject query, JsonArray update, UpdateOptions options) Use an aggregation pipeline to update documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result
Maybe<MongoClientUpdateResult>	updateCollectionWithOptions(String collection, JsonObject query, JsonObject update, UpdateOptions options) Update matching documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result
ReadStream<com.mongodb.client.model.changestream.ChangeStreamDocument<JsonObject>>	watch(String collection, JsonArray pipeline, boolean withUpdatedDoc, int batchSize) Watch the collection change.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<MongoClient> __TYPE_ARG

DEFAULT_POOL_NAME

public static final String DEFAULT_POOL_NAME

The name of the default pool

See Also:

Constant Field Values

DEFAULT_DB_NAME

public static final String DEFAULT_DB_NAME

The name of the default database

See Also:

Constant Field Values

Constructor Detail

MongoClient

public MongoClient(MongoClient delegate)

MongoClient

public MongoClient(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public MongoClient getDelegate()

create

public static MongoClient create(Vertx vertx,
                                 JsonObject config)

Create a Mongo client which maintains its own data source.

Parameters:

vertx - the Vert.x instance

config - the configuration

Returns:

the client

createShared

public 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

Parameters:

vertx - the Vert.x instance

config - the configuration

dataSourceName - the data source name

Returns:

the client

createShared

public static MongoClient createShared(Vertx vertx,
                                       JsonObject config)

Like createShared(io.vertx.rxjava3.core.Vertx, io.vertx.core.json.JsonObject, java.lang.String) but with the default data source name

Parameters:

vertx - the Vert.x instance

config - the configuration

Returns:

the client

save

public Maybe<String> save(String collection,
                          JsonObject document)

Save a document in the specified collection

This operation might change _id field of document parameter

Parameters:

collection - the collection

document - the document

Returns:

rxSave

public Maybe<String> rxSave(String collection,
                            JsonObject document)

Save a document in the specified collection

This operation might change _id field of document parameter

Parameters:

collection - the collection

document - the document

Returns:

saveWithOptions

public Maybe<String> saveWithOptions(String collection,
                                     JsonObject document,
                                     WriteOption writeOption)

Save a document in the specified collection with the specified write option

This operation might change _id field of document parameter

Parameters:

collection - the collection

document - the document

writeOption - the write option to use

Returns:

rxSaveWithOptions

public Maybe<String> rxSaveWithOptions(String collection,
                                       JsonObject document,
                                       WriteOption writeOption)

Save a document in the specified collection with the specified write option

This operation might change _id field of document parameter

Parameters:

collection - the collection

document - the document

writeOption - the write option to use

Returns:

insert

public Maybe<String> insert(String collection,
                            JsonObject document)

Insert a document in the specified collection

This operation might change _id field of document parameter

Parameters:

collection - the collection

document - the document

Returns:

rxInsert

public Maybe<String> rxInsert(String collection,
                              JsonObject document)

Insert a document in the specified collection

This operation might change _id field of document parameter

Parameters:

collection - the collection

document - the document

Returns:

insertWithOptions

public Maybe<String> insertWithOptions(String collection,
                                       JsonObject document,
                                       WriteOption writeOption)

Insert a document in the specified collection with the specified write option

This operation might change _id field of document parameter

Parameters:

collection - the collection

document - the document

writeOption - the write option to use

Returns:

rxInsertWithOptions

public Maybe<String> rxInsertWithOptions(String collection,
                                         JsonObject document,
                                         WriteOption writeOption)

Insert a document in the specified collection with the specified write option

This operation might change _id field of document parameter

Parameters:

collection - the collection

document - the document

writeOption - the write option to use

Returns:

updateCollection

public Maybe<MongoClientUpdateResult> updateCollection(String collection,
                                                       JsonObject query,
                                                       JsonObject update)

Update matching documents in the specified collection and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

update - used to describe how the documents will be updated

Returns:

rxUpdateCollection

public Maybe<MongoClientUpdateResult> rxUpdateCollection(String collection,
                                                         JsonObject query,
                                                         JsonObject update)

Update matching documents in the specified collection and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

update - used to describe how the documents will be updated

Returns:

updateCollection

public Maybe<MongoClientUpdateResult> updateCollection(String collection,
                                                       JsonObject query,
                                                       JsonArray update)

Use an aggregation pipeline to update documents in the specified collection and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

update - used to describe how the documents will be updated

Returns:

rxUpdateCollection

public Maybe<MongoClientUpdateResult> rxUpdateCollection(String collection,
                                                         JsonObject query,
                                                         JsonArray update)

Use an aggregation pipeline to update documents in the specified collection and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

update - used to describe how the documents will be updated

Returns:

updateCollectionWithOptions

public Maybe<MongoClientUpdateResult> updateCollectionWithOptions(String collection,
                                                                  JsonObject query,
                                                                  JsonObject update,
                                                                  UpdateOptions options)

Update matching documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

update - used to describe how the documents will be updated

options - options to configure the update

Returns:

rxUpdateCollectionWithOptions

public Maybe<MongoClientUpdateResult> rxUpdateCollectionWithOptions(String collection,
                                                                    JsonObject query,
                                                                    JsonObject update,
                                                                    UpdateOptions options)

Update matching documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

update - used to describe how the documents will be updated

options - options to configure the update

Returns:

updateCollectionWithOptions

public Maybe<MongoClientUpdateResult> updateCollectionWithOptions(String collection,
                                                                  JsonObject query,
                                                                  JsonArray update,
                                                                  UpdateOptions options)

Use an aggregation pipeline to update documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

update - aggregation pipeline used to describe how documents will be updated

options - options to configure the update

Returns:

rxUpdateCollectionWithOptions

public Maybe<MongoClientUpdateResult> rxUpdateCollectionWithOptions(String collection,
                                                                    JsonObject query,
                                                                    JsonArray update,
                                                                    UpdateOptions options)

Use an aggregation pipeline to update documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

update - aggregation pipeline used to describe how documents will be updated

options - options to configure the update

Returns:

replaceDocuments

public Maybe<MongoClientUpdateResult> replaceDocuments(String collection,
                                                       JsonObject query,
                                                       JsonObject replace)

Replace matching documents in the specified collection and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

replace - all matching documents will be replaced with this

Returns:

rxReplaceDocuments

public Maybe<MongoClientUpdateResult> rxReplaceDocuments(String collection,
                                                         JsonObject query,
                                                         JsonObject replace)

Replace matching documents in the specified collection and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

replace - all matching documents will be replaced with this

Returns:

replaceDocumentsWithOptions

public Maybe<MongoClientUpdateResult> replaceDocumentsWithOptions(String collection,
                                                                  JsonObject query,
                                                                  JsonObject replace,
                                                                  UpdateOptions options)

Replace matching documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

replace - all matching documents will be replaced with this

options - options to configure the replace

Returns:

rxReplaceDocumentsWithOptions

public Maybe<MongoClientUpdateResult> rxReplaceDocumentsWithOptions(String collection,
                                                                    JsonObject query,
                                                                    JsonObject replace,
                                                                    UpdateOptions options)

Replace matching documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result

Parameters:

collection - the collection

query - query used to match the documents

replace - all matching documents will be replaced with this

options - options to configure the replace

Returns:

bulkWrite

public Maybe<MongoClientBulkWriteResult> bulkWrite(String collection,
                                                   List<BulkOperation> operations)

Execute a bulk operation. Can insert, update, replace, and/or delete multiple documents with one request.

Parameters:

collection - the collection

operations - the operations to execute

Returns:

rxBulkWrite

public Maybe<MongoClientBulkWriteResult> rxBulkWrite(String collection,
                                                     List<BulkOperation> operations)

Execute a bulk operation. Can insert, update, replace, and/or delete multiple documents with one request.

Parameters:

collection - the collection

operations - the operations to execute

Returns:

bulkWriteWithOptions

public Maybe<MongoClientBulkWriteResult> bulkWriteWithOptions(String collection,
                                                              List<BulkOperation> operations,
                                                              BulkWriteOptions bulkWriteOptions)

Execute a bulk operation with the specified write options. Can insert, update, replace, and/or delete multiple documents with one request.

Parameters:

collection - the collection

operations - the operations to execute

bulkWriteOptions - the write options

Returns:

rxBulkWriteWithOptions

public Maybe<MongoClientBulkWriteResult> rxBulkWriteWithOptions(String collection,
                                                                List<BulkOperation> operations,
                                                                BulkWriteOptions bulkWriteOptions)

Execute a bulk operation with the specified write options. Can insert, update, replace, and/or delete multiple documents with one request.

Parameters:

collection - the collection

operations - the operations to execute

bulkWriteOptions - the write options

Returns:

find

public Single<List<JsonObject>> find(String collection,
                                     JsonObject query)

Find matching documents in the specified collection

Parameters:

collection - the collection

query - query used to match documents

Returns:

rxFind

public Single<List<JsonObject>> rxFind(String collection,
                                       JsonObject query)

Find matching documents in the specified collection

Parameters:

collection - the collection

query - query used to match documents

Returns:

findBatch

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

Find matching documents in the specified collection. This method use batchCursor for returning each found document.

Parameters:

collection - the collection

query - query used to match documents

Returns:

a emitting found documents

findWithOptions

public Single<List<JsonObject>> findWithOptions(String collection,
                                                JsonObject query,
                                                FindOptions options)

Find matching documents in the specified collection, specifying options

Parameters:

collection - the collection

query - query used to match documents

options - options to configure the find

Returns:

rxFindWithOptions

public Single<List<JsonObject>> rxFindWithOptions(String collection,
                                                  JsonObject query,
                                                  FindOptions options)

Find matching documents in the specified collection, specifying options

Parameters:

collection - the collection

query - query used to match documents

options - options to configure the find

Returns:

findBatchWithOptions

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

Find matching documents in the specified collection, specifying options. This method use batchCursor for returning each found document.

Parameters:

collection - the collection

query - query used to match documents

options - options to configure the find

Returns:

a emitting found documents

findOne

public Maybe<JsonObject> findOne(String collection,
                                 JsonObject query,
                                 JsonObject fields)

Find a single matching document in the specified collection

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

fields - the fields

Returns:

rxFindOne

public Maybe<JsonObject> rxFindOne(String collection,
                                   JsonObject query,
                                   JsonObject fields)

Find a single matching document in the specified collection

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

fields - the fields

Returns:

findOneAndUpdate

public Maybe<JsonObject> findOneAndUpdate(String collection,
                                          JsonObject query,
                                          JsonObject update)

Find a single matching document in the specified collection and update it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

update - used to describe how the documents will be updated

Returns:

rxFindOneAndUpdate

public Maybe<JsonObject> rxFindOneAndUpdate(String collection,
                                            JsonObject query,
                                            JsonObject update)

Find a single matching document in the specified collection and update it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

update - used to describe how the documents will be updated

Returns:

findOneAndUpdateWithOptions

public Maybe<JsonObject> findOneAndUpdateWithOptions(String collection,
                                                     JsonObject query,
                                                     JsonObject update,
                                                     FindOptions findOptions,
                                                     UpdateOptions updateOptions)

Find a single matching document in the specified collection and update it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

update - used to describe how the documents will be updated

findOptions - options to configure the find

updateOptions - options to configure the update

Returns:

rxFindOneAndUpdateWithOptions

public Maybe<JsonObject> rxFindOneAndUpdateWithOptions(String collection,
                                                       JsonObject query,
                                                       JsonObject update,
                                                       FindOptions findOptions,
                                                       UpdateOptions updateOptions)

Find a single matching document in the specified collection and update it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

update - used to describe how the documents will be updated

findOptions - options to configure the find

updateOptions - options to configure the update

Returns:

findOneAndReplace

public Maybe<JsonObject> findOneAndReplace(String collection,
                                           JsonObject query,
                                           JsonObject replace)

Find a single matching document in the specified collection and replace it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

replace - the replacement document

Returns:

rxFindOneAndReplace

public Maybe<JsonObject> rxFindOneAndReplace(String collection,
                                             JsonObject query,
                                             JsonObject replace)

Find a single matching document in the specified collection and replace it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

replace - the replacement document

Returns:

findOneAndReplaceWithOptions

public Maybe<JsonObject> findOneAndReplaceWithOptions(String collection,
                                                      JsonObject query,
                                                      JsonObject replace,
                                                      FindOptions findOptions,
                                                      UpdateOptions updateOptions)

Find a single matching document in the specified collection and replace it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

replace - the replacement document

findOptions - options to configure the find

updateOptions - options to configure the update

Returns:

rxFindOneAndReplaceWithOptions

public Maybe<JsonObject> rxFindOneAndReplaceWithOptions(String collection,
                                                        JsonObject query,
                                                        JsonObject replace,
                                                        FindOptions findOptions,
                                                        UpdateOptions updateOptions)

Find a single matching document in the specified collection and replace it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

replace - the replacement document

findOptions - options to configure the find

updateOptions - options to configure the update

Returns:

findOneAndDelete

public Maybe<JsonObject> findOneAndDelete(String collection,
                                          JsonObject query)

Find a single matching document in the specified collection and delete it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

Returns:

rxFindOneAndDelete

public Maybe<JsonObject> rxFindOneAndDelete(String collection,
                                            JsonObject query)

Find a single matching document in the specified collection and delete it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

Returns:

findOneAndDeleteWithOptions

public Maybe<JsonObject> findOneAndDeleteWithOptions(String collection,
                                                     JsonObject query,
                                                     FindOptions findOptions)

Find a single matching document in the specified collection and delete it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

findOptions - options to configure the find

Returns:

rxFindOneAndDeleteWithOptions

public Maybe<JsonObject> rxFindOneAndDeleteWithOptions(String collection,
                                                       JsonObject query,
                                                       FindOptions findOptions)

Find a single matching document in the specified collection and delete it.

This operation might change _id field of query parameter

Parameters:

collection - the collection

query - the query used to match the document

findOptions - options to configure the find

Returns:

count

public Single<Long> count(String collection,
                          JsonObject query)

Count matching documents in a collection.

Parameters:

collection - the collection

query - query used to match documents

Returns:

rxCount

public Single<Long> rxCount(String collection,
                            JsonObject query)

Count matching documents in a collection.

Parameters:

collection - the collection

query - query used to match documents

Returns:

countWithOptions

public Single<Long> countWithOptions(String collection,
                                     JsonObject query,
                                     CountOptions countOptions)

Count matching documents in a collection.

Parameters:

collection - the collection

query - query used to match documents

countOptions -

Returns:

rxCountWithOptions

public Single<Long> rxCountWithOptions(String collection,
                                       JsonObject query,
                                       CountOptions countOptions)

Count matching documents in a collection.

Parameters:

collection - the collection

query - query used to match documents

countOptions -

Returns:

removeDocuments

public Maybe<MongoClientDeleteResult> removeDocuments(String collection,
                                                      JsonObject query)

Remove matching documents from a collection and return the handler with MongoClientDeleteResult result

Parameters:

collection - the collection

query - query used to match documents

Returns:

rxRemoveDocuments

public Maybe<MongoClientDeleteResult> rxRemoveDocuments(String collection,
                                                        JsonObject query)

Remove matching documents from a collection and return the handler with MongoClientDeleteResult result

Parameters:

collection - the collection

query - query used to match documents

Returns:

removeDocumentsWithOptions

public Maybe<MongoClientDeleteResult> removeDocumentsWithOptions(String collection,
                                                                 JsonObject query,
                                                                 WriteOption writeOption)

Remove matching documents from a collection with the specified write option and return the handler with MongoClientDeleteResult result

Parameters:

collection - the collection

query - query used to match documents

writeOption - the write option to use

Returns:

rxRemoveDocumentsWithOptions

public Maybe<MongoClientDeleteResult> rxRemoveDocumentsWithOptions(String collection,
                                                                   JsonObject query,
                                                                   WriteOption writeOption)

Remove matching documents from a collection with the specified write option and return the handler with MongoClientDeleteResult result

Parameters:

collection - the collection

query - query used to match documents

writeOption - the write option to use

Returns:

removeDocument

public Maybe<MongoClientDeleteResult> removeDocument(String collection,
                                                     JsonObject query)

Remove a single matching document from a collection and return the handler with MongoClientDeleteResult result

Parameters:

collection - the collection

query - query used to match document

Returns:

rxRemoveDocument

public Maybe<MongoClientDeleteResult> rxRemoveDocument(String collection,
                                                       JsonObject query)

Remove a single matching document from a collection and return the handler with MongoClientDeleteResult result

Parameters:

collection - the collection

query - query used to match document

Returns:

removeDocumentWithOptions

public Maybe<MongoClientDeleteResult> removeDocumentWithOptions(String collection,
                                                                JsonObject query,
                                                                WriteOption writeOption)

Remove a single matching document from a collection with the specified write option and return the handler with MongoClientDeleteResult result

Parameters:

collection - the collection

query - query used to match document

writeOption - the write option to use

Returns:

rxRemoveDocumentWithOptions

public Maybe<MongoClientDeleteResult> rxRemoveDocumentWithOptions(String collection,
                                                                  JsonObject query,
                                                                  WriteOption writeOption)

Remove a single matching document from a collection with the specified write option and return the handler with MongoClientDeleteResult result

Parameters:

collection - the collection

query - query used to match document

writeOption - the write option to use

Returns:

createCollection

public Completable createCollection(String collectionName)

Create a new collection

Parameters:

collectionName - the name of the collection

Returns:

rxCreateCollection

public Completable rxCreateCollection(String collectionName)

Create a new collection

Parameters:

collectionName - the name of the collection

Returns:

createCollectionWithOptions

public Completable createCollectionWithOptions(String collectionName,
                                               CreateCollectionOptions collectionOptions)

Create a new collection with options

Parameters:

collectionName - the name of the collection

collectionOptions - options of the collection

Returns:

rxCreateCollectionWithOptions

public Completable rxCreateCollectionWithOptions(String collectionName,
                                                 CreateCollectionOptions collectionOptions)

Create a new collection with options

Parameters:

collectionName - the name of the collection

collectionOptions - options of the collection

Returns:

getCollections

public Single<List<String>> getCollections()

Get a list of all collections in the database.

Returns:

rxGetCollections

public Single<List<String>> rxGetCollections()

Get a list of all collections in the database.

Returns:

dropCollection

public Completable dropCollection(String collection)

Drop a collection

Parameters:

collection - the collection

Returns:

rxDropCollection

public Completable rxDropCollection(String collection)

Drop a collection

Parameters:

collection - the collection

Returns:

createIndex

public Completable createIndex(String collection,
                               JsonObject key)

Creates an index.

Parameters:

collection - the collection

key - A document that contains the field and value pairs where the field is the index key and the value describes the type of index for that field. For an ascending index on a field, specify a value of 1; for descending index, specify a value of -1.

Returns:

rxCreateIndex

public Completable rxCreateIndex(String collection,
                                 JsonObject key)

Creates an index.

Parameters:

collection - the collection

key - A document that contains the field and value pairs where the field is the index key and the value describes the type of index for that field. For an ascending index on a field, specify a value of 1; for descending index, specify a value of -1.

Returns:

createIndexWithOptions

public Completable createIndexWithOptions(String collection,
                                          JsonObject key,
                                          IndexOptions options)

Creates an index.

Parameters:

collection - the collection

key - A document that contains the field and value pairs where the field is the index key and the value describes the type of index for that field. For an ascending index on a field, specify a value of 1; for descending index, specify a value of -1.

options - the options for the index

Returns:

rxCreateIndexWithOptions

public Completable rxCreateIndexWithOptions(String collection,
                                            JsonObject key,
                                            IndexOptions options)

Creates an index.

Parameters:

collection - the collection

key - A document that contains the field and value pairs where the field is the index key and the value describes the type of index for that field. For an ascending index on a field, specify a value of 1; for descending index, specify a value of -1.

options - the options for the index

Returns:

createIndexes

public Completable createIndexes(String collection,
                                 List<IndexModel> indexes)

creates an indexes

Parameters:

collection - the collection

indexes - A model that contains pairs of document and indexOptions, document contains the field and value pairs where the field is the index key and the value describes the type of index for that field. For an ascending index on a field, specify a value of 1; for descending index, specify a value of -1.

Returns:

rxCreateIndexes

public Completable rxCreateIndexes(String collection,
                                   List<IndexModel> indexes)

creates an indexes

Parameters:

collection - the collection

indexes - A model that contains pairs of document and indexOptions, document contains the field and value pairs where the field is the index key and the value describes the type of index for that field. For an ascending index on a field, specify a value of 1; for descending index, specify a value of -1.

Returns:

listIndexes

public Single<JsonArray> listIndexes(String collection)

Get all the indexes in this collection.

Parameters:

collection - the collection

Returns:

rxListIndexes

public Single<JsonArray> rxListIndexes(String collection)

Get all the indexes in this collection.

Parameters:

collection - the collection

Returns:

dropIndex

public Completable dropIndex(String collection,
                             String indexName)

Drops the index given its name.

Parameters:

collection - the collection

indexName - the name of the index to remove

Returns:

rxDropIndex

public Completable rxDropIndex(String collection,
                               String indexName)

Drops the index given its name.

Parameters:

collection - the collection

indexName - the name of the index to remove

Returns:

runCommand

public Maybe<JsonObject> runCommand(String commandName,
                                    JsonObject command)

Run an arbitrary MongoDB command.

Parameters:

commandName - the name of the command

command - the command

Returns:

rxRunCommand

public Maybe<JsonObject> rxRunCommand(String commandName,
                                      JsonObject command)

Run an arbitrary MongoDB command.

Parameters:

commandName - the name of the command

command - the command

Returns:

distinct

public Single<JsonArray> distinct(String collection,
                                  String fieldName,
                                  String resultClassname)

Gets the distinct values of the specified field name. Return a JsonArray containing distinct values (eg: [ 1 , 89 ])

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

Returns:

rxDistinct

public Single<JsonArray> rxDistinct(String collection,
                                    String fieldName,
                                    String resultClassname)

Gets the distinct values of the specified field name. Return a JsonArray containing distinct values (eg: [ 1 , 89 ])

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

Returns:

distinct

public Single<JsonArray> distinct(String collection,
                                  String fieldName,
                                  String resultClassname,
                                  DistinctOptions distinctOptions)

Gets the distinct values of the specified field name. Return a JsonArray containing distinct values (eg: [ 1 , 89 ])

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

distinctOptions - options (e.g. collation)

Returns:

rxDistinct

public Single<JsonArray> rxDistinct(String collection,
                                    String fieldName,
                                    String resultClassname,
                                    DistinctOptions distinctOptions)

Gets the distinct values of the specified field name. Return a JsonArray containing distinct values (eg: [ 1 , 89 ])

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

distinctOptions - options (e.g. collation)

Returns:

distinctWithQuery

public Single<JsonArray> distinctWithQuery(String collection,
                                           String fieldName,
                                           String resultClassname,
                                           JsonObject query)

Gets the distinct values of the specified field name filtered by specified query. Return a JsonArray containing distinct values (eg: [ 1 , 89 ])

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

query - the query

Returns:

rxDistinctWithQuery

public Single<JsonArray> rxDistinctWithQuery(String collection,
                                             String fieldName,
                                             String resultClassname,
                                             JsonObject query)

Gets the distinct values of the specified field name filtered by specified query. Return a JsonArray containing distinct values (eg: [ 1 , 89 ])

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

query - the query

Returns:

distinctWithQuery

public Single<JsonArray> distinctWithQuery(String collection,
                                           String fieldName,
                                           String resultClassname,
                                           JsonObject query,
                                           DistinctOptions distinctOptions)

Gets the distinct values of the specified field name filtered by specified query. Return a JsonArray containing distinct values (eg: [ 1 , 89 ])

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

query - the query

distinctOptions - options (e.g. collation)

Returns:

rxDistinctWithQuery

public Single<JsonArray> rxDistinctWithQuery(String collection,
                                             String fieldName,
                                             String resultClassname,
                                             JsonObject query,
                                             DistinctOptions distinctOptions)

Gets the distinct values of the specified field name filtered by specified query. Return a JsonArray containing distinct values (eg: [ 1 , 89 ])

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

query - the query

distinctOptions - options (e.g. collation)

Returns:

distinctBatch

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

Gets the distinct values of the specified field name. This method use batchCursor for returning each found value. Each value is a json fragment with fieldName key (eg: {"num": 1}).

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

Returns:

a emitting json fragments

distinctBatch

public ReadStream<JsonObject> distinctBatch(String collection,
                                            String fieldName,
                                            String resultClassname,
                                            DistinctOptions distinctOptions)

Gets the distinct values of the specified field name. This method use batchCursor for returning each found value. Each value is a json fragment with fieldName key (eg: {"num": 1}).

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

distinctOptions - options (e.g. collation)

Returns:

a emitting json fragments

distinctBatchWithQuery

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

Gets the distinct values of the specified field name filtered by specified query. This method use batchCursor for returning each found value. Each value is a json fragment with fieldName key (eg: {"num": 1}).

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

query - the query

Returns:

a emitting json fragments

distinctBatchWithQuery

public ReadStream<JsonObject> distinctBatchWithQuery(String collection,
                                                     String fieldName,
                                                     String resultClassname,
                                                     JsonObject query,
                                                     DistinctOptions distinctOptions)

Gets the distinct values of the specified field name filtered by specified query. This method use batchCursor for returning each found value. Each value is a json fragment with fieldName key (eg: {"num": 1}).

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

query - the query

distinctOptions - options (e.g. collation)

Returns:

a emitting json fragments

distinctBatchWithQuery

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

Gets the distinct values of the specified field name filtered by specified query. This method use batchCursor for returning each found value. Each value is a json fragment with fieldName key (eg: {"num": 1}).

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

query - the query

batchSize - the number of documents to load in a batch

Returns:

a emitting json fragments

distinctBatchWithQuery

public ReadStream<JsonObject> distinctBatchWithQuery(String collection,
                                                     String fieldName,
                                                     String resultClassname,
                                                     JsonObject query,
                                                     int batchSize,
                                                     DistinctOptions distinctOptions)

Gets the distinct values of the specified field name filtered by specified query. This method use batchCursor for returning each found value. Each value is a json fragment with fieldName key (eg: {"num": 1}).

Parameters:

collection - the collection

fieldName - the field name

resultClassname -

query - the query

batchSize - the number of documents to load in a batch

distinctOptions - options (e.g. collation)

Returns:

a emitting json fragments

aggregate

public ReadStream<JsonObject> aggregate(String collection,
                                        JsonArray pipeline)

Run aggregate MongoDB command with default AggregateOptions.

Parameters:

collection - the collection

pipeline - aggregation pipeline to be executed

Returns:

aggregateWithOptions

public ReadStream<JsonObject> aggregateWithOptions(String collection,
                                                   JsonArray pipeline,
                                                   AggregateOptions options)

Run aggregate MongoDB command.

Parameters:

collection - the collection

pipeline - aggregation pipeline to be executed

options - options to configure the aggregation command

Returns:

createDefaultGridFsBucketService

public Single<MongoGridFsClient> createDefaultGridFsBucketService()

Creates a MongoGridFsClient used to interact with Mongo GridFS.

Returns:

rxCreateDefaultGridFsBucketService

public Single<MongoGridFsClient> rxCreateDefaultGridFsBucketService()

Creates a MongoGridFsClient used to interact with Mongo GridFS.

Returns:

createGridFsBucketService

public Single<MongoGridFsClient> createGridFsBucketService(String bucketName)

Creates a MongoGridFsClient used to interact with Mongo GridFS.

Parameters:

bucketName - the name of the GridFS bucket

Returns:

rxCreateGridFsBucketService

public Single<MongoGridFsClient> rxCreateGridFsBucketService(String bucketName)

Creates a MongoGridFsClient used to interact with Mongo GridFS.

Parameters:

bucketName - the name of the GridFS bucket

Returns:

close

public Completable close()

Close the client and release its resources

Returns:

rxClose

public Completable rxClose()

Close the client and release its resources

Returns:

watch

public ReadStream<com.mongodb.client.model.changestream.ChangeStreamDocument<JsonObject>> watch(String collection,
                                                                                                JsonArray pipeline,
                                                                                                boolean withUpdatedDoc,
                                                                                                int batchSize)

Watch the collection change.

Parameters:

collection - the collection

pipeline - watching pipeline to be executed

withUpdatedDoc - whether to get updated fullDocument for "update" operation

batchSize - the number of documents to load in a batch

Returns:

newInstance

public static MongoClient newInstance(MongoClient arg)