commands

Type Members

1. sealed trait AbstractCommand extends AnyRef

   

2. trait AggregationFramework[P <: SerializationPack] extends ImplicitCommandHelpers[P]

   

   Implements the Aggregation Framework.

3. trait BoxedAnyVal[A <: AnyVal] extends AnyRef

   

4. case class Capped(size: Long, max: Option[Int] = None) extends Product with Serializable

   

5. case class CollStats(scale: Option[Int] = None) extends CollectionCommand with CommandWithResult[CollStatsResult] with Product with Serializable

   

6. case class CollStatsResult(ns: String, count: Int, size: Double, averageObjectSize: Option[Double], storageSize: Double, numExtents: Option[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], maxSize: Option[Double] = None) 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, only for mmapv1 storage engine).

   nindexes

   Number of indexes.

   lastExtentSize

   Size of the most recently created extent (only for mmapv1 storage engine).

   paddingFactor

   Padding can speed up updates if documents grow (only for mmapv1 storage engine).

   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.

   maxSize

   The maximum size in bytes (or in bytes / scale, if any) of this collection, if capped.

7. trait CollectionCommand extends AbstractCommand

   

8. case class CollectionNames(names: List[String]) extends Product with Serializable

   

9. trait Command extends AbstractCommand

   

10. trait CommandError extends Exception with NoStackTrace

    

11. trait CommandWithPack[P <: SerializationPack] extends AnyRef

    

12. trait CommandWithResult[R] extends AnyRef

    

13. case class ConvertToCapped(capped: Capped) extends CollectionCommand with CommandWithResult[UnitBox.type] with Product with Serializable

    

14. trait CountCommand[P <: SerializationPack] extends ImplicitCommandHelpers[P]

    

15. case class Create(capped: Option[Capped] = None, autoIndexId: Boolean = true, flags: Int = 1) extends CollectionCommand with CommandWithResult[UnitBox.type] with Product with Serializable

    

16. case class CreateIndexes(db: String, indexes: List[Index]) extends CollectionCommand with CommandWithResult[WriteResult] with Product with Serializable

    

    Creates the given indexes on the specified collection.

    Creates the given indexes on the specified collection.

    db

    the database name

    indexes

    the indexes to be created

17. trait CursorFetcher[P <: SerializationPack, +C[_] <: Cursor[_]] extends AnyRef

    

    Fetches a cursor from MongoDB results.

    Fetches a cursor from MongoDB results.

    P

    the type of the serialization pack

    C

    the type of the cursor implementation

18. case class DefaultWriteResult(ok: Boolean, n: Int, writeErrors: Seq[WriteError], writeConcernError: Option[WriteConcernError], code: Option[Int], errmsg: Option[String]) extends WriteResult with Product with Serializable

    

19. trait DeleteCommand[P <: SerializationPack] extends ImplicitCommandHelpers[P]

    

20. trait DistinctCommand[P <: SerializationPack] extends ImplicitCommandHelpers[P]

    

    The distinct command.

21. case class DropCollectionResult(dropped: Boolean) extends Product with Serializable

    
    dropped

    true if the collection existed and was dropped

22. case class DropIndexes(index: String) extends CollectionCommand with CommandWithResult[DropIndexesResult] with Product with Serializable

    

23. case class DropIndexesResult(value: Int) extends BoxedAnyVal[Int] with Product with Serializable

    

24. trait FindAndModifyCommand[P <: SerializationPack] extends ImplicitCommandHelpers[P]

    

25. case class GetLastError(w: W, j: Boolean, fsync: Boolean, wtimeout: Option[Int] = None) extends Command with CommandWithResult[LastError] with Product with Serializable

    
    wtimeout

    the time limit

26. trait ImplicitCommandHelpers[P <: SerializationPack] extends AnyRef

    

27. trait InsertCommand[P <: SerializationPack] extends ImplicitCommandHelpers[P]

    

28. trait IsMasterCommand[P <: SerializationPack] extends AnyRef

    

29. case class LastError(ok: Boolean, errmsg: Option[String], code: Option[Int], lastOp: Option[Long], n: Int, singleShard: Option[String], updatedExisting: Boolean, upserted: Option[BSONValue], wnote: Option[W], wtimeout: Boolean, waited: Option[Int], wtime: Option[Int], writeErrors: Seq[WriteError] = Nil, writeConcernError: Option[WriteConcernError] = None) extends Exception with DatabaseException with WriteResult with NoStackTrace with Product with Serializable

    

