com.mongodb.rx.client

Interface MongoDatabase

@ThreadSafe
public interface MongoDatabase

The MongoDatabase interface.

Note: Additions to this interface will not be considered to break binary compatibility.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
rx.Observable<Success>	createCollection(String collectionName) Create a new collection with the given name.
rx.Observable<Success>	createCollection(String collectionName, com.mongodb.client.model.CreateCollectionOptions options) Create a new collection with the selected options
rx.Observable<Success>	createView(String viewName, String viewOn, List<? extends org.bson.conversions.Bson> pipeline) Creates a view with the given name, backing collection/view name, and aggregation pipeline that defines the view.
rx.Observable<Success>	createView(String viewName, String viewOn, List<? extends org.bson.conversions.Bson> pipeline, com.mongodb.client.model.CreateViewOptions createViewOptions) Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.
rx.Observable<Success>	drop() Drops this database.
org.bson.codecs.configuration.CodecRegistry	getCodecRegistry() Get the codec registry for the MongoDatabase.
MongoCollection<org.bson.Document>	getCollection(String collectionName) Gets a collection.
<TDocument> MongoCollection<TDocument>	getCollection(String collectionName, Class<TDocument> clazz) Gets a collection, with a specific default document class.
String	getName() Gets the name of the database.
ObservableAdapter	getObservableAdapter() Get the ObservableAdapter for the MongoDatabase.
com.mongodb.ReadConcern	getReadConcern() Get the read concern for the MongoDatabase.
com.mongodb.ReadPreference	getReadPreference() Get the read preference for the MongoDatabase.
com.mongodb.WriteConcern	getWriteConcern() Get the write concern for the MongoDatabase.
rx.Observable<String>	listCollectionNames() Gets the names of all the collections in this database.
ListCollectionsObservable<org.bson.Document>	listCollections() Finds all the collections in this database.
<TResult> ListCollectionsObservable<TResult>	listCollections(Class<TResult> clazz) Finds all the collections in this database.
rx.Observable<org.bson.Document>	runCommand(org.bson.conversions.Bson command) Executes command in the context of the current database.
<TResult> rx.Observable<TResult>	runCommand(org.bson.conversions.Bson command, Class<TResult> clazz) Executes command in the context of the current database.
rx.Observable<org.bson.Document>	runCommand(org.bson.conversions.Bson command, com.mongodb.ReadPreference readPreference) Executes command in the context of the current database.
<TResult> rx.Observable<TResult>	runCommand(org.bson.conversions.Bson command, com.mongodb.ReadPreference readPreference, Class<TResult> clazz) Executes command in the context of the current database.
MongoDatabase	withCodecRegistry(org.bson.codecs.configuration.CodecRegistry codecRegistry) Create a new MongoDatabase instance with a different codec registry.
MongoDatabase	withObservableAdapter(ObservableAdapter observableAdapter) Create a new MongoDatabase instance with a different ObservableAdapter.
MongoDatabase	withReadConcern(com.mongodb.ReadConcern readConcern) Create a new MongoDatabase instance with a different read concern.
MongoDatabase	withReadPreference(com.mongodb.ReadPreference readPreference) Create a new MongoDatabase instance with a different read preference.
MongoDatabase	withWriteConcern(com.mongodb.WriteConcern writeConcern) Create a new MongoDatabase instance with a different write concern.

Method Detail

getName

String getName()

Gets the name of the database.

Returns:

the database name

getObservableAdapter

ObservableAdapter getObservableAdapter()

Get the ObservableAdapter for the MongoDatabase.

Returns:

the ObservableAdapter

Since:

1.2

getCodecRegistry

org.bson.codecs.configuration.CodecRegistry getCodecRegistry()

Get the codec registry for the MongoDatabase.

Returns:

the CodecRegistry

getReadPreference

com.mongodb.ReadPreference getReadPreference()

Get the read preference for the MongoDatabase.

Returns:

the ReadPreference

getWriteConcern

com.mongodb.WriteConcern getWriteConcern()

Get the write concern for the MongoDatabase.

Returns:

the WriteConcern

getReadConcern

com.mongodb.ReadConcern getReadConcern()

Get the read concern for the MongoDatabase.

Returns:

the ReadConcern

Since:

1.2

Since server release

3.2

withObservableAdapter

MongoDatabase withObservableAdapter(ObservableAdapter observableAdapter)

Create a new MongoDatabase instance with a different ObservableAdapter.

Parameters:

observableAdapter - the new ObservableAdapter for the database

Returns:

a new MongoDatabase instance with the different ObservableAdapter

Since:

1.2

withCodecRegistry

MongoDatabase withCodecRegistry(org.bson.codecs.configuration.CodecRegistry codecRegistry)

Create a new MongoDatabase instance with a different codec registry.

Parameters:

codecRegistry - the new CodecRegistry for the database

Returns:

a new MongoDatabase instance with the different codec registry

withReadPreference

MongoDatabase withReadPreference(com.mongodb.ReadPreference readPreference)

