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] = scala.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.

10. trait Command[Result] extends AnyRef

    A MongoDB Command.

11. trait CommandError extends Exception with ReactiveMongoException

    A generic command error.

12. trait CommandResultMaker[Result] extends AnyRef

    Handler for deserializing commands results.

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

    Mongo CR authenticate Command.

14. class DefaultCommandError extends Exception with BSONCommandError

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

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

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

    A failed authentication result

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

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

    Groups documents together to calulate aggregates on document collections.

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

    Groups documents together to calulate aggregates on document collections.

20. sealed trait GroupFunction extends AnyRef

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

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

    Groups documents together to calulate aggregates on document collections.

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

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

    Limts the number of documents that pass through the stream.

24. class MakableCommand extends AnyRef

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

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

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

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

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

28. sealed trait Modify extends AnyRef

    A modify operation, part of a FindAndModify command

29. sealed trait PipelineOperator extends AnyRef

    One of MongoDBs pipeline operators for aggregation.

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

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

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

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

33. case class ScramSha1Challenge(conversationId: Int, payload: Array[Byte]) extends Product with Serializable

34. case class ScramSha1FinalNegociation(conversationId: Int, payload: Array[Byte]) extends Command[SuccessfulAuthentication] with Product with Serializable

35. case class ScramSha1Initiate(user: String) extends Command[ScramSha1Challenge] with Product with Serializable

    Command to start with Mongo SCRAM-SHA1 authentication.

36. case class ScramSha1Negociation(serverSignature: Array[Byte], request: BSONDocument) extends Product with Serializable

37. case class ScramSha1StartNegociation(user: String, password: String, conversationId: Int, payload: Array[Byte], randomPrefix: String, startMessage: String) extends Command[Either[SuccessfulAuthentication, Array[Byte]]] with Product with Serializable

    Command to continue with Mongo SCRAM-SHA1 authentication.

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

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

    Sorts the stream based on the given fields.

40. sealed trait SortOrder extends AnyRef

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

41. sealed trait SuccessfulAuthentication extends AuthenticationResult

    A successful authentication result.

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

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

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

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

    A verbose successful authentication result (MongoDB >= 2.

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

47. class CollStats extends Command[CollStatsResult]

    Returns a document containing various information about a collection.

48. class ConvertToCapped extends Command[Boolean]

    Converts a regular collection into a capped one.

49. case class Count(collectionName: String, query: Option[BSONDocument] = scala.None, fields: Option[BSONDocument] = scala.None) extends Command[Int] with Product with Serializable

    The Count command.

50. class CreateCollection extends Command[Boolean]

    Creates a collection on the database.

51. case class DeleteIndex(collection: String, index: String) extends Command[Int] with Product with Serializable

    Annotations

    @deprecated

    Deprecated

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

52. class Drop extends Command[Boolean]

    Drop a collection.

53. class DropDatabase extends Command[Boolean]

    Drop a database.

54. class EmptyCapped extends Command[Boolean]

    Empty a capped collection.

55. case class FindAndModify(collection: String, query: BSONDocument, modify: Modify, upsert: Boolean = false, sort: Option[BSONDocument] = scala.None, fields: Option[BSONDocument] = scala.None) extends Command[Option[BSONDocument]] with Product with Serializable

    FindAndModify command.

56. case class GetLastError(j: Boolean = false, w: Option[BSONValue] = scala.None, wtimeout: Int = 0, fsync: Boolean = false) extends Command[LastError] with Product with Serializable

    GetLastError Command.

57. case class IsMasterResponse(isMaster: Boolean, secondary: Boolean, maxBsonObjectSize: Int, setName: Option[String], hosts: Option[Seq[String]], me: Option[String], tags: Option[BSONDocument]) extends Product with Serializable

    Deserialized IsMaster command response.

58. case class LastError(ok: Boolean, err: Option[String], code: Option[Int], errMsg: Option[String], originalDocument: Option[BSONDocument], updated: Int, updatedExisting: Boolean) extends Exception with DatabaseException with Product with Serializable

    Result of the GetLastError command.

59. case class RawCommand(bson: BSONDocument) extends Command[BSONDocument] with Product with Serializable

    Annotations

    @deprecated

    Deprecated

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

60. class RenameCollection extends AdminCommand[Boolean]

    Rename a collection.

61. case class Update(update: BSONDocument, fetchNewObject: Boolean) extends Modify with Product with Serializable

    Update (part of a FindAndModify command).