case class MongoDatabase(wrapped: com.mongodb.async.client.MongoDatabase) extends Product with Serializable
The MongoDatabase representation.
- wrapped
the underlying java MongoDatabase
- Since
1.0
- Alphabetic
- By Inheritance
- MongoDatabase
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
MongoDatabase(wrapped: com.mongodb.async.client.MongoDatabase)
- wrapped
the underlying java MongoDatabase
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
lazy val
codecRegistry: CodecRegistry
Get the codec registry for the MongoDatabase.
Get the codec registry for the MongoDatabase.
- returns
the { @link org.bson.codecs.configuration.CodecRegistry}
-
def
createCollection(collectionName: String, options: CreateCollectionOptions): SingleObservable[Completed]
Create a new collection with the selected options
Create a new collection with the selected options
- collectionName
the name for the new collection to create
- options
various options for creating the collection
- returns
a Observable identifying when the collection has been created
-
def
createCollection(collectionName: String): SingleObservable[Completed]
Create a new collection with the given name.
Create a new collection with the given name.
- collectionName
the name for the new collection to create
- returns
a Observable identifying when the collection has been created
-
def
createView(viewName: String, viewOn: String, pipeline: Seq[Bson], createViewOptions: CreateViewOptions): SingleObservable[Completed]
Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.
Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.
- 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
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
-
def
createView(viewName: String, viewOn: String, pipeline: Seq[Bson]): SingleObservable[Completed]
Creates a view with the given name, backing collection/view name, and aggregation pipeline that defines the view.
Creates a view with the given name, backing collection/view name, and aggregation pipeline that defines the view.
- viewName
the name of the view to create
- viewOn
the backing collection/view for the view
- pipeline
the pipeline that defines the view
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
-
def
drop(): SingleObservable[Completed]
Drops this database.
Drops this database.
- returns
a Observable identifying when the database has been dropped
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
getCollection[TResult](collectionName: String)(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): MongoCollection[TResult]
Gets a collection, with a specific default document class.
Gets a collection, with a specific default document class.
- TResult
the type of the class to use instead of Document.
- collectionName
the name of the collection to return
- returns
the collection
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
listCollectionNames(): Observable[String]
Gets the names of all the collections in this database.
Gets the names of all the collections in this database.
- returns
a Observable with all the names of all the collections in this database
-
def
listCollections[TResult]()(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): ListCollectionsObservable[TResult]
Finds all the collections in this database.
Finds all the collections in this database.
- TResult
the target document type of the iterable.
- returns
the fluent list collections interface
-
lazy val
name: String
Gets the name of the database.
Gets the name of the database.
- returns
the database name
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
lazy val
readConcern: ReadConcern
Get the read concern for the MongoDatabase.
-
lazy val
readPreference: ReadPreference
Get the read preference for the MongoDatabase.
Get the read preference for the MongoDatabase.
- returns
the { @link com.mongodb.ReadPreference}
-
def
runCommand[TResult](command: Bson, readPreference: ReadPreference)(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): SingleObservable[TResult]
Executes command in the context of the current database.
Executes command in the context of the current database.
- TResult
the type of the class to use instead of Document.
- command
the command to be run
- readPreference
the ReadPreference to be used when executing the command
- returns
a Observable containing the command result
-
def
runCommand[TResult](command: Bson)(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): SingleObservable[TResult]
Executes command in the context of the current database using the primary server.
Executes command in the context of the current database using the primary server.
- TResult
the type of the class to use instead of Document.
- command
the command to be run
- returns
a Observable containing the command result
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withCodecRegistry(codecRegistry: CodecRegistry): MongoDatabase
Create a new MongoDatabase instance with a different codec registry.
Create a new MongoDatabase instance with a different codec registry.
- codecRegistry
the new { @link org.bson.codecs.configuration.CodecRegistry} for the collection
- returns
a new MongoDatabase instance with the different codec registry
-
def
withReadConcern(readConcern: ReadConcern): MongoDatabase
Create a new MongoDatabase instance with a different read concern.
Create a new MongoDatabase instance with a different read concern.
- readConcern
the new ReadConcern for the collection
- returns
a new MongoDatabase instance with the different ReadConcern
- Since
1.1
-
def
withReadPreference(readPreference: ReadPreference): MongoDatabase
Create a new MongoDatabase instance with a different read preference.
Create a new MongoDatabase instance with a different read preference.
- readPreference
the new { @link com.mongodb.ReadPreference} for the collection
- returns
a new MongoDatabase instance with the different readPreference
-
def
withWriteConcern(writeConcern: WriteConcern): MongoDatabase
Create a new MongoDatabase instance with a different write concern.
Create a new MongoDatabase instance with a different write concern.
- writeConcern
the new { @link com.mongodb.WriteConcern} for the collection
- returns
a new MongoDatabase instance with the different writeConcern
-
lazy val
writeConcern: WriteConcern
Get the write concern for the MongoDatabase.
Get the write concern for the MongoDatabase.
- returns
the { @link com.mongodb.WriteConcern}
This is the documentation for the MongoDB Scala driver.
Driver structure
The mongodb scala driver.
To get started you need a MongoClient instance, either from a connection string or via a org.mongodb.scala.MongoClientSettings.
Notable packages include: