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
BSONCollection, GenericCollection
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CollectionMetaCommands
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

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

  5. def ->[B](y: B): (CollectionMetaCommands, B)

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

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def convertToCapped(size: Long, maxDocuments: Option[Int])(implicit ec: ExecutionContext): Future[Unit]

    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.

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

    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.

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

    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.

    size

    the byte size of the collections.

    maxDocuments

    the maximum number of documents.

    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.

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

    Drops this collection.

    Drops this collection.

    If the collection existed and is successfully dropped, the returned future will be completed with true.

    If failIfNotFound is false and the collection doesn't exist, the returned future will be completed with false.

    Otherwise in case, the future will be completed with the encountered error.

  14. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. def ensuring(cond: (CollectionMetaCommands) ⇒ Boolean): CollectionMetaCommands

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

  16. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  17. def ensuring(cond: Boolean): CollectionMetaCommands

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

  18. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  19. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  21. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  23. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  24. def indexesManager(implicit ec: ExecutionContext): CollectionIndexesManager

    Returns an index manager for this collection.

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  26. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  27. final def notify(): Unit

    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  29. def rename(to: String, dropExisting: Boolean = false)(implicit ec: ExecutionContext): Future[Unit]

    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.

    returns

    a failure if the dropExisting option is false and the target collection already exists

  30. 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).

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

    Returns various information about this collection.

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

    Definition Classes
    AnyRef

  33. def toString(): String

    Definition Classes
    AnyRef → Any

  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. def →[B](y: B): (CollectionMetaCommands, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (collectionMetaCommands: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (collectionMetaCommands: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def drop()(implicit ec: ExecutionContext): Future[Unit]

    Drops this collection.

    Drops this collection.

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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use drop(Boolean)

  2. def emptyCapped()(implicit ec: ExecutionContext): Future[Unit]

    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.

  3. def x: CollectionMetaCommands

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to ArrowAssoc[CollectionMetaCommands] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (collectionMetaCommands: ArrowAssoc[CollectionMetaCommands]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  4. def x: CollectionMetaCommands

    Implicit information
    This member is added by an implicit conversion from CollectionMetaCommands to Ensuring[CollectionMetaCommands] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (collectionMetaCommands: Ensuring[CollectionMetaCommands]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CollectionMetaCommands to StringAdd

Inherited by implicit conversion any2stringfmt from CollectionMetaCommands to StringFormat

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

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

Ungrouped