reactivemongo.api

CollectionMetaCommands

trait CollectionMetaCommands extends AnyRef

A mixin that provides commands about this Collection itself.

Self Type
CollectionMetaCommands with Collection
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CollectionMetaCommands
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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 information
    This member is added by an implicit conversion from CollectionMetaCommands to any2stringadd[CollectionMetaCommands] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CollectionMetaCommands, B)

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to ArrowAssoc[CollectionMetaCommands] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def convertToCapped(size: Long, maxDocuments: Option[Int])(implicit ec: ExecutionContext): Future[Boolean]

    Converts this collection to a capped one.

    Converts this collection to a capped one.

    size

    The size of this capped collection, in bytes.

    maxDocuments

    The maximum number of documents this capped collection can contain.

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

    Creates this collection.

    Creates this collection.

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

    autoIndexId

    States if should automatically add an index on the _id field. By default, regular collections will have an indexed _id field, in contrast to capped collections.

  10. def createCapped(size: Long, maxDocuments: Option[Int], autoIndexId: Boolean = false)(implicit ec: ExecutionContext): Future[Boolean]

    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.

    autoIndexId

    States if should automatically add an index on the _id field. By default, capped collections will NOT have an indexed _id field, in contrast to regular collections.

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

    Drops this collection.

    Drops this collection.

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

  12. def ensuring(cond: (CollectionMetaCommands) ⇒ Boolean, msg: ⇒ Any): CollectionMetaCommands

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to Ensuring[CollectionMetaCommands] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (CollectionMetaCommands) ⇒ Boolean): CollectionMetaCommands

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to Ensuring[CollectionMetaCommands] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): CollectionMetaCommands

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to Ensuring[CollectionMetaCommands] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): CollectionMetaCommands

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to Ensuring[CollectionMetaCommands] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to StringFormat[CollectionMetaCommands] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. def indexesManager(implicit ec: ExecutionContext): CollectionIndexesManager

    Returns an index manager for this collection.

  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. def rename(to: String, dropExisting: Boolean = false)(implicit ec: ExecutionContext): Future[Boolean]

    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.

  28. def stats(scale: Int)(implicit ec: ExecutionContext): Future[CollStatsResult]

    Returns various information about this collection.

    Returns various information about this collection.

    scale

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

  29. def stats()(implicit ec: ExecutionContext): Future[CollStatsResult]

    Returns various information about this collection.

  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  31. def toString(): String

    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def [B](y: B): (CollectionMetaCommands, B)

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to ArrowAssoc[CollectionMetaCommands] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def emptyCapped()(implicit ec: ExecutionContext): Future[Boolean]

    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.

    Annotations
    @deprecated
    Deprecated

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CollectionMetaCommands to any2stringadd[CollectionMetaCommands]

Inherited by implicit conversion StringFormat from CollectionMetaCommands to StringFormat[CollectionMetaCommands]

Inherited by implicit conversion Ensuring from CollectionMetaCommands to Ensuring[CollectionMetaCommands]

Inherited by implicit conversion ArrowAssoc from CollectionMetaCommands to ArrowAssoc[CollectionMetaCommands]

Ungrouped