Packages

t

reactivemongo.api.collections

GenericCollection

trait GenericCollection[P <: SerializationPack with Singleton] extends Collection with GenericCollectionWithCommands[P] with CollectionMetaCommands with ImplicitCommandHelpers[P] with InsertOps[P] with UpdateOps[P] with Aggregator[P] with GenericCollectionMetaCommands[P]

A Collection that provides default methods using a SerializationPack (e.g. the default reactivemongo.api.BSONSerializationPack).

Some methods of this collection accept instances of Reader[T] and Writer[T], that transform any T instance into a document, compatible with the selected serialization pack, and vice-versa.

P

the serialization pack

Self Type
GenericCollection[P]
Linear Supertypes
GenericCollectionMetaCommands[P], collections.Aggregator[P], CommandCodecs[P], UpdateOps[P], InsertOps[P], ImplicitCommandHelpers[P], CollectionMetaCommands, GenericCollectionWithCommands[P], Collection, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GenericCollection
  2. GenericCollectionMetaCommands
  3. Aggregator
  4. CommandCodecs
  5. UpdateOps
  6. InsertOps
  7. ImplicitCommandHelpers
  8. CollectionMetaCommands
  9. GenericCollectionWithCommands
  10. Collection
  11. AnyRef
  12. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type AggregationFramework = AggregationFramework.type

    Alias for type of the aggregation framework, depending on the type of the collection.

    Alias for type of the aggregation framework, depending on the type of the collection.

    See also

    reactivemongo.api.commands.AggregationFramework

  2. final class Aggregator[T, AC[_] <: Cursor[_]] extends AnyRef
    Definition Classes
    Aggregator
  3. final class AggregatorContext[T] extends AnyRef
    Definition Classes
    Aggregator
  4. sealed trait InsertBuilder[T] extends AnyRef

    Builder for insert operations.

    Builder for insert operations.

    Definition Classes
    InsertOps
  5. type PipelineOperator = commands.AggregationFramework.PipelineOperator

    Alias for reactivemongo.api.commands.AggregationFramework.PipelineOperator

  6. sealed trait UpdateBuilder extends AnyRef

    Builder for update operations.

    Builder for update operations.

    Definition Classes
    UpdateOps
  7. trait ImplicitlyDocumentProducer extends AnyRef
    Definition Classes
    ImplicitCommandHelpers
  8. sealed trait BulkMaker[R, S <: BulkMaker[R, S]] extends AnyRef
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Unused

  9. class Mongo26WriteCommand extends BulkMaker[WriteResult, Mongo26WriteCommand]
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Unused

