class MongoConnection extends AnyRef
A pool of MongoDB connections, obtained from a reactivemongo.api.MongoDriver.
Connection here does not mean that there is one open channel to the server: behind the scene, many connections (channels) are open on all the available servers in the replica set.
Example:
import scala.concurrent.ExecutionContext import reactivemongo.api._ def foo(driver: AsyncDriver)(implicit ec: ExecutionContext) = { val con = driver.connect(List("localhost")) val db = con.flatMap(_.database("plugin")) val collection = db.map(_("acoll")) }
- Alphabetic
- By Inheritance
- MongoConnection
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MongoConnection(supervisor: String, name: String, actorSystem: ActorSystem, mongosystem: ActorRef, options: MongoConnectionOptions)
- supervisor
the name of the supervisor
- name
the unique name for the connection pool
- mongosystem
the reference to the internal reactivemongo.core.actors.MongoDBSystem Actor.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from MongoConnection toany2stringadd[MongoConnection] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (MongoConnection, B)
- Implicit
- This member is added by an implicit conversion from MongoConnection toArrowAssoc[MongoConnection] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def active: Boolean
Returns true if the connection has not been killed.
Returns true if the connection has not been killed.
- Annotations
- @inline()
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def authenticate(db: String, user: String, password: String, failoverStrategy: FailoverStrategy = options.failoverStrategy)(implicit ec: ExecutionContext): Future[SuccessfulAuthentication]
Authenticates the connection on the given database.
Authenticates the connection on the given database.
- db
the database name
- user
the user name
- password
the user password
- failoverStrategy
the failover strategy for sending requests
import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.MongoConnection def authDB(con: MongoConnection, user: String, pass: String)( implicit ec: ExecutionContext): Future[Unit] = con.authenticate("myDB", user, pass).map(_ => {}) // with configured failover
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def close()(implicit timeout: FiniteDuration): Future[_]
Closes this connection (closes all the channels and ends the actors).
Closes this connection (closes all the channels and ends the actors).
import scala.concurrent.{ ExecutionContext, Future } import scala.concurrent.duration._ import reactivemongo.api.MongoConnection def afterClose(con: MongoConnection)( implicit ec: ExecutionContext): Future[Unit] = con.close()(5.seconds).map { res => println("Close result: " + res) }
- def database(name: String, failoverStrategy: FailoverStrategy = options.failoverStrategy)(implicit ec: ExecutionContext): Future[DefaultDB]
Returns a DefaultDB reference using this connection.
Returns a DefaultDB reference using this connection. The failover strategy is also used to wait for the node set to be ready, before returning an valid database reference.
- name
the database name
- failoverStrategy
the failover strategy for sending requests
import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.{ DefaultDB, MongoConnection } def resolveDB(con: MongoConnection, name: String)( implicit ec: ExecutionContext): Future[DefaultDB] = con.database(name) // with configured failover
- def ensuring(cond: (MongoConnection) => Boolean, msg: => Any): MongoConnection
- Implicit
- This member is added by an implicit conversion from MongoConnection toEnsuring[MongoConnection] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (MongoConnection) => Boolean): MongoConnection
- Implicit
- This member is added by an implicit conversion from MongoConnection toEnsuring[MongoConnection] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): MongoConnection
- Implicit
- This member is added by an implicit conversion from MongoConnection toEnsuring[MongoConnection] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): MongoConnection
- Implicit
- This member is added by an implicit conversion from MongoConnection toEnsuring[MongoConnection] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from MongoConnection toStringFormat[MongoConnection] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val options: MongoConnectionOptions
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- MongoConnection → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- val actorSystem: ActorSystem
- Annotations
- @deprecated
- Deprecated
(Since version 0.14.0) Internal: will be made private
- def askClose()(implicit timeout: FiniteDuration): Future[_]
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.4) Use
close
- def authenticate(db: String, user: String, password: String): Future[SuccessfulAuthentication]
- Annotations
- @deprecated
- Deprecated
(Since version 0.14.0) Use
authenticate
withfailoverStrategy
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.
- val mongosystem: ActorRef
- Annotations
- @deprecated
- Deprecated
(Since version 0.17.0) Internal: will be made private
- val name: String
- Annotations
- @deprecated
- Deprecated
(Since version 0.17.0) Internal: will be made private
- val supervisor: String
- Annotations
- @deprecated
- Deprecated
(Since version 0.17.0) Internal: will be made private
- def →[B](y: B): (MongoConnection, B)
- Implicit
- This member is added by an implicit conversion from MongoConnection toArrowAssoc[MongoConnection] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.