Create a new MongoDatabase instance with a different read preference.

Parameters:

readPreference - the new ReadPreference for the database

Returns:

a new MongoDatabase instance with the different readPreference

withWriteConcern

MongoDatabase withWriteConcern(com.mongodb.WriteConcern writeConcern)

Create a new MongoDatabase instance with a different write concern.

Parameters:

writeConcern - the new WriteConcern for the database

Returns:

a new MongoDatabase instance with the different writeConcern

withReadConcern

MongoDatabase withReadConcern(com.mongodb.ReadConcern readConcern)

Create a new MongoDatabase instance with a different read concern.

Parameters:

readConcern - the new ReadConcern for the database

Returns:

a new MongoDatabase instance with the different ReadConcern

Since:

1.2

Since server release

3.2

getCollection

MongoCollection<org.bson.Document> getCollection(String collectionName)

Gets a collection.

Parameters:

collectionName - the name of the collection to return

Returns:

the collection

getCollection

<TDocument> MongoCollection<TDocument> getCollection(String collectionName,
                                                     Class<TDocument> clazz)

Gets a collection, with a specific default document class.

Type Parameters:

TDocument - the type of the class to use instead of Document.

Parameters:

collectionName - the name of the collection to return

clazz - the default class to cast any documents returned from the database into.

Returns:

the collection

runCommand

rx.Observable<org.bson.Document> runCommand(org.bson.conversions.Bson command)

Executes command in the context of the current database.

Parameters:

command - the command to be run

Returns:

an observable containing the command result

runCommand

rx.Observable<org.bson.Document> runCommand(org.bson.conversions.Bson command,
                                            com.mongodb.ReadPreference readPreference)

Executes command in the context of the current database.

Parameters:

command - the command to be run

readPreference - the ReadPreference to be used when executing the command

Returns:

an observable containing the command result

runCommand

<TResult> rx.Observable<TResult> runCommand(org.bson.conversions.Bson command,
                                            Class<TResult> clazz)

Executes command in the context of the current database.

Type Parameters:

TResult - the type of the class to use instead of Document.

Parameters:

command - the command to be run

clazz - the default class to cast any documents returned from the database into.

Returns:

an observable containing the command result

runCommand

<TResult> rx.Observable<TResult> runCommand(org.bson.conversions.Bson command,
                                            com.mongodb.ReadPreference readPreference,
                                            Class<TResult> clazz)

Executes command in the context of the current database.

Type Parameters:

TResult - the type of the class to use instead of Document.

Parameters:

command - the command to be run

readPreference - the ReadPreference to be used when executing the command

clazz - the default class to cast any documents returned from the database into.

Returns:

an observable containing the command result

drop

rx.Observable<Success> drop()

Drops this database.

Returns:

an observable identifying when the database has been dropped

MongoDB documentation

Drop database

listCollectionNames

rx.Observable<String> listCollectionNames()

Gets the names of all the collections in this database.

Returns:

an observable with all the names of all the collections in this database

listCollections

ListCollectionsObservable<org.bson.Document> listCollections()

Finds all the collections in this database.

Returns:

the fluent list collections interface

MongoDB documentation

listCollections

listCollections

<TResult> ListCollectionsObservable<TResult> listCollections(Class<TResult> clazz)

Finds all the collections in this database.

Type Parameters:

TResult - the target document type of the iterable.

Parameters:

clazz - the class to decode each document into

Returns:

the fluent list collections interface

MongoDB documentation

listCollections

createCollection

rx.Observable<Success> createCollection(String collectionName)

Create a new collection with the given name.

Parameters:

collectionName - the name for the new collection to create

Returns:

an observable identifying when the collection has been created

MongoDB documentation

Create Command

createCollection

rx.Observable<Success> createCollection(String collectionName,
                                        com.mongodb.client.model.CreateCollectionOptions options)

Create a new collection with the selected options

Parameters:

collectionName - the name for the new collection to create

options - various options for creating the collection

Returns:

an observable identifying when the collection has been created

MongoDB documentation

Create Command

createView

rx.Observable<Success> createView(String viewName,
                                  String viewOn,
                                  List<? extends org.bson.conversions.Bson> pipeline)

Creates a view with the given name, backing collection/view name, and aggregation pipeline that defines the view.

Parameters:

viewName - the name of the view to create

viewOn - the backing collection/view for the view

pipeline - the pipeline that defines the view

Returns:

an observable identifying when the collection view has been created

Since:

1.3

MongoDB documentation

Create Command

Since server release

3.4

createView

rx.Observable<Success> createView(String viewName,
                                  String viewOn,
                                  List<? extends org.bson.conversions.Bson> pipeline,
                                  com.mongodb.client.model.CreateViewOptions createViewOptions)

Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.

Parameters:

viewName - the name of the view to create

viewOn - the backing collection/view for the view

pipeline - the pipeline that defines the view

createViewOptions - various options for creating the view

Returns:

an observable identifying when the collection view has been created

Since:

1.3

MongoDB documentation

Create Command

Since server release

3.4