Abstract Value Members

  1. abstract val BatchCommands: BatchCommands[pack.type]
    Attributes
    protected
  2. abstract def db: DB

    The database which this collection belong to.

    The database which this collection belong to.

    Definition Classes
    Collection
  3. abstract def failoverStrategy: FailoverStrategy

    The default failover strategy for the methods of this collection.

    The default failover strategy for the methods of this collection.

    Definition Classes
    GenericCollectionCollection
  4. abstract def genericQueryBuilder: GenericQueryBuilder[pack.type]
  5. abstract def name: String

    The name of the collection.

    The name of the collection.

    Definition Classes
    Collection
  6. abstract val pack: P
    Definition Classes
    GenericCollection → CommandCodecs → UpdateOps → InsertOps → ImplicitCommandHelpersGenericCollectionWithCommands
  7. abstract def withReadPreference(pref: ReadPreference): GenericCollection[P]

    Returns a new reference to the same collection, with the given read preference.

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
    This member is added by an implicit conversion from GenericCollection[P] to any2stringadd[GenericCollection[P]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GenericCollection[P], B)
    Implicit
    This member is added by an implicit conversion from GenericCollection[P] to ArrowAssoc[GenericCollection[P]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def MissingMetadata(): ConnectionNotInitialized
    Attributes
    protected
    Annotations
    @inline()
  7. implicit def PackIdentityReader: P.Reader[P.Document]
  8. implicit def PackIdentityWriter: P.Writer[P.Document]
  9. def aggregate(firstOperator: PipelineOperator, otherOperators: List[PipelineOperator] = Nil, explain: Boolean = false, allowDiskUse: Boolean = false, bypassDocumentValidation: Boolean = false, readConcern: Option[ReadConcern] = None)(implicit ec: ExecutionContext): Future[AggregationResult]

    Aggregates the matching documents.

    Aggregates the matching documents.

    import scala.concurrent.Future
    import scala.concurrent.ExecutionContext.Implicits.global
    
    import reactivemongo.bson._
    import reactivemongo.api.collections.bson.BSONCollection
    
    def populatedStates(cities: BSONCollection): Future[List[BSONDocument]] = {
      import cities.BatchCommands.AggregationFramework
      import AggregationFramework.{ Group, Match, SumField }
    
      cities.aggregate(Group(BSONString("$state"))(
        "totalPop" -> SumField("population")), List(
          Match(document("totalPop" ->
            document("$gte" -> 10000000L))))).map(_.documents)
    }
    firstOperator

    the first aggregation operator of the pipeline

    otherOperators

    the sequence of MongoDB aggregation operations

    explain

    if true indicates to return the information on the processing of the pipeline

    allowDiskUse

    if true enables writing to temporary files

    bypassDocumentValidation

    if true enables to bypass document validation during the operation

    readConcern

    the read concern

  10. def aggregateWith1[T](explain: Boolean = false, allowDiskUse: Boolean = false, bypassDocumentValidation: Boolean = false, readConcern: Option[ReadConcern] = None, readPreference: ReadPreference = ReadPreference.primary, batchSize: Option[Int] = None)(f: (AggregationFramework) ⇒ (PipelineOperator, List[PipelineOperator]))(implicit ec: ExecutionContext, reader: P.Reader[T], cf: CursorFlattener[Cursor], cp: CursorProducer[T]): ProducedCursor

    Aggregates the matching documents.

    Aggregates the matching documents.

    T

    The type of the result elements. An implicit Reader[T] typeclass for handling it has to be in the scope.

    explain

    if true indicates to return the information on the processing of the pipeline

    allowDiskUse

    if true enables writing to temporary files

    bypassDocumentValidation

    if true enables to bypass document validation during the operation

    readConcern

    the read concern

    readPreference

    the read preference for the result (default: primary)

    batchSize

    the batch size (for the aggregation cursor; if None use the default one)

    f

    the function to create the aggregation pipeline using the aggregation framework depending on the collection type

    reader

    the result reader

    cf

    the cursor flattener (by default use the builtin one)

  11. def aggregatorContext[T](firstOperator: PipelineOperator, otherOperators: List[PipelineOperator] = Nil, explain: Boolean = false, allowDiskUse: Boolean = false, bypassDocumentValidation: Boolean = false, readConcern: Option[ReadConcern] = None, readPreference: ReadPreference = ReadPreference.primary, batchSize: Option[Int] = None)(implicit reader: P.Reader[T]): AggregatorContext[T]

    Aggregates the matching documents.

    Aggregates the matching documents.

    T

    The type of the result elements. An implicit Reader[T] typeclass for handling it has to be in the scope.

    firstOperator

    the first aggregation operator of the pipeline

    otherOperators

    the sequence of MongoDB aggregation operations

    explain

    if true indicates to return the information on the processing of the pipeline

    allowDiskUse

    if true enables writing to temporary files

    bypassDocumentValidation

    if true enables to bypass document validation during the operation

    readConcern

    the read concern

    readPreference

    the read preference for the result

    reader

    the result reader

  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  14. def convertToCapped(size: Long, maxDocuments: Option[Int])(implicit ec: ExecutionContext): Future[Unit]

    Converts this collection to a capped one.

    Converts this collection to a capped one.

    size

    the size of the collection (number of bytes)

    maxDocuments

    the maximum number of documents this capped collection can contain

    Definition Classes
    CollectionMetaCommands
  15. def count[H](selector: Option[P.Document] = None, limit: Int = 0, skip: Int = 0, hint: Option[H] = None)(implicit h: (H) ⇒ Hint, ec: ExecutionContext): Future[Int]

    Counts the matching documents.

    Counts the matching documents.

    H

    The type of hint. An implicit H => Hint conversion has to be in the scope.

    selector

    the document selector (default: None to count all)

    limit

    the maximum number of matching documents to count

    skip

    the number of matching documents to skip before counting

    hint

    the index to use (either the index name or the index document)

    See also

    MongoDB documentation

  16. def create(autoIndexId: Boolean = true)(implicit ec: ExecutionContext): Future[Unit]

    Creates this collection.

    Creates this collection.

    The returned future will be completed with an error if this collection already exists.

    autoIndexId

    If true should automatically add an index on the _id field. By default, regular collections will have an indexed _id field, in contrast to capped collections. This MongoDB option is deprecated and will be removed in a future release.

    Definition Classes
    CollectionMetaCommands
  17. def createCapped(size: Long, maxDocuments: Option[Int], autoIndexId: Boolean = false)(implicit ec: ExecutionContext): Future[Unit]

    Creates this collection as a capped one.

    Creates this collection as a capped one.

    The returned future will be completed with an error if this collection already exists.

    size

    the size of the collection (number of bytes)

    maxDocuments

    the maximum number of documents this capped collection can contain

    autoIndexId

    If true should automatically add an index on the _id field. By default, regular collections will have an indexed _id field, in contrast to capped collections. This MongoDB option is deprecated and will be removed in a future release.

    Definition Classes
    CollectionMetaCommands
  18. def createView(name: String, operator: PipelineOperator, pipeline: Seq[PipelineOperator], collation: Option[Collation] = None, readPreference: ReadPreference = self.writePref)(implicit ec: ExecutionContext): Future[Unit]

    Creates a view on this collection, using an aggregation pipeline.

    Creates a view on this collection, using an aggregation pipeline.

    import coll.BatchCommands.AggregationFramework
    import AggregationFramework.{ Group, Match, SumField }
    
    // See http://docs.mongodb.org/manual/tutorial/aggregation-zip-code-data-set/#return-states-with-populations-above-10-million
    
    // Create 'myview'
    coll.createView(
      name = "myview",
      operator = Group(BSONString(f"$$state"))(
        "totalPop" -> SumField("population")),
    pipeline = Seq(
    Match(document("totalPop" -> document(f"$$gte" -> 10000000L)))))
    
    
    // Then the view can be resolved as any collection
    // (but won't be writeable)
    val view: BSONCollection = db("myview")
    name

    the name of the view to be created

    operator

    the first (required) operator for the aggregation pipeline

    pipeline

    the other pipeline operators

    collation

    the view collation

    Definition Classes
    GenericCollectionMetaCommands
    See also

    db.createView

  19. val defaultCursorBatchSize: Int
    Attributes
    protected
  20. def defaultWriteConcern: WriteConcern
    Attributes
    protected
    Annotations
    @inline()
  21. def distinct[T, M[_] <: Iterable[_]](key: String, selector: Option[P.Document] = None, readConcern: ReadConcern = ReadConcern.Local)(implicit reader: P.NarrowValueReader[T], ec: ExecutionContext, cbf: CanBuildFrom[M[_], T, M[T]]): Future[M[T]]

    Returns the distinct values for a specified field across a single collection.

    Returns the distinct values for a specified field across a single collection.

    T

    the element type of the distinct values

    M

    the container, that must be a scala.collection.Iterable

    key

    the field for which to return distinct values

    selector

    the document selector, that specifies the documents from which to retrieve the distinct values.

    readConcern

    the read concern

    val distinctStates = collection.distinct[String, Set]("state")
  22. def drop(failIfNotFound: Boolean)(implicit ec: ExecutionContext): Future[Boolean]

    Drops this collection.

    Drops this collection.

    If the collection existed and is successfully dropped, the returned future will be completed with true.

    If failIfNotFound is false and the collection doesn't exist, the returned future will be completed with false.

    Otherwise in case, the future will be completed with the encountered error.

    Definition Classes
    CollectionMetaCommands
  23. def ensuring(cond: (GenericCollection[P]) ⇒ Boolean, msg: ⇒ Any): GenericCollection[P]
    Implicit
    This member is added by an implicit conversion from GenericCollection[P] to Ensuring[GenericCollection[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: (GenericCollection[P]) ⇒ Boolean): GenericCollection[P]
    Implicit
    This member is added by an implicit conversion from GenericCollection[P] to Ensuring[GenericCollection[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean, msg: ⇒ Any): GenericCollection[P]
    Implicit
    This member is added by an implicit conversion from GenericCollection[P] to Ensuring[GenericCollection[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: Boolean): GenericCollection[P]
    Implicit
    This member is added by an implicit conversion from GenericCollection[P] to Ensuring[GenericCollection[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  29. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. def find[S, J](selector: S, projection: J)(implicit swriter: P.Writer[S], pwriter: P.Writer[J]): GenericQueryBuilder[pack.type]

    Finds the documents matching the given criteria (selector), with the projection applied.

    Finds the documents matching the given criteria (selector), with the projection applied.

    S

    The type of the selector. An implicit Writer[S] typeclass for handling it has to be in the scope.

    selector

    the document selector

    projection

    the projection document to select only a subset of each matching documents

    swriter

    the writer for the selector

    pwriter

    the writer for the projection

    returns

    A GenericQueryBuilder that you can use to to customize the query. You can obtain a cursor by calling the method reactivemongo.api.Cursor on this query builder.

    See also

    MongoDB documentation

  31. def find[S](selector: S)(implicit swriter: P.Writer[S]): GenericQueryBuilder[pack.type]

    Finds the documents matching the given criteria (selector).

    Finds the documents matching the given criteria (selector).

    S

    The type of the selector. An implicit Writer[S] typeclass for handling it has to be in the scope.

    selector

    the document selector

    swriter

    the writer for the selector

    returns

    A GenericQueryBuilder that you can use to to customize the query. You can obtain a cursor by calling the method reactivemongo.api.Cursor on this query builder.

    See also

    MongoDB documentation

  32. def findAndModify[S](selector: S, modifier: Modify, sort: Option[P.Document] = None, fields: Option[P.Document] = None)(implicit swriter: P.Writer[S], ec: ExecutionContext): Future[FindAndModifyResult]

    Applies a findAndModify operation.

    Applies a findAndModify operation. See findAndUpdate and findAndRemove convenient functions.

    val updateOp = collection.updateModifier(
      BSONDocument("$set" -> BSONDocument("age" -> 35)))
    
    val personBeforeUpdate: Future[Option[Person]] =
      collection.findAndModify(BSONDocument("name" -> "Joline"), updateOp).
      map(_.result[Person])
    
    val removedPerson: Future[Option[Person]] = collection.findAndModify(
      BSONDocument("name" -> "Jack"), collection.removeModifier).
      map(_.result[Person])
    selector

    the document selector

    modifier

    the modify operator to be applied

    sort

    the document indicating the sort criteria (default: None)

    fields

    the projection fields

    swriter

    the writer for the selector

  33. def findAndRemove[S](selector: S, sort: Option[P.Document] = None, fields: Option[P.Document] = None)(implicit swriter: P.Writer[S], ec: ExecutionContext): Future[FindAndModifyResult]

    Finds some matching document, and removes it (using findAndModify).

    Finds some matching document, and removes it (using findAndModify).

    val removed: Future[Person] = collection.findAndRemove(
      BSONDocument("name" -> "Foo")).map(_.result[Person])
    S

    The type of the selector. An implicit Writer[S] typeclass for handling it has to be in the scope.

    selector

    the document selector

    sort

    the document indicating the sort criteria

    fields

    the projection fields

    swriter

    the writer for the selector

  34. def findAndUpdate[S, T](selector: S, update: T, fetchNewObject: Boolean = false, upsert: Boolean = false, sort: Option[P.Document] = None, fields: Option[P.Document] = None)(implicit swriter: P.Writer[S], writer: P.Writer[T], ec: ExecutionContext): Future[FindAndModifyResult]

    Finds some matching document, and updates it (using findAndModify).

    Finds some matching document, and updates it (using findAndModify).

    val person: Future[BSONDocument] = collection.findAndUpdate(
      BSONDocument("name" -> "James"),
      BSONDocument("$set" -> BSONDocument("age" -> 17)),
      fetchNewObject = true) // on success, return the update document:
                             // { "age": 17 }
    selector

    the document selector

    update

    the update to be applied

    fetchNewObject

    the command result must be the new object instead of the old one.

    upsert

    if true, creates a new document if no document is matching, otherwise if at least one document matches, an update is applied

    sort

    the document indicating the sort criteria (default: None)

    fields

    the projection fields

    swriter

    the writer for the selector

    writer

    writerParam

  35. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GenericCollection[P] to StringFormat[GenericCollection[P]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  36. final def fullCollectionName: String

    Gets the full qualified name of this collection.

    Gets the full qualified name of this collection.

    Definition Classes
    Collection
    Annotations
    @inline()
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  38. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  39. def indexesManager(implicit ec: ExecutionContext): CollectionIndexesManager

    Returns an index manager for this collection.

    Returns an index manager for this collection.

    Definition Classes
    CollectionMetaCommands
  40. def insert[T](ordered: Boolean, writeConcern: WriteConcern)(implicit arg0: P.Writer[T]): InsertBuilder[T]

    Returns a builder for insert operations.

    Returns a builder for insert operations.

    T

    The type of the document to insert. An implicit Writer[T] typeclass for handling it has to be in the scope.

    ordered

    the ordered behaviour

    writeConcern

    the writer concern to be used

    collection.insert[MyDocType](true, aWriteConcern).one(singleDoc)
    
    collection.insert[MyDocType](true, aWriteConcern).one(multiDocs)
  41. def insert[T](ordered: Boolean)(implicit arg0: P.Writer[T]): InsertBuilder[T]

    Returns a builder for insert operations.

    Returns a builder for insert operations. Uses the default write concern.

    T

    The type of the document to insert. An implicit Writer[T] typeclass for handling it has to be in the scope.

    ordered

    the ordered behaviour

    collection.insert[MyDocType](ordered = true).one(singleDoc)
    
    collection.insert[MyDocType](ordered = true).one(multiDocs)
  42. def insert[T](document: T, writeConcern: WriteConcern = defaultWriteConcern)(implicit writer: P.Writer[T], ec: ExecutionContext): Future[WriteResult]

    Inserts a document into the collection and waits for the reactivemongo.api.commands.WriteResult.

    Inserts a document into the collection and waits for the reactivemongo.api.commands.WriteResult.

    T

    The type of the document to insert. An implicit Writer[T] typeclass for handling it has to be in the scope.

    document

    the document to insert

    writeConcern

    the writer concern to be used

    writer

    the writer to create the document to be inserted

    returns

    a future reactivemongo.api.commands.WriteResult that can be used to check whether the insertion was successful

    collection.insert(myDoc)
    
    // Equivalent to:
    collection.insert[MyDocType](true, defaultWriteConcern).one(document)
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. def readPreference: ReadPreference

    The default read preference

  48. def remove[S](selector: S, writeConcern: WriteConcern = defaultWriteConcern, firstMatchOnly: Boolean = false)(implicit swriter: P.Writer[S], ec: ExecutionContext): Future[WriteResult]

    Removes the matching document(s).

    Removes the matching document(s).

    S

    The type of the selector. An implicit Writer[S] typeclass for handling it has to be in the scope.

    selector

    the document selector

    writeConcern

    the writer concern to be used

    firstMatchOnly

    states whether only the first matched documents has to be removed from this collection.

    swriter

    the writer for the selector

    returns

    a future reactivemongo.api.commands.WriteResult that can be used to check whether the removal was successful

  49. lazy val removeModifier: Remove.type

    Returns a removal modifier, to be used with findAndModify.

    Returns a removal modifier, to be used with findAndModify.

    Annotations
    @transient()
  50. def runCommand[C <: CollectionCommand](command: C)(implicit writer: P.Writer[ResolvedCollectionCommand[C]]): CursorFetcher[pack.type, Cursor]
  51. def runCommand[R, C <: CollectionCommand with CommandWithResult[R]](command: C with CommandWithResult[R], readPreference: ReadPreference)(implicit writer: P.Writer[ResolvedCollectionCommand[C]], reader: P.Reader[R], ec: ExecutionContext): Future[R]
  52. def runValueCommand[A <: AnyVal, R <: BoxedAnyVal[A], C <: CollectionCommand with CommandWithResult[R]](command: C with CommandWithResult[R with BoxedAnyVal[A]], rp: ReadPreference)(implicit writer: P.Writer[ResolvedCollectionCommand[C]], reader: P.Reader[R], ec: ExecutionContext): Future[A]
  53. def runWithResponse[R, C <: CollectionCommand with CommandWithResult[R]](command: C with CommandWithResult[R], readPreference: ReadPreference)(implicit writer: P.Writer[ResolvedCollectionCommand[C]], reader: P.Reader[R], ec: ExecutionContext): Future[ResponseResult[R]]
  54. def runner: CommandWithPackRunner[pack.type]
  55. 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 name of another collection

    failoverStrategy

    the failover strategy to override the default one

    Definition Classes
    Collection
  56. def stats(scale: Int)(implicit ec: ExecutionContext): Future[CollStatsResult]

    Returns various information about this collection.

    Returns various information about this collection.

    scale

    the scale factor (for example, to get all the sizes in kilobytes)

    Definition Classes
    CollectionMetaCommands
  57. def stats()(implicit ec: ExecutionContext): Future[CollStatsResult]

    Returns various information about this collection.

    Returns various information about this collection.

    Definition Classes
    CollectionMetaCommands
  58. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  59. def toString(): String
    Definition Classes
    AnyRef → Any
  60. def update(ordered: Boolean, writeConcern: WriteConcern): UpdateBuilder

    Returns an update builder.

    Returns an update builder.

    collection.update(ordered, writeConcern).many(updates)
  61. def update(ordered: Boolean): UpdateBuilder

    Returns an update builder.

    Returns an update builder.

    // Equivalent to collection.update(query, update, ...)
    collection.update(ordered = true).
      one(query, update, upsert = false, multi = false)
  62. def update[S, T](selector: S, update: T, writeConcern: WriteConcern = defaultWriteConcern, upsert: Boolean = false, multi: Boolean = false)(implicit swriter: P.Writer[S], writer: P.Writer[T], ec: ExecutionContext): Future[UpdateWriteResult]

    Updates one or more documents matching the given selector with the given modifier or update object.

    Updates one or more documents matching the given selector with the given modifier or update object.

    S

    The type of the selector. An implicit Writer[S] typeclass for handling it has to be in the scope.

    T

    The type of the modifier or update object. An implicit Writer[T] typeclass for handling it has to be in the scope.

    selector

    the selector object, for finding the documents to update.

    update

    the modifier object (with special keys like $set) or replacement object.

    writeConcern

    the writer concern to be used

    upsert

    if true, creates a new document if no document is matching, otherwise if at least one document matches, an update is applied (defaults: false)

    multi

    states whether the update may be done on all the matching documents (default: false)

    swriter

    the writer for the selector

    writer

    the writer to create the document

    returns

    a future reactivemongo.api.commands.WriteResult that can be used to check whether the insertion was successful

  63. def updateModifier[U](update: U, fetchNewObject: Boolean = false, upsert: Boolean = false)(implicit updateWriter: P.Writer[U]): Update

    Returns an update modifier, to be used with findAndModify.

    Returns an update modifier, to be used with findAndModify.

    update

    the update to be applied

    fetchNewObject

    the command result must be the new object instead of the old one.

    upsert

    if true, creates a new document if no document is matching, otherwise if at least one document matches, an update is applied

  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  67. def watchFailure[T](future: ⇒ Future[T]): Future[T]
    Attributes
    protected
  68. def writePref: Primary.type
    Attributes
    protected
    Annotations
    @inline()
  69. def [B](y: B): (GenericCollection[P], B)
    Implicit
    This member is added by an implicit conversion from GenericCollection[P] to ArrowAssoc[GenericCollection[P]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
  70. object ImplicitlyDocumentProducer
    Definition Classes
    ImplicitCommandHelpers

Deprecated Value Members

  1. def aggregate[T](firstOperator: PipelineOperator, otherOperators: List[PipelineOperator], cursor: Option[commands.AggregationFramework.Cursor], explain: Boolean, allowDiskUse: Boolean, bypassDocumentValidation: Boolean, readConcern: Option[ReadConcern], readPreference: ReadPreference)(implicit ec: ExecutionContext, reader: P.Reader[T], cf: CursorFlattener[Cursor]): Cursor[T]

    Aggregates the matching documents.

    Aggregates the matching documents.

    import scala.concurrent.Future
    import scala.concurrent.ExecutionContext.Implicits.global
    
    import reactivemongo.bson._
    import reactivemongo.api.Cursor
    import reactivemongo.api.collections.bson.BSONCollection
    
    def populatedStates(cities: BSONCollection): Future[Cursor[BSONDocument]] =
      {
        import cities.BatchCommands.AggregationFramework
        import AggregationFramework.{
          Cursor => AggCursor, Group, Match, SumField
        }
    
        val cursor = AggCursor(batchSize = 1) // initial batch size
    
        cities.aggregate1[BSONDocument](Group(BSONString("$state"))(
          "totalPop" -> SumField("population")), List(
            Match(document("totalPop" ->
              document("$gte" -> 10000000L)))),
          cursor)
      }
    T

    The type of the result elements. An implicit Reader[T] typeclass for handling it has to be in the scope.

    firstOperator

    the first aggregation operator of the pipeline

    otherOperators

    the sequence of MongoDB aggregation operations

    cursor

    aggregation cursor option (optional)

    explain

    if true indicates to return the information on the processing of the pipeline

    allowDiskUse

    if true enables writing to temporary files

    bypassDocumentValidation

    if true enables to bypass document validation during the operation

    readConcern

    the read concern

    readPreference

    the read preference for the result

    reader

    the result reader

    cf

    the cursor flattener (by default use the builtin one)

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.3) Use aggregatorContext

  2. def aggregate1[T](firstOperator: PipelineOperator, otherOperators: List[PipelineOperator], explain: Boolean = false, allowDiskUse: Boolean = false, bypassDocumentValidation: Boolean = false, readConcern: Option[ReadConcern] = None, readPreference: ReadPreference = ReadPreference.primary, batchSize: Option[Int] = None)(implicit ec: ExecutionContext, reader: P.Reader[T], cf: CursorFlattener[Cursor]): Cursor[T]

    Aggregates the matching documents.

    Aggregates the matching documents.

    T

    The type of the result elements. An implicit Reader[T] typeclass for handling it has to be in the scope.

    firstOperator

    the first aggregation operator of the pipeline

    otherOperators

    the sequence of MongoDB aggregation operations

    explain

    if true indicates to return the information on the processing of the pipeline

    allowDiskUse

    if true enables writing to temporary files

    bypassDocumentValidation

    if true enables to bypass document validation during the operation

    readConcern

    the read concern

    readPreference

    the read preference for the result

    batchSize

    the batch size (for the aggregation cursor; if None use the default one)

    reader

    the result reader

    cf

    the cursor flattener (by default use the builtin one)

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.3) Use aggregatorContext

  3. def aggregateWith[T](explain: Boolean = false, allowDiskUse: Boolean = false, bypassDocumentValidation: Boolean = false, readConcern: Option[ReadConcern] = None, readPreference: ReadPreference = ReadPreference.primary, batchSize: Option[Int] = None)(f: (AggregationFramework) ⇒ (PipelineOperator, List[PipelineOperator]))(implicit ec: ExecutionContext, reader: P.Reader[T], cf: CursorFlattener[Cursor]): Cursor[T]

    Aggregates the matching documents.

    Aggregates the matching documents.

    T

    The type of the result elements. An implicit Reader[T] typeclass for handling it has to be in the scope.

    explain

    if true indicates to return the information on the processing of the pipeline

    allowDiskUse

    if true enables writing to temporary files

    bypassDocumentValidation

    if true enables to bypass document validation during the operation

    readConcern

    the read concern

    readPreference

    the read preference for the result (default: primary)

    batchSize

    the batch size (for the aggregation cursor; if None use the default one)

    f

    the function to create the aggregation pipeline using the aggregation framework depending on the collection type

    reader

    the result reader

    cf

    the cursor flattener (by default use the builtin one)

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.3) Use aggregateWith1

  4. 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

    the failover strategy to override the default one

    Definition Classes
    Collection
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13.0) Resolve the collection from DB

  5. def bulkInsert(documents: Stream[P.Document], ordered: Boolean, writeConcern: WriteConcern = defaultWriteConcern, bulkSize: Int, bulkByteSize: Int)(implicit ec: ExecutionContext): Future[MultiBulkWriteResult]

    ordered

    the ordered behaviour

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Use insert[T](ordered).many(documents, writeConcern)

  6. def bulkInsert(documents: Stream[P.Document], ordered: Boolean, writeConcern: WriteConcern)(implicit ec: ExecutionContext): Future[MultiBulkWriteResult]

    ordered

    the ordered behaviour

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Use insert[T](ordered).many(documents, writeConcern)

  7. def bulkInsert(documents: Stream[P.Document], ordered: Boolean)(implicit ec: ExecutionContext): Future[MultiBulkWriteResult]

    ordered

    the ordered behaviour

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Use insert[T](ordered).many(documents)

  8. def bulkInsert(ordered: Boolean, writeConcern: WriteConcern, bulkSize: Int, bulkByteSize: Int)(documents: ImplicitlyDocumentProducer*)(implicit ec: ExecutionContext): Future[MultiBulkWriteResult]

    ordered

    the ordered behaviour

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Use insert[T](ordered, writeConcern).many(documents)

  9. def bulkInsert(ordered: Boolean, writeConcern: WriteConcern)(documents: ImplicitlyDocumentProducer*)(implicit ec: ExecutionContext): Future[MultiBulkWriteResult]

    ordered

    the ordered behaviour

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Use insert[T](ordered, writeConcern).many(documents)

  10. def bulkInsert(ordered: Boolean)(documents: ImplicitlyDocumentProducer*)(implicit ec: ExecutionContext): Future[MultiBulkWriteResult]

    ordered

    the ordered behaviour

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Use insert[T](ordered).many(documents)

  11. def drop()(implicit ec: ExecutionContext): Future[Unit]

    Drops this collection.

    Drops this collection.

    The returned future will be completed with an error if this collection does not exist.

    Definition Classes
    CollectionMetaCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use drop(Boolean)

  12. def emptyCapped()(implicit ec: ExecutionContext): Future[Unit]

    If this collection is capped, removes all the documents it contains.

    If this collection is capped, removes all the documents it contains.

    Deprecated because it became an internal command, unavailable by default.

    Definition Classes
    CollectionMetaCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 0.9) Deprecated because emptyCapped became an internal command, unavailable by default.

  13. def rename(to: String, dropExisting: Boolean = false)(implicit ec: ExecutionContext): Future[Unit]

    Renames this collection.

    Renames this collection.

    to

    the new name of this collection

    dropExisting

    if a collection of name to already exists, then drops that collection before renaming this one

    returns

    a failure if the dropExisting option is false and the target collection already exists

    Definition Classes
    CollectionMetaCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.4) Use reactivemongo.api.DBMetaCommands.renameCollection on the admin database instead.

  14. def runCommand[R, C <: CollectionCommand with CommandWithResult[R]](command: C with CommandWithResult[R])(implicit writer: P.Writer[ResolvedCollectionCommand[C]], reader: P.Reader[R], ec: ExecutionContext): Future[R]
    Definition Classes
    GenericCollectionWithCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12-RC5) Use the alternative with ReadPreference

  15. def runValueCommand[A <: AnyVal, R <: BoxedAnyVal[A], C <: CollectionCommand with CommandWithResult[R]](command: C with CommandWithResult[R with BoxedAnyVal[A]])(implicit writer: P.Writer[ResolvedCollectionCommand[C]], reader: P.Reader[R], ec: ExecutionContext): Future[A]
    Definition Classes
    GenericCollectionWithCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12-RC5) Use the alternative with ReadPreference

  16. def runWithResponse[R, C <: CollectionCommand with CommandWithResult[R]](command: C with CommandWithResult[R])(implicit writer: P.Writer[ResolvedCollectionCommand[C]], reader: P.Reader[R], ec: ExecutionContext): Future[ResponseResult[R]]
    Definition Classes
    GenericCollectionWithCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12-RC5) Use the alternative with ReadPreference

  17. def uncheckedInsert[T](document: T)(implicit writer: P.Writer[T]): Unit

    Inserts a document into the collection without writeConcern.

    Inserts a document into the collection without writeConcern.

    Please note that you cannot be sure that the document has been effectively written and when (hence the Unit return type).

    T

    the type of the document to insert. An implicit Writer[T] typeclass for handling it has to be in the scope.

    document

    the document to insert.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use insert[T](Boolean)

  18. def uncheckedRemove[T](query: T, firstMatchOnly: Boolean = false)(implicit writer: P.Writer[T], ec: ExecutionContext): Unit

    Remove the matched document(s) from the collection without writeConcern.

    Remove the matched document(s) from the collection without writeConcern.

    Please note that you cannot be sure that the matched documents have been effectively removed and when (hence the Unit return type).

    T

    the type of the selector of documents to remove. An implicit Writer[T] typeclass for handling it has to be in the scope.

    query

    the selector of documents to remove.

    firstMatchOnly

    states whether only the first matched documents has to be removed from this collection.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use remove

  19. def uncheckedUpdate[S, U](selector: S, update: U, upsert: Boolean = false, multi: Boolean = false)(implicit selectorWriter: P.Writer[S], updateWriter: P.Writer[U]): Unit

    Updates one or more documents matching the given selector with the given modifier or update object.

    Updates one or more documents matching the given selector with the given modifier or update object.

    Please note that you cannot be sure that the matched documents have been effectively updated and when (hence the Unit return type).

    S

    the type of the selector object. An implicit Writer[S] typeclass for handling it has to be in the scope.

    U

    the type of the modifier or update object. An implicit Writer[U] typeclass for handling it has to be in the scope.

    selector

    the selector object, for finding the documents to update.

    update

    the modifier object (with special keys like $set) or replacement object.

    upsert

    states whether the update object should be inserted if no match found. Defaults to false.

    multi

    states whether the update may be done on all the matching documents.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use update(Boolean)

  20. object Mongo26WriteCommand
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Unused

Inherited from GenericCollectionMetaCommands[P]

Inherited from collections.Aggregator[P]

Inherited from CommandCodecs[P]

Inherited from UpdateOps[P]

Inherited from InsertOps[P]

Inherited from ImplicitCommandHelpers[P]

Inherited from CollectionMetaCommands

Inherited from GenericCollectionWithCommands[P]

Inherited from Collection

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GenericCollection[P] to any2stringadd[GenericCollection[P]]

Inherited by implicit conversion StringFormat from GenericCollection[P] to StringFormat[GenericCollection[P]]

Inherited by implicit conversion Ensuring from GenericCollection[P] to Ensuring[GenericCollection[P]]

Inherited by implicit conversion ArrowAssoc from GenericCollection[P] to ArrowAssoc[GenericCollection[P]]

Ungrouped