Package

reactivemongo

api

Permalink

package api

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. api
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait AuthenticationMode extends AnyRef

    Permalink

    Then mode of authentication against the replica set.

  2. trait Collection extends AnyRef

    Permalink

    A MongoDB Collection.

    A MongoDB Collection. You should consider the generic API (reactivemongo.api.collections.GenericCollection) and the default reactivemongo.api.collections.bson.BSONCollection.

    import reactivemongo.bson._
    import reactivemongo.api.collections.bson.BSONCollection
    
    object Samples {
    
      val connection = MongoConnection(List("localhost"))
    
      // Gets a reference to the database "plugin"
      val db = connection("plugin")
    
      // Gets a reference to the collection "acoll"
      // By default, you get a BSONCollection.
      val collection = db[BSONCollection]("acoll")
    
      def listDocs() = {
        // Select only the documents which field 'firstName' equals 'Jack'
        val query = BSONDocument("firstName" -> "Jack")
        // select only the field 'lastName'
        val filter = BSONDocument(
          "lastName" -> 1,
          "_id" -> 0)
    
        // Get a cursor of BSONDocuments
        val cursor = collection.find(query, filter).cursor[BSONDocument]
        // Let's enumerate this cursor and print a readable representation of each document in the response
        cursor.enumerate().apply(Iteratee.foreach { doc =>
          println("found document: " + BSONDocument.pretty(doc))
        })
    
        // Or, the same with getting a list
        val cursor2 = collection.find(query, filter).cursor[BSONDocument]
        val futureList = cursor.collect[List]()
        futureList.map { list =>
          list.foreach { doc =>
            println("found document: " + BSONDocument.pretty(doc))
          }
        }
      }
    }
  3. trait CollectionMetaCommands extends AnyRef

    Permalink

    A mixin that provides commands about this Collection itself.

  4. trait CollectionProducer[+C <: Collection] extends AnyRef

    Permalink

    A Producer of Collection implementation.

    A Producer of Collection implementation.

    This is used to get an implementation implicitly when getting a reference of a Collection.

  5. trait Cursor[T] extends AnyRef

    Permalink

    Cursor over results from MongoDB.

    Cursor over results from MongoDB.

    T

    the type parsed from each result document

  6. trait CursorFlattener[C[_] <: Cursor[_]] extends AnyRef

    Permalink

    Flattening strategy for cursor.

  7. trait CursorProducer[T] extends AnyRef

    Permalink

    Allows to enrich a base cursor.

  8. sealed trait DB extends AnyRef

    Permalink

    A Mongo Database.

    A Mongo Database.

    You should consider the provided reactivemongo.api.DefaultDB implementation.

    Example:

    import reactivemongo.api._
    
    val connection = MongoConnection( List( "localhost:27016" ) )
    val db = connection.database("plugin")
    val collection = db("acoll")
  9. trait DBMetaCommands extends AnyRef

    Permalink

    A mixin that provides commands about this database itself.

  10. case class DefaultDB(name: String, connection: MongoConnection, failoverStrategy: FailoverStrategy = FailoverStrategy()) extends DB with DBMetaCommands with GenericDB[BSONSerializationPack.type] with Product with Serializable

    Permalink

    The default DB implementation, that mixes in the database traits.

  11. class Failover[T] extends AnyRef

    Permalink

    A helper that sends the given message to the given actor, following a failover strategy.

    A helper that sends the given message to the given actor, following a failover strategy. This helper holds a future reference that is completed with a response, after 1 or more attempts (specified in the given strategy). If the all the tryouts configured by the given strategy were unsuccessful, the future reference is completed with a Throwable.

    Should not be used directly for most use cases.

    T

    Type of the message to send.

  12. case class FailoverStrategy(initialDelay: FiniteDuration = FiniteDuration(100, "ms"), retries: Int = 8, delayFactor: (Int) ⇒ Double = _ * 1.25D) extends Product with Serializable

    Permalink

    A failover strategy for sending requests.

    A failover strategy for sending requests. The default uses 8 retries: 125ms, 250ms, 375ms, 500ms, 625ms, 750ms, 875ms, 1s

    initialDelay

    the initial delay between the first failed attempt and the next one.

    retries

    the number of retries to do before giving up.

    delayFactor

    a function that takes the current iteration and returns a factor to be applied to the initialDelay.

  13. class FlattenedCursor[T] extends Cursor[T]

    Permalink
  14. trait GenericDB[P <: SerializationPack with Singleton] extends AnyRef

    Permalink
  15. class MongoConnection extends AnyRef

    Permalink

    A pool of MongoDB connections.

    A pool of MongoDB connections.

    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 reactivemongo.api._
    
    val connection = MongoConnection(List("localhost"))
    val db = connection.database("plugin")
    val collection = db.map(_.("acoll"))
  16. case class MongoConnectionOptions(connectTimeoutMS: Int = 0, authSource: Option[String] = None, sslEnabled: Boolean = false, sslAllowsInvalidCert: Boolean = false, authMode: AuthenticationMode = CrAuthentication, tcpNoDelay: Boolean = false, keepAlive: Boolean = false, nbChannelsPerNode: Int = 10, writeConcern: WriteConcern = WriteConcern.Default, readPreference: ReadPreference = ReadPreference.primary, failoverStrategy: FailoverStrategy = FailoverStrategy.default, monitorRefreshMS: Int = 10000, socketTimeoutMS: Int = 0) extends Product with Serializable

    Permalink

    Options for MongoConnection.

    Options for MongoConnection.

    connectTimeoutMS

    The number of milliseconds to wait for a connection to be established before giving up.

    authSource

    The database source for authentication credentials.

    sslEnabled

    Enable SSL connection (required to be accepted on server-side).

    sslAllowsInvalidCert

    If sslEnabled is true, this one indicates whether to accept invalid certificates (e.g. self-signed).

    authMode

    Either CrAuthentication or ScramSha1Authentication

    tcpNoDelay

    TCPNoDelay flag (ReactiveMongo-specific option). The default value is false (see TCP_NODELAY).

    keepAlive

    TCP KeepAlive flag (ReactiveMongo-specific option). The default value is false (see SO_KEEPALIVE).

    nbChannelsPerNode

    Number of channels (connections) per node (ReactiveMongo-specific option).

    writeConcern

    the default write concern

    readPreference

    the default read preference

    failoverStrategy

    the default failover strategy

    monitorRefreshMS

    the interval in milliseconds used by monitor to refresh the node set (default: 10000)

    socketTimeoutMS

    the time in milliseconds to attempt a send or receive on a socket before the attempt times out (default: 0 for no timeout)

  17. class MongoDriver extends AnyRef

    Permalink

  18. case class QueryOpts(skipN: Int = 0, batchSizeN: Int = 0, flagsN: Int = 0) extends Product with Serializable

    Permalink

    A helper to make the query options.

    A helper to make the query options. You may use the methods to set the fields of this class, or set them directly.

    skipN

    the number of documents to skip.

    batchSizeN

    the upper limit on the number of documents to retrieve per batch.

    flagsN

    the query flags

  19. sealed trait ReadConcern extends AnyRef

    Permalink
  20. sealed trait ReadPreference extends AnyRef

    Permalink

    MongoDB Read Preferences enable to read from primary or secondaries with a predefined strategy.

  21. trait SerializationPack extends AnyRef

    Permalink
  22. type SerializationPackObject = SerializationPack with Singleton

    Permalink
  23. trait WrappedCursor[T] extends Cursor[T]

    Permalink

    Cursor wrapper, to help to define custom cursor classes.

    Cursor wrapper, to help to define custom cursor classes.

    See also

    CursorProducer

  24. class Failover2[A] extends AnyRef

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.11) Will be made private

  25. sealed trait SortOrder extends AnyRef

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.10) Will be removed

Value Members

  1. object BSONSerializationPack extends SerializationPack

    Permalink

    The default serialization pack.

  2. object CrAuthentication extends AuthenticationMode with Product with Serializable

    Permalink

    MongoDB-CR authentication

  3. object Cursor

    Permalink

    Cursor companion object

  4. object CursorFlattener

    Permalink

    Flatteners helper

  5. object CursorProducer

    Permalink
  6. object DB

    Permalink
  7. object DefaultCursor

    Permalink
  8. object Failover2

    Permalink
  9. object FailoverStrategy extends Serializable

    Permalink
  10. object MongoConnection

    Permalink
  11. object MongoDriver

    Permalink

    The driver factory

  12. object ReadConcern

    Permalink
  13. object ReadPreference

    Permalink
  14. object ScramSha1Authentication extends AuthenticationMode with Product with Serializable

    Permalink

    SCRAM-SHA-1 authentication (see MongoDB 3.0)

  15. package collections

    Permalink
  16. package commands

    Permalink
  17. package gridfs

    Permalink
  18. package indexes

    Permalink

Deprecated Value Members

  1. object Failover

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.10) Unused

  2. object SortOrder

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.10) Will be removed

Inherited from AnyRef

Inherited from Any

Ungrouped