commands

Type Members

1. case class AddToSet(field: String) extends GroupFunction with Product with Serializable

   

2. trait AdminCommand[Result] extends Command[Result]

   

   A command that targets the admin database only (administrative commands).

3. case class Ascending(field: String) extends SortOrder with Product with Serializable

   

4. sealed trait AuthenticationResult extends AnyRef

   

   an authentication result

5. case class Avg(field: String) extends GroupFunction with Product with Serializable

   

6. trait BSONCommandError extends Exception with CommandError

   

   A command error that optionally holds the original TraversableBSONDocument

7. trait BSONCommandResultMaker[Result] extends CommandResultMaker[Result]

   

8. case class CappedOptions(size: Long, maxDocuments: Option[Int] = None) extends Product with Serializable

   

9. case class CollStatsResult(ns: String, count: Int, size: Double, averageObjectSize: Option[Double], storageSize: Double, numExtents: Int, nindexes: Int, lastExtentSize: Option[Int], paddingFactor: Option[Double], systemFlags: Option[Int], userFlags: Option[Int], totalIndexSize: Int, indexSizes: Array[(String, Int)], capped: Boolean, max: Option[Long]) extends Product with Serializable

   

   Various information about a collection.

   Various information about a collection.

   ns

   The fully qualified collection name.

   count

   The number of documents in this collection.

   size

   The size in bytes (or in bytes / scale, if any).

   averageObjectSize

   The average object size in bytes (or in bytes / scale, if any).

   storageSize

   Preallocated space for the collection.

   numExtents

   Number of extents (contiguously allocated chunks of datafile space).

   nindexes

   Number of indexes.

   lastExtentSize

   Size of the most recently created extent.

   paddingFactor

   Padding can speed up updates if documents grow.

   systemFlags

   System flags.

   userFlags

   User flags.

   indexSizes

   Size of specific indexes in bytes.

   capped

   States if this collection is capped.

   max

   The maximum number of documents of this collection, if capped.

10. trait Command[Result] extends AnyRef

    

    A MongoDB Command.

    A MongoDB Command.

    Basically, it's as query that is performed on any db.$cmd collection and gives back one document as a result.

11. trait CommandError extends Exception with ReactiveMongoException

    

    A generic command error.

12. trait CommandResultMaker[Result] extends AnyRef

    

    Handler for deserializing commands results.

    Handler for deserializing commands results.

    Result

    The result type of this command.

13. class DefaultCommandError extends Exception with BSONCommandError

    

    A default command error, which may contain the original BSONDocument of the response.

14. case class Descending(field: String) extends SortOrder with Product with Serializable

    

15. case class FailedAuthentication(message: String, originalDocument: Option[BSONDocument] = None) extends Exception with BSONCommandError with AuthenticationResult with Product with Serializable

    

    A failed authentication result

    A failed authentication result

    message

    the explanation of the error

16. case class First(field: String) extends GroupFunction with Product with Serializable

    

17. case class Group(identifiers: BSONValue)(ops: (String, GroupFunction)*) extends PipelineOperator with Product with Serializable

    

    Groups documents together to calculate aggregates on document collections.

    Groups documents together to calculate aggregates on document collections. This command aggregates on arbitrary identifiers. Document fields identifier must be prefixed with $. http://docs.mongodb.org/manual/reference/aggregation/group/#_S_group

    identifiers

    Any BSON value acceptable by mongodb as identifier

    ops

    Sequence of operators specifying aggregate calculation.

18. case class GroupField(idField: String)(ops: (String, GroupFunction)*) extends PipelineOperator with Product with Serializable

    

    Groups documents together to calculate aggregates on document collections.

    Groups documents together to calculate aggregates on document collections. This command aggregates on one field. http://docs.mongodb.org/manual/reference/aggregation/group/#_S_group

    idField

    Name of the field to aggregate on.

    ops

    Sequence of operators specifying aggregate calculation.

19. sealed trait GroupFunction extends AnyRef

    

    Represents one of the group operators for the "Group" Operation.

    Represents one of the group operators for the "Group" Operation. This class is sealed as these are defined in the MongoDB spec, and clients should not need to customise these.

20. case class GroupMulti(idField: (String, String)*)(ops: (String, GroupFunction)*) extends PipelineOperator with Product with Serializable

    

    Groups documents together to calculate aggregates on document collections.

    Groups documents together to calculate aggregates on document collections. This command aggregates on multiple fields, and they must be named. http://docs.mongodb.org/manual/reference/aggregation/group/#_S_group

    idField

    Fields to aggregate on, and the names they should be aggregated under.

    ops

    Sequence of operators specifying aggregate calculation.

21. case class Last(field: String) extends GroupFunction with Product with Serializable

    

22. case class Limit(limit: Int) extends PipelineOperator with Product with Serializable

    

    Limts the number of documents that pass through the stream.

    Limts the number of documents that pass through the stream. http://docs.mongodb.org/manual/reference/aggregation/limit/#_S_limit

    limit

    Number of documents to allow through.

