Collection

A MongoDB Collection. You should consider the default BSON implementation.

Example using the default implementation:

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))
      }
    }
  }
}

Linear Supertypes

AnyRef, Any

Known Subclasses

BSONCollection, GenericCollection

Abstract Value Members

abstract def db: DB

The database which this collection belong to.
abstract def failoverStrategy: FailoverStrategy

The default failover strategy for the methods of this collection.
abstract def name: String

The name of the collection.

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
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
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()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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.bson.BSONCollection).
failoverStrategy
Overrides the default strategy.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
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
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
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
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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()
def fullCollectionName: String

Gets the full qualified name of this collection.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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.bson.BSONCollection).
name
The other collection name.
failoverStrategy
Overrides the default strategy.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 →[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

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.bson.BSONCollection).
name
The other collection name.
failoverStrategy
Overrides the default strategy.

Annotations
@deprecated
Deprecated
(Since version 0.10) Consider using sibling instead

Related Doc: package api

trait Collection extends AnyRef

Abstract Value Members

abstract def db: DB

abstract def failoverStrategy: FailoverStrategy

abstract def name: String

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Collection, B)

final def ==(arg0: Any): Boolean

def as[C <: Collection](failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = ...): C

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (Collection) ⇒ Boolean, msg: ⇒ Any): Collection

def ensuring(cond: (Collection) ⇒ Boolean): Collection

def ensuring(cond: Boolean, msg: ⇒ Any): Collection

def ensuring(cond: Boolean): Collection

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

def fullCollectionName: String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (Collection, B)

Deprecated Value Members

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

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