Class

reactivemongo.api.indexes

LegacyIndexesManager

Related Doc: package indexes

Permalink

final class LegacyIndexesManager extends IndexesManager

A helper class to manage the indexes on a Mongo 2.x database.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LegacyIndexesManager
  2. IndexesManager
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LegacyIndexesManager(db: DB)(implicit context: ExecutionContext)

    Permalink

    db

    The subject database.

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LegacyIndexesManager to any2stringadd[LegacyIndexesManager] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (LegacyIndexesManager, B)

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

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

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val collection: BSONCollection

    Permalink
  9. def create(nsIndex: NSIndex): Future[WriteResult]

    Permalink

    Creates the given index.

    Creates the given index.

    Warning: given the options you choose, and the data to index, it can be a long and blocking operation on the database. You should really consider reading http://www.mongodb.org/display/DOCS/Indexes before doing this, especially in production.

    nsIndex

    The index to create.

    Definition Classes
    LegacyIndexesManagerIndexesManager
  10. def drop(collectionName: String, indexName: String): Future[Int]

    Permalink

    Drops the given index on the given collection.

    Drops the given index on the given collection.

    returns

    The number of indexes that were dropped.

    Definition Classes
    LegacyIndexesManagerIndexesManager
  11. def drop(nsIndex: NSIndex): Future[Int]

    Permalink

    Drops the given index on the given collection.

    Drops the given index on the given collection.

    returns

    The number of indexes that were dropped.

    Definition Classes
    IndexesManager
  12. def dropAll(collectionName: String): Future[Int]

    Permalink

    Drops all the indexes on the given collection.

    Drops all the indexes on the given collection.

    Definition Classes
    LegacyIndexesManagerIndexesManager
  13. def ensure(nsIndex: NSIndex): Future[Boolean]

    Permalink

    Creates the given index only if it does not exist on this database.

    Creates the given index only if it does not exist on this database.

    Warning: given the options you choose, and the data to index, it can be a long and blocking operation on the database. You should really consider reading http://www.mongodb.org/display/DOCS/Indexes before doing this, especially in production.

    nsIndex

    The index to create.

    returns

    a future containing true if the index was created, false if it already exists.

    Definition Classes
    LegacyIndexesManagerIndexesManager
  14. def ensuring(cond: (LegacyIndexesManager) ⇒ Boolean, msg: ⇒ Any): LegacyIndexesManager

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. def list(): Future[List[NSIndex]]

    Permalink

    Gets a future list of all the index on this database.

    Gets a future list of all the index on this database.

    Definition Classes
    LegacyIndexesManagerIndexesManager
  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. def onCollection(name: String): CollectionIndexesManager

    Permalink

    Gets a manager for the given collection.

    Gets a manager for the given collection.

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

    Permalink
    Definition Classes
    AnyRef
  31. def toString(): String

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

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

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

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

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

Deprecated Value Members

  1. def delete(collectionName: String, indexName: String): Future[Int]

    Permalink

    Deletes the given index on the given collection.

    Deletes the given index on the given collection.

    returns

    The number of indexes that were dropped.

    Definition Classes
    IndexesManager
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.0) Use drop instead

  2. def delete(nsIndex: NSIndex): Future[Int]

    Permalink

    Deletes the given index on the given collection.

    Deletes the given index on the given collection.

    returns

    The deleted index number.

    Definition Classes
    IndexesManager
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.0) Use drop instead

Inherited from IndexesManager

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped