package commands
- Alphabetic
- By Inheritance
- commands
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- trait BSONCommandError extends Exception with CommandError
A command error that optionally holds the original TraversableBSONDocument
- trait BSONCommandResultMaker[Result] extends CommandResultMaker[Result]
- case class CappedOptions(size: Long, maxDocuments: Option[Int] = None) extends Product with Serializable
- 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.
- 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.
- trait CommandError extends Exception with ReactiveMongoException
A generic command error.
- trait CommandResultMaker[Result] extends AnyRef
Handler for deserializing commands results.
Handler for deserializing commands results.
- Result
The result type of this command.
- class DefaultCommandError extends Exception with BSONCommandError
A default command error, which may contain the original BSONDocument of the response.
- class MakableCommand extends AnyRef
A makable command, that can produce a request maker ready to be sent to a reactivemongo.core.actors.MongoDBSystem actor.
- sealed trait ScramFinalNegociation extends Command[SuccessfulAuthentication]
Deprecated Type Members
- case class AddToSet(field: String) extends GroupFunction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Aggregate(collectionName: String, pipeline: Seq[PipelineOperator]) extends Command[Stream[BSONDocument]] with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Ascending(field: String) extends SortOrder with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- sealed trait AuthenticationResult extends AnyRef
An authentication result
An authentication result
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Internal: will be made private
- case class Avg(field: String) extends GroupFunction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Descending(field: String) extends SortOrder with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- sealed abstract class FailedAuthentication extends Exception with BSONCommandError with AuthenticationResult with Product with Serializable
A failed authentication result
A failed authentication result
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.1) Internal: will be made private
- case class First(field: String) extends GroupFunction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Group(identifiers: BSONValue)(ops: (String, GroupFunction)*) extends PipelineOperator with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class GroupField(idField: String)(ops: (String, GroupFunction)*) extends PipelineOperator with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- sealed trait GroupFunction extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class GroupMulti(idField: (String, String)*)(ops: (String, GroupFunction)*) extends PipelineOperator with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Last(field: String) extends GroupFunction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Limit(limit: Int) extends PipelineOperator with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Match(predicate: BSONDocument) extends PipelineOperator with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Max(field: String) extends GroupFunction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Min(field: String) extends GroupFunction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- sealed trait PipelineOperator extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Project(fields: (String, BSONValue)*) extends PipelineOperator with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Push(field: String) extends GroupFunction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class PushMulti(fields: (String, String)*) extends GroupFunction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class ReplaceRoot(newRoot: BSONDocument) extends PipelineOperator with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class ReplaceRootField(newRoot: String) extends PipelineOperator with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Skip(skip: Int) extends PipelineOperator with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Sort(fields: Seq[SortOrder]) extends PipelineOperator with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- sealed trait SortOrder extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- sealed trait SuccessfulAuthentication extends AuthenticationResult
A successful authentication result.
A successful authentication result.
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Internal: will be made private
- case class SumField(field: String) extends GroupFunction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class SumValue(value: Int) extends GroupFunction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- case class Unwind(field: String) extends PipelineOperator with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- 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.
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Internal: will be made private
Value Members
- object CollStatsResult extends BSONCommandResultMaker[CollStatsResult] with Serializable
- object CommandError extends Serializable
- object FailedAuthentication extends AbstractFunction2[String, Option[BSONDocument], FailedAuthentication] with Serializable
Deprecated Value Members
- object Aggregate extends BSONCommandResultMaker[Stream[BSONDocument]] with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- object CrAuthenticate extends BSONCommandResultMaker[SuccessfulAuthentication] with Serializable
Authentication command's response deserializer.
Authentication command's response deserializer.
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Internal: will be made private
- object GetCrNonce extends Command[String]
Getnonce Command for Mongo CR authentication.
Getnonce Command for Mongo CR authentication.
Gets a nonce for authentication token.
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Internal: will be made private
- object GroupFunction
- Annotations
- @deprecated
- Deprecated
(Since version 0.12-RC5) Use reactivemongo.api.collections.GenericCollection.aggregateWith
- object ScramSha1FinalNegociation extends BSONCommandResultMaker[SuccessfulAuthentication] with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.18.4) Unused
- object ScramSha1Initiate extends BSONCommandResultMaker[ScramChallenge[ScramSha1Authentication.type]] with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.18.4) Internal: will be made private
- object ScramSha1Negociation extends Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.18.4) Internal: will be made private
- object ScramSha1StartNegociation extends BSONCommandResultMaker[Either[SuccessfulAuthentication, Array[Byte]]] with Serializable
- Annotations
- @deprecated @SerialVersionUID()
- Deprecated
(Since version 0.18.4) Internal: will be made private
- object SilentSuccessfulAuthentication extends SuccessfulAuthentication
A silent successful authentication result (MongoDB <= 2.0).
A silent successful authentication result (MongoDB <= 2.0).
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Internal: will be made private
- object X509Authenticate extends BSONCommandResultMaker[SuccessfulAuthentication] with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Internal: will be made private