23. class MakableCommand extends AnyRef

    

    A makable command, that can produce a request maker ready to be sent to a reactivemongo.core.actors.MongoDBSystem actor.

24. case class Match(predicate: BSONDocument) extends PipelineOperator with Product with Serializable

    

    Filters out documents from the stream that do not match the predicate.

    Filters out documents from the stream that do not match the predicate. http://docs.mongodb.org/manual/reference/aggregation/match/#_S_match

    predicate

    Query that documents must satisfy to be in the stream.

25. case class Max(field: String) extends GroupFunction with Product with Serializable

    

26. case class Min(field: String) extends GroupFunction with Product with Serializable

    

27. sealed trait Modify extends AnyRef

    

    A modify operation, part of a FindAndModify command

28. sealed trait PipelineOperator extends AnyRef

    

    One of MongoDBs pipeline operators for aggregation.

    One of MongoDBs pipeline operators for aggregation. Sealed as these are defined in the mongodb spec, and clients should not have custom operators.

29. case class Project(fields: (String, BSONValue)*) extends PipelineOperator with Product with Serializable

    

    Reshapes a document stream by renaming, adding, or removing fields.

    Reshapes a document stream by renaming, adding, or removing fields. Also use "Project" to create computed values or sub-objects. http://docs.mongodb.org/manual/reference/aggregation/project/#_S_project

    fields

    Fields to include. The resulting objects will contain only these fields

30. case class Push(field: String) extends GroupFunction with Product with Serializable

    

31. case class PushMulti(fields: (String, String)*) extends GroupFunction with Product with Serializable

    

32. case class ReplaceRoot(newRoot: BSONDocument) extends PipelineOperator with Product with Serializable

    

    Promotes a specified document to the top level and replaces all other fields.

    Promotes a specified document to the top level and replaces all other fields. The operation replaces all existing fields in the input document, including the _id field. https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot

    newRoot

    The new root object

33. case class ReplaceRootField(newRoot: String) extends PipelineOperator with Product with Serializable

    

    Promotes a specified document to the top level and replaces all other fields.

    Promotes a specified document to the top level and replaces all other fields. The operation replaces all existing fields in the input document, including the _id field. https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot

    newRoot

    The field name to become the new root

34. case class Skip(skip: Int) extends PipelineOperator with Product with Serializable

    

    Skips over a number of documents before passing all further documents along the stream.

    Skips over a number of documents before passing all further documents along the stream. http://docs.mongodb.org/manual/reference/aggregation/skip/#_S_skip

    skip

    Number of documents to skip.

35. case class Sort(fields: Seq[SortOrder]) extends PipelineOperator with Product with Serializable

    

    Sorts the stream based on the given fields.

    Sorts the stream based on the given fields. http://docs.mongodb.org/manual/reference/aggregation/sort/#_S_sort

    fields

    Fields to sort by.

36. sealed trait SortOrder extends AnyRef

    

    Represents that a field should be sorted on, as well as whether it should be ascending or descending.

37. sealed trait SuccessfulAuthentication extends AuthenticationResult

    

    A successful authentication result.

38. case class SumField(field: String) extends GroupFunction with Product with Serializable

    

39. case class SumValue(value: Int) extends GroupFunction with Product with Serializable

    

40. case class Unwind(field: String) extends PipelineOperator with Product with Serializable

    

    Turns a document with an array into multiple documents, one document for each element in the array.

    Turns a document with an array into multiple documents, one document for each element in the array. http://docs.mongodb.org/manual/reference/aggregation/unwind/#_S_unwind

    field

    Name of the array to unwind.

41. case class VerboseSuccessfulAuthentication(db: String, user: String, readOnly: Boolean) extends SuccessfulAuthentication with Product with Serializable

    

    A verbose successful authentication result (MongoDB >= 2.2).

    A verbose successful authentication result (MongoDB >= 2.2).

    Previous versions of MongoDB only return ok = BSONDouble(1.0).

    db

    the database name

    user

    the user name

    readOnly

    states if the authentication gives us only the right to read from the database.

42. case class Aggregate(collectionName: String, pipeline: Seq[PipelineOperator]) extends Command[Stream[BSONDocument]] with Product with Serializable

    

    Implements the "aggregation" command, otherwise known as the "Aggregation Framework." http://docs.mongodb.org/manual/applications/aggregation/

    Implements the "aggregation" command, otherwise known as the "Aggregation Framework." http://docs.mongodb.org/manual/applications/aggregation/

    collectionName

    Collection to aggregate against

    pipeline

    Sequence of MongoDB aggregation operations.

    Annotations

    @deprecated

    Deprecated

    (Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith

43. case class Authenticate(user: String, password: String, nonce: String) extends Command[SuccessfulAuthentication] with Product with Serializable

    

    Annotations

    @deprecated

    Deprecated

    (Since version 0.11.10) See CrAuthenticate

44. class DropDatabase extends Command[Boolean]

    

    Drop a database.

    Drop a database.

    Annotations

    @deprecated

    Deprecated

    (Since version 0.11.0) consider using reactivemongo.api.commands.DropDatabase instead