ReactiveMongoDatabase (Quarkus - MongoDB Client

All Known Implementing Classes:

ReactiveMongoDatabaseImpl
```
public interface ReactiveMongoDatabase
```
A reactive API to interact with a Mongo database.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`io.smallrye.mutiny.Multi<org.bson.Document>`	`aggregate(com.mongodb.reactivestreams.client.ClientSession clientSession, List<? extends org.bson.conversions.Bson> pipeline)` Runs an aggregation framework pipeline on the database for pipeline stages that do not require an underlying collection, such as `$currentOp` and `$listLocalSessions`.
`io.smallrye.mutiny.Multi<org.bson.Document>`	`aggregate(com.mongodb.reactivestreams.client.ClientSession clientSession, List<? extends org.bson.conversions.Bson> pipeline, AggregateOptions options)` Runs an aggregation framework pipeline on the database for pipeline stages that do not require an underlying collection, such as `$currentOp` and `$listLocalSessions`.
`<T> io.smallrye.mutiny.Multi<T>`	`aggregate(com.mongodb.reactivestreams.client.ClientSession clientSession, List<? extends org.bson.conversions.Bson> pipeline, Class<T> clazz)` Runs an aggregation framework pipeline on the database for pipeline stages that do not require an underlying collection, such as `$currentOp` and `$listLocalSessions`.
`<T> io.smallrye.mutiny.Multi<T>`	`aggregate(com.mongodb.reactivestreams.client.ClientSession clientSession, List<? extends org.bson.conversions.Bson> pipeline, Class<T> clazz, AggregateOptions options)` Runs an aggregation framework pipeline on the database for pipeline stages that do not require an underlying collection, such as `$currentOp` and `$listLocalSessions`.
`io.smallrye.mutiny.Multi<org.bson.Document>`	`aggregate(List<? extends org.bson.conversions.Bson> pipeline)` Runs an aggregation framework pipeline on the database for pipeline stages that do not require an underlying collection, such as `$currentOp` and `$listLocalSessions`.
`io.smallrye.mutiny.Multi<org.bson.Document>`	`aggregate(List<? extends org.bson.conversions.Bson> pipeline, AggregateOptions options)` Runs an aggregation framework pipeline on the database for pipeline stages that do not require an underlying collection, such as `$currentOp` and `$listLocalSessions`.
`<T> io.smallrye.mutiny.Multi<T>`	`aggregate(List<? extends org.bson.conversions.Bson> pipeline, Class<T> clazz)` Runs an aggregation framework pipeline on the database for pipeline stages that do not require an underlying collection, such as `$currentOp` and `$listLocalSessions`.
`<T> io.smallrye.mutiny.Multi<T>`	`aggregate(List<? extends org.bson.conversions.Bson> pipeline, Class<T> clazz, AggregateOptions options)` Runs an aggregation framework pipeline on the database for pipeline stages that do not require an underlying collection, such as `$currentOp` and `$listLocalSessions`.
`io.smallrye.mutiny.Uni<Void>`	`createCollection(com.mongodb.reactivestreams.client.ClientSession clientSession, String collectionName)` Create a new collection with the selected options
`io.smallrye.mutiny.Uni<Void>`	`createCollection(com.mongodb.reactivestreams.client.ClientSession clientSession, String collectionName, com.mongodb.client.model.CreateCollectionOptions options)` Create a new collection with the selected options
`io.smallrye.mutiny.Uni<Void>`	`createCollection(String collectionName)` Create a new collection with the selected options
`io.smallrye.mutiny.Uni<Void>`	`createCollection(String collectionName, com.mongodb.client.model.CreateCollectionOptions options)` Create a new collection with the selected options
`io.smallrye.mutiny.Uni<Void>`	`createView(com.mongodb.reactivestreams.client.ClientSession clientSession, String viewName, String viewOn, List<? extends org.bson.conversions.Bson> pipeline)` Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.
`io.smallrye.mutiny.Uni<Void>`	`createView(com.mongodb.reactivestreams.client.ClientSession clientSession, 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.
`io.smallrye.mutiny.Uni<Void>`	`createView(String viewName, String viewOn, List<? extends org.bson.conversions.Bson> pipeline)` Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.
`io.smallrye.mutiny.Uni<Void>`	`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.
`io.smallrye.mutiny.Uni<Void>`	`drop()` Drops this database.
`io.smallrye.mutiny.Uni<Void>`	`drop(com.mongodb.reactivestreams.client.ClientSession clientSession)` Drops this database.
`ReactiveMongoCollection<org.bson.Document>`	`getCollection(String collectionName)` Gets a collection.
`<T> ReactiveMongoCollection<T>`	`getCollection(String collectionName, Class<T> clazz)` Gets a collection, with a specific default document class.
`String`	`getName()` Gets the name of the database.
`io.smallrye.mutiny.Multi<String>`	`listCollectionNames()` Gets a stream of the names of all the collections in this database.
`io.smallrye.mutiny.Multi<String>`	`listCollectionNames(com.mongodb.reactivestreams.client.ClientSession clientSession)` Gets a stream of the names of all the collections in this database.
`io.smallrye.mutiny.Multi<org.bson.Document>`	`listCollections()` Finds all the collections in this database.
`<T> io.smallrye.mutiny.Multi<T>`	`listCollections(Class<T> clazz)` Finds all the collections in this database.
`<T> io.smallrye.mutiny.Multi<T>`	`listCollections(Class<T> clazz, CollectionListOptions options)` Finds all the collections in this database.
`io.smallrye.mutiny.Multi<org.bson.Document>`	`listCollections(com.mongodb.reactivestreams.client.ClientSession clientSession)` Finds all the collections in this database.
`<T> io.smallrye.mutiny.Multi<T>`	`listCollections(com.mongodb.reactivestreams.client.ClientSession clientSession, Class<T> clazz)` Finds all the collections in this database.
`<T> io.smallrye.mutiny.Multi<T>`	`listCollections(com.mongodb.reactivestreams.client.ClientSession clientSession, Class<T> clazz, CollectionListOptions options)` Finds all the collections in this database.
`io.smallrye.mutiny.Multi<org.bson.Document>`	`listCollections(com.mongodb.reactivestreams.client.ClientSession clientSession, CollectionListOptions options)` Finds all the collections in this database.
`io.smallrye.mutiny.Multi<org.bson.Document>`	`listCollections(CollectionListOptions options)` Finds all the collections in this database.
`io.smallrye.mutiny.Uni<org.bson.Document>`	`runCommand(org.bson.conversions.Bson command)` Executes command in the context of the current database.
`<T> io.smallrye.mutiny.Uni<T>`	`runCommand(org.bson.conversions.Bson command, Class<T> clazz)` Executes command in the context of the current database.
`io.smallrye.mutiny.Uni<org.bson.Document>`	`runCommand(org.bson.conversions.Bson command, com.mongodb.ReadPreference readPreference)` Executes command in the context of the current database.
`<T> io.smallrye.mutiny.Uni<T>`	`runCommand(org.bson.conversions.Bson command, com.mongodb.ReadPreference readPreference, Class<T> clazz)` Executes command in the context of the current database.
`io.smallrye.mutiny.Uni<org.bson.Document>`	`runCommand(com.mongodb.reactivestreams.client.ClientSession clientSession, org.bson.conversions.Bson command)` Executes command in the context of the current database.
`<T> io.smallrye.mutiny.Uni<T>`	`runCommand(com.mongodb.reactivestreams.client.ClientSession clientSession, org.bson.conversions.Bson command, Class<T> clazz)` Executes command in the context of the current database.
`io.smallrye.mutiny.Uni<org.bson.Document>`	`runCommand(com.mongodb.reactivestreams.client.ClientSession clientSession, org.bson.conversions.Bson command, com.mongodb.ReadPreference readPreference)` Executes command in the context of the current database.
`<T> io.smallrye.mutiny.Uni<T>`	`runCommand(com.mongodb.reactivestreams.client.ClientSession clientSession, org.bson.conversions.Bson command, com.mongodb.ReadPreference readPreference, Class<T> clazz)` Executes command in the context of the current database.
`com.mongodb.reactivestreams.client.MongoDatabase`	`unwrap()`
`io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>>`	`watch()` Creates a change stream for this database.
`io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>>`	`watch(ChangeStreamOptions options)` Creates a change stream for this database.
`<T> io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<T>>`	`watch(Class<T> clazz)` Creates a change stream for this database.
`<T> io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<T>>`	`watch(Class<T> clazz, ChangeStreamOptions options)` Creates a change stream for this database.
`io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>>`	`watch(com.mongodb.reactivestreams.client.ClientSession clientSession)` Creates a change stream for this database.
`io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>>`	`watch(com.mongodb.reactivestreams.client.ClientSession clientSession, ChangeStreamOptions options)` Creates a change stream for this database.
`<T> io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<T>>`	`watch(com.mongodb.reactivestreams.client.ClientSession clientSession, Class<T> clazz)` Creates a change stream for this database.
`<T> io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<T>>`	`watch(com.mongodb.reactivestreams.client.ClientSession clientSession, Class<T> clazz, ChangeStreamOptions options)` Creates a change stream for this database.
`io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>>`	`watch(com.mongodb.reactivestreams.client.ClientSession clientSession, List<? extends org.bson.conversions.Bson> pipeline)` Creates a change stream for this database.
`io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>>`	`watch(com.mongodb.reactivestreams.client.ClientSession clientSession, List<? extends org.bson.conversions.Bson> pipeline, ChangeStreamOptions options)` Creates a change stream for this database.
`<T> io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<T>>`	`watch(com.mongodb.reactivestreams.client.ClientSession clientSession, List<? extends org.bson.conversions.Bson> pipeline, Class<T> clazz)` Creates a change stream for this database.
`<T> io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<T>>`	`watch(com.mongodb.reactivestreams.client.ClientSession clientSession, List<? extends org.bson.conversions.Bson> pipeline, Class<T> clazz, ChangeStreamOptions options)` Creates a change stream for this database.
`io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>>`	`watch(List<? extends org.bson.conversions.Bson> pipeline)` Creates a change stream for this database.
`io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>>`	`watch(List<? extends org.bson.conversions.Bson> pipeline, ChangeStreamOptions options)` Creates a change stream for this database.
`<T> io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<T>>`	`watch(List<? extends org.bson.conversions.Bson> pipeline, Class<T> clazz)` Creates a change stream for this database.
`<T> io.smallrye.mutiny.Multi<com.mongodb.client.model.changestream.ChangeStreamDocument<T>>`	`watch(List<? extends org.bson.conversions.Bson> pipeline, Class<T> clazz, ChangeStreamOptions options)` Creates a change stream for this database.

Method Detail

getName
```
String getName()
```
Gets the name of the database.

Returns:

the database name

getCollection
```
ReactiveMongoCollection<org.bson.Document> getCollection(String collectionName)
```
Gets a collection.

Parameters:

collectionName - the name of the collection to return

Returns:

the collection

getCollection
```
<T> ReactiveMongoCollection<T> getCollection(String collectionName,
                                             Class<T> clazz)
```
Gets a collection, with a specific default document class.

Type Parameters:

T - 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
```
io.smallrye.mutiny.Uni<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:

a Uni emitting the command result once completed

runCommand
```
io.smallrye.mutiny.Uni<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:

a Uni emitting the command result once completed

runCommand
```
<T> io.smallrye.mutiny.Uni<T> runCommand(org.bson.conversions.Bson command,
                                         Class<T> clazz)
```
Executes command in the context of the current database.

Type Parameters:

T - 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:

a Uni emitting the command result once completed

runCommand
```
<T> io.smallrye.mutiny.Uni<T> runCommand(org.bson.conversions.Bson command,
                                         com.mongodb.ReadPreference readPreference,
                                         Class<T> clazz)
```
Executes command in the context of the current database.

Type Parameters:

T - 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:

a Uni emitting the command result once completed

runCommand
```
io.smallrye.mutiny.Uni<org.bson.Document> runCommand(com.mongodb.reactivestreams.client.ClientSession clientSession,
                                                     org.bson.conversions.Bson command)
```
Executes command in the context of the current database.

Parameters:

clientSession - the client session with which to associate this operation

command - the command to be run

Returns:

a Uni emitting the command result once completed

runCommand

io.smallrye.mutiny.Uni<org.bson.Document> runCommand(com.mongodb.reactivestreams.client.ClientSession clientSession,
                                                     org.bson.conversions.Bson command,
                                                     com.mongodb.ReadPreference readPreference)

Executes command in the context of the current database.

Parameters:: clientSession - the client session with which to associate this operation; readPreference - the ReadPreference to be used when executing the command; command - the command to be run
Returns:: a Uni emitting the command result once completed

runCommand
```
<T> io.smallrye.mutiny.Uni<T> runCommand(com.mongodb.reactivestreams.client.ClientSession clientSession,
                                         org.bson.conversions.Bson command,
                                         Class<T> clazz)
```
Executes command in the context of the current database.

Type Parameters:

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

Parameters:

clientSession - the client session with which to associate this operation

command - the command to be run

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

Returns:

a Uni emitting the command result once completed

runCommand
```
<T> io.smallrye.mutiny.Uni<T> runCommand(com.mongodb.reactivestreams.client.ClientSession clientSession,
                                         org.bson.conversions.Bson command,
                                         com.mongodb.ReadPreference readPreference,
                                         Class<T> clazz)
```
Executes command in the context of the current database.

Type Parameters:

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

Parameters:

clientSession - the client session with which to associate this operation

readPreference - the ReadPreference to be used when executing the command

command - the command to be run

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

Returns:

a Uni emitting the command result once completed

drop
```
io.smallrye.mutiny.Uni<Void> drop()
```
Drops this database.

Returns:

a Uni emitting null when the database has been dropped

drop
```
io.smallrye.mutiny.Uni<Void> drop(com.mongodb.reactivestreams.client.ClientSession clientSession)
```
Drops this database.

Parameters:

clientSession - the client session with which to associate this operation

Returns:

a Uni emitting null when the database has been dropped

listCollectionNames
```
io.smallrye.mutiny.Multi<String> listCollectionNames()
```
Gets a stream of the names of all the collections in this database.

Returns:

a stream with all the names of all the collections in this database

listCollectionNames
```
io.smallrye.mutiny.Multi<String> listCollectionNames(com.mongodb.reactivestreams.client.ClientSession clientSession)
```
Gets a stream of the names of all the collections in this database.

Parameters:

clientSession - the client session with which to associate this operation

Returns:

a stream with all the names of all the collections in this database

listCollections
```
io.smallrye.mutiny.Multi<org.bson.Document> listCollections()
```
Finds all the collections in this database.

Returns:

stream of collection descriptor

listCollections
```
io.smallrye.mutiny.Multi<org.bson.Document> listCollections(CollectionListOptions options)
```
Finds all the collections in this database.

Parameters:

options - the stream options

Returns:

stream of collection descriptor

listCollections
```
<T> io.smallrye.mutiny.Multi<T> listCollections(Class<T> clazz)
```
Finds all the collections in this database.

Type Parameters:

T - the target document type of the iterable

Parameters:

clazz - the class to decode each document into

Returns:

stream of collection descriptor

listCollections
```
<T> io.smallrye.mutiny.Multi<T> listCollections(Class<T> clazz,
                                                CollectionListOptions options)
```
Finds all the collections in this database.

Type Parameters:

T - the target document type of the iterable

Parameters:

clazz - the class to decode each document into

options - the stream options

Returns:

stream of collection descriptor

listCollections
```
io.smallrye.mutiny.Multi<org.bson.Document> listCollections(com.mongodb.reactivestreams.client.ClientSession clientSession)
```
Finds all the collections in this database.

Parameters:

clientSession - the client session with which to associate this operation

Returns:

stream of collection descriptor

listCollections

io.smallrye.mutiny.Multi<org.bson.Document> listCollections(com.mongodb.reactivestreams.client.ClientSession clientSession,
                                                            CollectionListOptions options)

Finds all the collections in this database.

Parameters:: clientSession - the client session with which to associate this operation; options - the stream options
Returns:: stream of collection descriptor

listCollections
```
<T> io.smallrye.mutiny.Multi<T> listCollections(com.mongodb.reactivestreams.client.ClientSession clientSession,
                                                Class<T> clazz)
```
Finds all the collections in this database.

Type Parameters:

T - the target document type of the iterable

Parameters:

clientSession - the client session with which to associate this operation

clazz - the class to decode each document into

Returns:

stream of collection descriptor

listCollections

<T> io.smallrye.mutiny.Multi<T> listCollections(com.mongodb.reactivestreams.client.ClientSession clientSession,
                                                Class<T> clazz,
                                                CollectionListOptions options)

Finds all the collections in this database.

Type Parameters:: T - the target document type of the iterable
Parameters:: clientSession - the client session with which to associate this operation; clazz - the class to decode each document into; options - the stream options
Returns:: stream of collection descriptor

createCollection
```
io.smallrye.mutiny.Uni<Void> createCollection(String collectionName)
```
Create a new collection with the selected options

Parameters:

collectionName - the name for the new collection to create

Returns:

a Uni emitting null when the operation has completed

createCollection
```
io.smallrye.mutiny.Uni<Void> 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:

a Uni emitting null when the operation has completed

createCollection
```
io.smallrye.mutiny.Uni<Void> createCollection(com.mongodb.reactivestreams.client.ClientSession clientSession,
                                              String collectionName)
```
Create a new collection with the selected options

Parameters:

clientSession - the client session with which to associate this operation

collectionName - the name for the new collection to create

Returns:

a Uni emitting null when the operation has completed

createCollection

io.smallrye.mutiny.Uni<Void> createCollection(com.mongodb.reactivestreams.client.ClientSession clientSession,
                                              String collectionName,
                                              com.mongodb.client.model.CreateCollectionOptions options)

Create a new collection with the selected options

Parameters:: clientSession - the client session with which to associate this operation; collectionName - the name for the new collection to create; options - various options for creating the collection
Returns:: a Uni emitting null when the operation has completed

createView
```
io.smallrye.mutiny.Uni<Void> createView(String viewName,
                                        String viewOn,
                                        List<? extends org.bson.conversions.Bson> pipeline)
```
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

Returns:

a Uni emitting null when the operation has completed

createView

io.smallrye.mutiny.Uni<Void> 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:: a Uni emitting null when the operation has completed

createView

io.smallrye.mutiny.Uni<Void> createView(com.mongodb.reactivestreams.client.ClientSession clientSession,
                                        String viewName,
                                        String viewOn,
                                        List<? extends org.bson.conversions.Bson> pipeline)

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

Parameters:: clientSession - the client session with which to associate this operation; viewName - the name of the view to create; viewOn - the backing collection/view for the view; pipeline - the pipeline that defines the view
Returns:: a Uni emitting null when the operation has completed

createView

io.smallrye.mutiny.Uni<Void> createView(com.mongodb.reactivestreams.client.ClientSession clientSession,
                                        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:: clientSession - the client session with which to associate this operation; 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:: a Uni emitting null when the operation has completed