30. case class ListIndexes(db: String) extends CollectionCommand with CommandWithResult[List[Index]] with Product with Serializable

    

    Lists the indexes of the specified collection.

    Lists the indexes of the specified collection.

    db

    the database name

31. trait Mongo26WriteCommand extends AnyRef

    

32. case class MultiBulkWriteResult(ok: Boolean, n: Int, nModified: Int, upserted: Seq[Upserted], writeErrors: Seq[WriteError], writeConcernError: Option[WriteConcernError], code: Option[Int], errmsg: Option[String], totalN: Int) extends Product with Serializable

    

33. case class RenameCollection(fullyQualifiedCollectionName: String, fullyQualifiedTargetName: String, dropTarget: Boolean = false) extends Command with CommandWithResult[UnitBox.type] with Product with Serializable

    

34. case class ReplSetMaintenance(enable: Boolean = true) extends Command with CommandWithResult[UnitBox.type] with Product with Serializable

    

    The replSetMaintenance command.

    The replSetMaintenance command. It must be executed against the admin database.

    enable

    if true the the member enters the RECOVERING state

35. case class ReplSetMember(_id: Long, name: String, health: Int, state: Int, stateStr: String, uptime: Long, optime: Long, lastHeartbeat: Long, lastHeartbeatRecv: Long, lastHeartbeatMessage: Option[String], electionTime: Option[Long], self: Boolean, pingMs: Option[Long], syncingTo: Option[String], configVersion: Option[Int]) extends Product with Serializable

    

    Replica set member.

    Replica set member.

    name

    the member name (e.g. "host:port")

    health

    the health indicator for this member

    state

    the state code of the member

    stateStr

    the string representation of the state

    uptime

    the number of seconds that this member has been online

    optime

    information regarding the last operation from the operation log that this member has applied

    lastHeartbeat

    the time of the transmission time of last heartbeat received from this member

    lastHeartbeatRecv

    the time that the last heartbeat was received from this member

    lastHeartbeatMessage

    an optional message from the last heartbeat

    electionTime

    if the member is the primary, the time it was elected as

    self

    indicates which replica set member processed the replSetGetStatus command

    pingMs

    the number of milliseconds (ms) that a round-trip packet takes to travel between the remote member and the local instance (does not appear for the member that returns the rs.status() data)

    syncingTo

    the hostname of the member from which this instance is syncing (only present on the output of rs.status() on secondary and recovering members)

    configVersion

    the configuration version (since MongoDB 3.0)

36. case class ReplSetStatus(name: String, time: Long, myState: Int, members: List[ReplSetMember]) extends Product with Serializable

    

    Result from the replSetGetStatus.

    Result from the replSetGetStatus.

    name

    the name of the replica set

    time

    the current server time

    members

    the list of the members of this replicate set

37. final case class ResolvedCollectionCommand[C <: CollectionCommand](collection: String, command: C) extends Command with Product with Serializable

    
    collection

    the name of the collection against which the command is executed

    command

    the executed command

38. case class ResponseResult[R](response: Response, numberToReturn: Int, value: R) extends Product with Serializable

    
    response

    the response associated with the result

    numberToReturn

    the number of documents to return

    value

    the value parsed from the response

39. case class ResultCursor(cursorId: Long, fullCollectionName: String) extends Product with Serializable

    
    cursorId

    the ID of the cursor

    fullCollectionName

    the namespace of the collection

40. sealed trait ServerProcess extends AnyRef

    

41. case class ServerStatusResult(host: String, version: String, process: ServerProcess, pid: Long, uptime: Long, uptimeMillis: Long, uptimeEstimate: Long, localTime: Long) extends Product with Serializable

    

42. trait UpdateCommand[P <: SerializationPack] extends ImplicitCommandHelpers[P]

    

43. case class UpdateWriteResult(ok: Boolean, n: Int, nModified: Int, upserted: Seq[Upserted], writeErrors: Seq[WriteError], writeConcernError: Option[WriteConcernError], code: Option[Int], errmsg: Option[String]) extends WriteResult with Product with Serializable

    

44. case class Upserted(index: Int, _id: BSONValue) extends Product with Serializable

    

45. type WriteConcern = GetLastError

    

46. case class WriteConcernError(code: Int, errmsg: String) extends Product with Serializable

    
    code

    the error code

    errmsg

    the error message

47. case class WriteError(index: Int, code: Int, errmsg: String) extends Product with Serializable

    
    code

    the error code

    errmsg

    the error message

48. sealed trait WriteResult extends AnyRef