reactivemongo.api

Collection

trait Collection extends AnyRef

A MongoDB Collection. You should consider the default implementation, reactivemongo.api.collections.default.BSONCollection.

Example using the default implementation (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("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))
    }
  }
}
}
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Collection
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def db: DB

    The database which this collection belong to.

  2. abstract def failoverStrategy: FailoverStrategy

    The default failover strategy for the methods of this collection.

  3. abstract def name: String

    The name of the collection.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Collection to any2stringadd[Collection] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Collection, B)

    Implicit information
    This member is added by an implicit conversion from Collection to ArrowAssoc[Collection] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. def as[C <: Collection](failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = ...): C

    Gets another implementation of this collection.

    Gets another implementation of this collection. An implicit CollectionProducer[C] must be present in the scope, or it will be the default implementation (reactivemongo.api.collections.default.BSONCollection).

    failoverStrategy

    Overrides the default strategy.

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def ensuring(cond: (Collection) ⇒ Boolean, msg: ⇒ Any): Collection

    Implicit information
    This member is added by an implicit conversion from Collection to Ensuring[Collection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Collection) ⇒ Boolean): Collection

    Implicit information
    This member is added by an implicit conversion from Collection to Ensuring[Collection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): Collection

    Implicit information
    This member is added by an implicit conversion from Collection to Ensuring[Collection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Collection

    Implicit information
    This member is added by an implicit conversion from Collection to Ensuring[Collection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Collection to StringFormat[Collection] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. def fullCollectionName: String

    Gets the full qualified name of this collection.

  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. def sibling[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = ...): C

    Gets another collection in the current database.

    Gets another collection in the current database. An implicit CollectionProducer[C] must be present in the scope, or it will be the default implementation (reactivemongo.api.collections.default.BSONCollection).

    name

    The other collection name.

    failoverStrategy

    Overrides the default strategy.

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  26. def toString(): String

    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def [B](y: B): (Collection, B)

    Implicit information
    This member is added by an implicit conversion from Collection to ArrowAssoc[Collection] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def sister[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = ...): C

    Gets another collection in the current database.

    Gets another collection in the current database. An implicit CollectionProducer[C] must be present in the scope, or it will be the default implementation (reactivemongo.api.collections.default.BSONCollection).

    name

    The other collection name.

    failoverStrategy

    Overrides the default strategy.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.10) Consider using sibling instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Collection to any2stringadd[Collection]

Inherited by implicit conversion StringFormat from Collection to StringFormat[Collection]

Inherited by implicit conversion Ensuring from Collection to Ensuring[Collection]

Inherited by implicit conversion ArrowAssoc from Collection to ArrowAssoc[Collection]

Ungrouped